An open API service indexing awesome lists of open source software.

https://github.com/devopsarr/lidarr-go

go SDK for Lidarr
https://github.com/devopsarr/lidarr-go

go golang lidarr sdk-go

Last synced: 6 months ago
JSON representation

go SDK for Lidarr

Awesome Lists containing this project

README

          

# Go API client for lidarr

Lidarr API docs

## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.

- API version: v2.9.6.4552
- Package version: 1.2.0
- Generator version: 7.12.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen

## Installation

Install the following dependencies:

```sh
go get github.com/stretchr/testify/assert
go get golang.org/x/net/context
```

Put the package under your project folder and add the following in import:

```go
import lidarr "github.com/devopsarr/lidarr-go/lidarr"
```

To use a proxy, set the environment variable `HTTP_PROXY`:

```go
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
```

## Configuration of Server URL

Default configuration comes with `Servers` field that contains server objects as defined in the OpenAPI specification.

### Select Server Configuration

For using other server than the one defined on index 0 set context value `lidarr.ContextServerIndex` of type `int`.

```go
ctx := context.WithValue(context.Background(), lidarr.ContextServerIndex, 1)
```

### Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value `lidarr.ContextServerVariables` of type `map[string]string`.

```go
ctx := context.WithValue(context.Background(), lidarr.ContextServerVariables, map[string]string{
"basePath": "v2",
})
```

Note, enum values are always validated and all unused variables are silently ignored.

### URLs Configuration per Operation

Each operation can use different server URL defined using `OperationServers` map in the `Configuration`.
An operation is uniquely identified by `"{classname}Service.{nickname}"` string.
Similar rules for overriding default operation server index and variables applies by using `lidarr.ContextOperationServerIndices` and `lidarr.ContextOperationServerVariables` context maps.

```go
ctx := context.WithValue(context.Background(), lidarr.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), lidarr.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})
```

## Documentation for API Endpoints

All URIs are relative to *http://localhost:8686*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AlbumAPI* | [**CreateAlbum**](docs/AlbumAPI.md#createalbum) | **Post** /api/v1/album |
*AlbumAPI* | [**DeleteAlbum**](docs/AlbumAPI.md#deletealbum) | **Delete** /api/v1/album/{id} |
*AlbumAPI* | [**GetAlbumById**](docs/AlbumAPI.md#getalbumbyid) | **Get** /api/v1/album/{id} |
*AlbumAPI* | [**ListAlbum**](docs/AlbumAPI.md#listalbum) | **Get** /api/v1/album |
*AlbumAPI* | [**PutAlbumMonitor**](docs/AlbumAPI.md#putalbummonitor) | **Put** /api/v1/album/monitor |
*AlbumAPI* | [**UpdateAlbum**](docs/AlbumAPI.md#updatealbum) | **Put** /api/v1/album/{id} |
*AlbumLookupAPI* | [**ListAlbumLookup**](docs/AlbumLookupAPI.md#listalbumlookup) | **Get** /api/v1/album/lookup |
*AlbumStudioAPI* | [**CreateAlbumStudio**](docs/AlbumStudioAPI.md#createalbumstudio) | **Post** /api/v1/albumstudio |
*ApiInfoAPI* | [**GetApi**](docs/ApiInfoAPI.md#getapi) | **Get** /api |
*ArtistAPI* | [**CreateArtist**](docs/ArtistAPI.md#createartist) | **Post** /api/v1/artist |
*ArtistAPI* | [**DeleteArtist**](docs/ArtistAPI.md#deleteartist) | **Delete** /api/v1/artist/{id} |
*ArtistAPI* | [**GetArtistById**](docs/ArtistAPI.md#getartistbyid) | **Get** /api/v1/artist/{id} |
*ArtistAPI* | [**ListArtist**](docs/ArtistAPI.md#listartist) | **Get** /api/v1/artist |
*ArtistAPI* | [**UpdateArtist**](docs/ArtistAPI.md#updateartist) | **Put** /api/v1/artist/{id} |
*ArtistEditorAPI* | [**DeleteArtistEditor**](docs/ArtistEditorAPI.md#deleteartisteditor) | **Delete** /api/v1/artist/editor |
*ArtistEditorAPI* | [**PutArtistEditor**](docs/ArtistEditorAPI.md#putartisteditor) | **Put** /api/v1/artist/editor |
*ArtistLookupAPI* | [**ListArtistLookup**](docs/ArtistLookupAPI.md#listartistlookup) | **Get** /api/v1/artist/lookup |
*AuthenticationAPI* | [**CreateLogin**](docs/AuthenticationAPI.md#createlogin) | **Post** /login |
*AuthenticationAPI* | [**GetLogout**](docs/AuthenticationAPI.md#getlogout) | **Get** /logout |
*AutoTaggingAPI* | [**CreateAutoTagging**](docs/AutoTaggingAPI.md#createautotagging) | **Post** /api/v1/autotagging |
*AutoTaggingAPI* | [**DeleteAutoTagging**](docs/AutoTaggingAPI.md#deleteautotagging) | **Delete** /api/v1/autotagging/{id} |
*AutoTaggingAPI* | [**GetAutoTaggingById**](docs/AutoTaggingAPI.md#getautotaggingbyid) | **Get** /api/v1/autotagging/{id} |
*AutoTaggingAPI* | [**ListAutoTagging**](docs/AutoTaggingAPI.md#listautotagging) | **Get** /api/v1/autotagging |
*AutoTaggingAPI* | [**ListAutoTaggingSchema**](docs/AutoTaggingAPI.md#listautotaggingschema) | **Get** /api/v1/autotagging/schema |
*AutoTaggingAPI* | [**UpdateAutoTagging**](docs/AutoTaggingAPI.md#updateautotagging) | **Put** /api/v1/autotagging/{id} |
*BackupAPI* | [**CreateSystemBackupRestoreById**](docs/BackupAPI.md#createsystembackuprestorebyid) | **Post** /api/v1/system/backup/restore/{id} |
*BackupAPI* | [**CreateSystemBackupRestoreUpload**](docs/BackupAPI.md#createsystembackuprestoreupload) | **Post** /api/v1/system/backup/restore/upload |
*BackupAPI* | [**DeleteSystemBackup**](docs/BackupAPI.md#deletesystembackup) | **Delete** /api/v1/system/backup/{id} |
*BackupAPI* | [**ListSystemBackup**](docs/BackupAPI.md#listsystembackup) | **Get** /api/v1/system/backup |
*BlocklistAPI* | [**DeleteBlocklist**](docs/BlocklistAPI.md#deleteblocklist) | **Delete** /api/v1/blocklist/{id} |
*BlocklistAPI* | [**DeleteBlocklistBulk**](docs/BlocklistAPI.md#deleteblocklistbulk) | **Delete** /api/v1/blocklist/bulk |
*BlocklistAPI* | [**GetBlocklist**](docs/BlocklistAPI.md#getblocklist) | **Get** /api/v1/blocklist |
*CalendarAPI* | [**GetCalendarById**](docs/CalendarAPI.md#getcalendarbyid) | **Get** /api/v1/calendar/{id} |
*CalendarAPI* | [**ListCalendar**](docs/CalendarAPI.md#listcalendar) | **Get** /api/v1/calendar |
*CalendarFeedAPI* | [**GetFeedV1CalendarLidarrIcs**](docs/CalendarFeedAPI.md#getfeedv1calendarlidarrics) | **Get** /feed/v1/calendar/lidarr.ics |
*CommandAPI* | [**CreateCommand**](docs/CommandAPI.md#createcommand) | **Post** /api/v1/command |
*CommandAPI* | [**DeleteCommand**](docs/CommandAPI.md#deletecommand) | **Delete** /api/v1/command/{id} |
*CommandAPI* | [**GetCommandById**](docs/CommandAPI.md#getcommandbyid) | **Get** /api/v1/command/{id} |
*CommandAPI* | [**ListCommand**](docs/CommandAPI.md#listcommand) | **Get** /api/v1/command |
*CustomFilterAPI* | [**CreateCustomFilter**](docs/CustomFilterAPI.md#createcustomfilter) | **Post** /api/v1/customfilter |
*CustomFilterAPI* | [**DeleteCustomFilter**](docs/CustomFilterAPI.md#deletecustomfilter) | **Delete** /api/v1/customfilter/{id} |
*CustomFilterAPI* | [**GetCustomFilterById**](docs/CustomFilterAPI.md#getcustomfilterbyid) | **Get** /api/v1/customfilter/{id} |
*CustomFilterAPI* | [**ListCustomFilter**](docs/CustomFilterAPI.md#listcustomfilter) | **Get** /api/v1/customfilter |
*CustomFilterAPI* | [**UpdateCustomFilter**](docs/CustomFilterAPI.md#updatecustomfilter) | **Put** /api/v1/customfilter/{id} |
*CustomFormatAPI* | [**CreateCustomFormat**](docs/CustomFormatAPI.md#createcustomformat) | **Post** /api/v1/customformat |
*CustomFormatAPI* | [**DeleteCustomFormat**](docs/CustomFormatAPI.md#deletecustomformat) | **Delete** /api/v1/customformat/{id} |
*CustomFormatAPI* | [**DeleteCustomFormatBulk**](docs/CustomFormatAPI.md#deletecustomformatbulk) | **Delete** /api/v1/customformat/bulk |
*CustomFormatAPI* | [**GetCustomFormatById**](docs/CustomFormatAPI.md#getcustomformatbyid) | **Get** /api/v1/customformat/{id} |
*CustomFormatAPI* | [**ListCustomFormat**](docs/CustomFormatAPI.md#listcustomformat) | **Get** /api/v1/customformat |
*CustomFormatAPI* | [**ListCustomFormatSchema**](docs/CustomFormatAPI.md#listcustomformatschema) | **Get** /api/v1/customformat/schema |
*CustomFormatAPI* | [**PutCustomFormatBulk**](docs/CustomFormatAPI.md#putcustomformatbulk) | **Put** /api/v1/customformat/bulk |
*CustomFormatAPI* | [**UpdateCustomFormat**](docs/CustomFormatAPI.md#updatecustomformat) | **Put** /api/v1/customformat/{id} |
*CutoffAPI* | [**GetWantedCutoff**](docs/CutoffAPI.md#getwantedcutoff) | **Get** /api/v1/wanted/cutoff |
*CutoffAPI* | [**GetWantedCutoffById**](docs/CutoffAPI.md#getwantedcutoffbyid) | **Get** /api/v1/wanted/cutoff/{id} |
*DelayProfileAPI* | [**CreateDelayProfile**](docs/DelayProfileAPI.md#createdelayprofile) | **Post** /api/v1/delayprofile |
*DelayProfileAPI* | [**DeleteDelayProfile**](docs/DelayProfileAPI.md#deletedelayprofile) | **Delete** /api/v1/delayprofile/{id} |
*DelayProfileAPI* | [**GetDelayProfileById**](docs/DelayProfileAPI.md#getdelayprofilebyid) | **Get** /api/v1/delayprofile/{id} |
*DelayProfileAPI* | [**ListDelayProfile**](docs/DelayProfileAPI.md#listdelayprofile) | **Get** /api/v1/delayprofile |
*DelayProfileAPI* | [**UpdateDelayProfile**](docs/DelayProfileAPI.md#updatedelayprofile) | **Put** /api/v1/delayprofile/{id} |
*DelayProfileAPI* | [**UpdateDelayProfileReorder**](docs/DelayProfileAPI.md#updatedelayprofilereorder) | **Put** /api/v1/delayprofile/reorder/{id} |
*DiskSpaceAPI* | [**ListDiskSpace**](docs/DiskSpaceAPI.md#listdiskspace) | **Get** /api/v1/diskspace |
*DownloadClientAPI* | [**CreateDownloadClient**](docs/DownloadClientAPI.md#createdownloadclient) | **Post** /api/v1/downloadclient |
*DownloadClientAPI* | [**CreateDownloadClientActionByName**](docs/DownloadClientAPI.md#createdownloadclientactionbyname) | **Post** /api/v1/downloadclient/action/{name} |
*DownloadClientAPI* | [**DeleteDownloadClient**](docs/DownloadClientAPI.md#deletedownloadclient) | **Delete** /api/v1/downloadclient/{id} |
*DownloadClientAPI* | [**DeleteDownloadClientBulk**](docs/DownloadClientAPI.md#deletedownloadclientbulk) | **Delete** /api/v1/downloadclient/bulk |
*DownloadClientAPI* | [**GetDownloadClientById**](docs/DownloadClientAPI.md#getdownloadclientbyid) | **Get** /api/v1/downloadclient/{id} |
*DownloadClientAPI* | [**ListDownloadClient**](docs/DownloadClientAPI.md#listdownloadclient) | **Get** /api/v1/downloadclient |
*DownloadClientAPI* | [**ListDownloadClientSchema**](docs/DownloadClientAPI.md#listdownloadclientschema) | **Get** /api/v1/downloadclient/schema |
*DownloadClientAPI* | [**PutDownloadClientBulk**](docs/DownloadClientAPI.md#putdownloadclientbulk) | **Put** /api/v1/downloadclient/bulk |
*DownloadClientAPI* | [**TestDownloadClient**](docs/DownloadClientAPI.md#testdownloadclient) | **Post** /api/v1/downloadclient/test |
*DownloadClientAPI* | [**TestallDownloadClient**](docs/DownloadClientAPI.md#testalldownloadclient) | **Post** /api/v1/downloadclient/testall |
*DownloadClientAPI* | [**UpdateDownloadClient**](docs/DownloadClientAPI.md#updatedownloadclient) | **Put** /api/v1/downloadclient/{id} |
*DownloadClientConfigAPI* | [**GetDownloadClientConfig**](docs/DownloadClientConfigAPI.md#getdownloadclientconfig) | **Get** /api/v1/config/downloadclient |
*DownloadClientConfigAPI* | [**GetDownloadClientConfigById**](docs/DownloadClientConfigAPI.md#getdownloadclientconfigbyid) | **Get** /api/v1/config/downloadclient/{id} |
*DownloadClientConfigAPI* | [**UpdateDownloadClientConfig**](docs/DownloadClientConfigAPI.md#updatedownloadclientconfig) | **Put** /api/v1/config/downloadclient/{id} |
*FileSystemAPI* | [**GetFileSystem**](docs/FileSystemAPI.md#getfilesystem) | **Get** /api/v1/filesystem |
*FileSystemAPI* | [**GetFileSystemMediafiles**](docs/FileSystemAPI.md#getfilesystemmediafiles) | **Get** /api/v1/filesystem/mediafiles |
*FileSystemAPI* | [**GetFileSystemType**](docs/FileSystemAPI.md#getfilesystemtype) | **Get** /api/v1/filesystem/type |
*HealthAPI* | [**ListHealth**](docs/HealthAPI.md#listhealth) | **Get** /api/v1/health |
*HistoryAPI* | [**CreateHistoryFailedById**](docs/HistoryAPI.md#createhistoryfailedbyid) | **Post** /api/v1/history/failed/{id} |
*HistoryAPI* | [**GetHistory**](docs/HistoryAPI.md#gethistory) | **Get** /api/v1/history |
*HistoryAPI* | [**ListHistoryArtist**](docs/HistoryAPI.md#listhistoryartist) | **Get** /api/v1/history/artist |
*HistoryAPI* | [**ListHistorySince**](docs/HistoryAPI.md#listhistorysince) | **Get** /api/v1/history/since |
*HostConfigAPI* | [**GetHostConfig**](docs/HostConfigAPI.md#gethostconfig) | **Get** /api/v1/config/host |
*HostConfigAPI* | [**GetHostConfigById**](docs/HostConfigAPI.md#gethostconfigbyid) | **Get** /api/v1/config/host/{id} |
*HostConfigAPI* | [**UpdateHostConfig**](docs/HostConfigAPI.md#updatehostconfig) | **Put** /api/v1/config/host/{id} |
*ImportListAPI* | [**CreateImportList**](docs/ImportListAPI.md#createimportlist) | **Post** /api/v1/importlist |
*ImportListAPI* | [**CreateImportListActionByName**](docs/ImportListAPI.md#createimportlistactionbyname) | **Post** /api/v1/importlist/action/{name} |
*ImportListAPI* | [**DeleteImportList**](docs/ImportListAPI.md#deleteimportlist) | **Delete** /api/v1/importlist/{id} |
*ImportListAPI* | [**DeleteImportListBulk**](docs/ImportListAPI.md#deleteimportlistbulk) | **Delete** /api/v1/importlist/bulk |
*ImportListAPI* | [**GetImportListById**](docs/ImportListAPI.md#getimportlistbyid) | **Get** /api/v1/importlist/{id} |
*ImportListAPI* | [**ListImportList**](docs/ImportListAPI.md#listimportlist) | **Get** /api/v1/importlist |
*ImportListAPI* | [**ListImportListSchema**](docs/ImportListAPI.md#listimportlistschema) | **Get** /api/v1/importlist/schema |
*ImportListAPI* | [**PutImportListBulk**](docs/ImportListAPI.md#putimportlistbulk) | **Put** /api/v1/importlist/bulk |
*ImportListAPI* | [**TestImportList**](docs/ImportListAPI.md#testimportlist) | **Post** /api/v1/importlist/test |
*ImportListAPI* | [**TestallImportList**](docs/ImportListAPI.md#testallimportlist) | **Post** /api/v1/importlist/testall |
*ImportListAPI* | [**UpdateImportList**](docs/ImportListAPI.md#updateimportlist) | **Put** /api/v1/importlist/{id} |
*ImportListExclusionAPI* | [**CreateImportListExclusion**](docs/ImportListExclusionAPI.md#createimportlistexclusion) | **Post** /api/v1/importlistexclusion |
*ImportListExclusionAPI* | [**DeleteImportListExclusion**](docs/ImportListExclusionAPI.md#deleteimportlistexclusion) | **Delete** /api/v1/importlistexclusion/{id} |
*ImportListExclusionAPI* | [**GetImportListExclusionById**](docs/ImportListExclusionAPI.md#getimportlistexclusionbyid) | **Get** /api/v1/importlistexclusion/{id} |
*ImportListExclusionAPI* | [**ListImportListExclusion**](docs/ImportListExclusionAPI.md#listimportlistexclusion) | **Get** /api/v1/importlistexclusion |
*ImportListExclusionAPI* | [**UpdateImportListExclusion**](docs/ImportListExclusionAPI.md#updateimportlistexclusion) | **Put** /api/v1/importlistexclusion/{id} |
*IndexerAPI* | [**CreateIndexer**](docs/IndexerAPI.md#createindexer) | **Post** /api/v1/indexer |
*IndexerAPI* | [**CreateIndexerActionByName**](docs/IndexerAPI.md#createindexeractionbyname) | **Post** /api/v1/indexer/action/{name} |
*IndexerAPI* | [**DeleteIndexer**](docs/IndexerAPI.md#deleteindexer) | **Delete** /api/v1/indexer/{id} |
*IndexerAPI* | [**DeleteIndexerBulk**](docs/IndexerAPI.md#deleteindexerbulk) | **Delete** /api/v1/indexer/bulk |
*IndexerAPI* | [**GetIndexerById**](docs/IndexerAPI.md#getindexerbyid) | **Get** /api/v1/indexer/{id} |
*IndexerAPI* | [**ListIndexer**](docs/IndexerAPI.md#listindexer) | **Get** /api/v1/indexer |
*IndexerAPI* | [**ListIndexerSchema**](docs/IndexerAPI.md#listindexerschema) | **Get** /api/v1/indexer/schema |
*IndexerAPI* | [**PutIndexerBulk**](docs/IndexerAPI.md#putindexerbulk) | **Put** /api/v1/indexer/bulk |
*IndexerAPI* | [**TestIndexer**](docs/IndexerAPI.md#testindexer) | **Post** /api/v1/indexer/test |
*IndexerAPI* | [**TestallIndexer**](docs/IndexerAPI.md#testallindexer) | **Post** /api/v1/indexer/testall |
*IndexerAPI* | [**UpdateIndexer**](docs/IndexerAPI.md#updateindexer) | **Put** /api/v1/indexer/{id} |
*IndexerConfigAPI* | [**GetIndexerConfig**](docs/IndexerConfigAPI.md#getindexerconfig) | **Get** /api/v1/config/indexer |
*IndexerConfigAPI* | [**GetIndexerConfigById**](docs/IndexerConfigAPI.md#getindexerconfigbyid) | **Get** /api/v1/config/indexer/{id} |
*IndexerConfigAPI* | [**UpdateIndexerConfig**](docs/IndexerConfigAPI.md#updateindexerconfig) | **Put** /api/v1/config/indexer/{id} |
*IndexerFlagAPI* | [**ListIndexerFlag**](docs/IndexerFlagAPI.md#listindexerflag) | **Get** /api/v1/indexerflag |
*LanguageAPI* | [**GetLanguageById**](docs/LanguageAPI.md#getlanguagebyid) | **Get** /api/v1/language/{id} |
*LanguageAPI* | [**ListLanguage**](docs/LanguageAPI.md#listlanguage) | **Get** /api/v1/language |
*LocalizationAPI* | [**GetLocalization**](docs/LocalizationAPI.md#getlocalization) | **Get** /api/v1/localization |
*LogAPI* | [**GetLog**](docs/LogAPI.md#getlog) | **Get** /api/v1/log |
*LogFileAPI* | [**GetLogFileByFilename**](docs/LogFileAPI.md#getlogfilebyfilename) | **Get** /api/v1/log/file/{filename} |
*LogFileAPI* | [**ListLogFile**](docs/LogFileAPI.md#listlogfile) | **Get** /api/v1/log/file |
*ManualImportAPI* | [**CreateManualImport**](docs/ManualImportAPI.md#createmanualimport) | **Post** /api/v1/manualimport |
*ManualImportAPI* | [**ListManualImport**](docs/ManualImportAPI.md#listmanualimport) | **Get** /api/v1/manualimport |
*MediaCoverAPI* | [**GetMediaCoverAlbumByFilename**](docs/MediaCoverAPI.md#getmediacoveralbumbyfilename) | **Get** /api/v1/mediacover/album/{albumId}/{filename} |
*MediaCoverAPI* | [**GetMediaCoverArtistByFilename**](docs/MediaCoverAPI.md#getmediacoverartistbyfilename) | **Get** /api/v1/mediacover/artist/{artistId}/{filename} |
*MediaManagementConfigAPI* | [**GetMediaManagementConfig**](docs/MediaManagementConfigAPI.md#getmediamanagementconfig) | **Get** /api/v1/config/mediamanagement |
*MediaManagementConfigAPI* | [**GetMediaManagementConfigById**](docs/MediaManagementConfigAPI.md#getmediamanagementconfigbyid) | **Get** /api/v1/config/mediamanagement/{id} |
*MediaManagementConfigAPI* | [**UpdateMediaManagementConfig**](docs/MediaManagementConfigAPI.md#updatemediamanagementconfig) | **Put** /api/v1/config/mediamanagement/{id} |
*MetadataAPI* | [**CreateMetadata**](docs/MetadataAPI.md#createmetadata) | **Post** /api/v1/metadata |
*MetadataAPI* | [**CreateMetadataActionByName**](docs/MetadataAPI.md#createmetadataactionbyname) | **Post** /api/v1/metadata/action/{name} |
*MetadataAPI* | [**DeleteMetadata**](docs/MetadataAPI.md#deletemetadata) | **Delete** /api/v1/metadata/{id} |
*MetadataAPI* | [**GetMetadataById**](docs/MetadataAPI.md#getmetadatabyid) | **Get** /api/v1/metadata/{id} |
*MetadataAPI* | [**ListMetadata**](docs/MetadataAPI.md#listmetadata) | **Get** /api/v1/metadata |
*MetadataAPI* | [**ListMetadataSchema**](docs/MetadataAPI.md#listmetadataschema) | **Get** /api/v1/metadata/schema |
*MetadataAPI* | [**TestMetadata**](docs/MetadataAPI.md#testmetadata) | **Post** /api/v1/metadata/test |
*MetadataAPI* | [**TestallMetadata**](docs/MetadataAPI.md#testallmetadata) | **Post** /api/v1/metadata/testall |
*MetadataAPI* | [**UpdateMetadata**](docs/MetadataAPI.md#updatemetadata) | **Put** /api/v1/metadata/{id} |
*MetadataProfileAPI* | [**CreateMetadataProfile**](docs/MetadataProfileAPI.md#createmetadataprofile) | **Post** /api/v1/metadataprofile |
*MetadataProfileAPI* | [**DeleteMetadataProfile**](docs/MetadataProfileAPI.md#deletemetadataprofile) | **Delete** /api/v1/metadataprofile/{id} |
*MetadataProfileAPI* | [**GetMetadataProfileById**](docs/MetadataProfileAPI.md#getmetadataprofilebyid) | **Get** /api/v1/metadataprofile/{id} |
*MetadataProfileAPI* | [**ListMetadataProfile**](docs/MetadataProfileAPI.md#listmetadataprofile) | **Get** /api/v1/metadataprofile |
*MetadataProfileAPI* | [**UpdateMetadataProfile**](docs/MetadataProfileAPI.md#updatemetadataprofile) | **Put** /api/v1/metadataprofile/{id} |
*MetadataProfileSchemaAPI* | [**GetMetadataprofileSchema**](docs/MetadataProfileSchemaAPI.md#getmetadataprofileschema) | **Get** /api/v1/metadataprofile/schema |
*MetadataProviderConfigAPI* | [**GetMetadataProviderConfig**](docs/MetadataProviderConfigAPI.md#getmetadataproviderconfig) | **Get** /api/v1/config/metadataprovider |
*MetadataProviderConfigAPI* | [**GetMetadataProviderConfigById**](docs/MetadataProviderConfigAPI.md#getmetadataproviderconfigbyid) | **Get** /api/v1/config/metadataprovider/{id} |
*MetadataProviderConfigAPI* | [**UpdateMetadataProviderConfig**](docs/MetadataProviderConfigAPI.md#updatemetadataproviderconfig) | **Put** /api/v1/config/metadataprovider/{id} |
*MissingAPI* | [**GetWantedMissing**](docs/MissingAPI.md#getwantedmissing) | **Get** /api/v1/wanted/missing |
*MissingAPI* | [**GetWantedMissingById**](docs/MissingAPI.md#getwantedmissingbyid) | **Get** /api/v1/wanted/missing/{id} |
*NamingConfigAPI* | [**GetNamingConfig**](docs/NamingConfigAPI.md#getnamingconfig) | **Get** /api/v1/config/naming |
*NamingConfigAPI* | [**GetNamingConfigById**](docs/NamingConfigAPI.md#getnamingconfigbyid) | **Get** /api/v1/config/naming/{id} |
*NamingConfigAPI* | [**GetNamingConfigExamples**](docs/NamingConfigAPI.md#getnamingconfigexamples) | **Get** /api/v1/config/naming/examples |
*NamingConfigAPI* | [**UpdateNamingConfig**](docs/NamingConfigAPI.md#updatenamingconfig) | **Put** /api/v1/config/naming/{id} |
*NotificationAPI* | [**CreateNotification**](docs/NotificationAPI.md#createnotification) | **Post** /api/v1/notification |
*NotificationAPI* | [**CreateNotificationActionByName**](docs/NotificationAPI.md#createnotificationactionbyname) | **Post** /api/v1/notification/action/{name} |
*NotificationAPI* | [**DeleteNotification**](docs/NotificationAPI.md#deletenotification) | **Delete** /api/v1/notification/{id} |
*NotificationAPI* | [**GetNotificationById**](docs/NotificationAPI.md#getnotificationbyid) | **Get** /api/v1/notification/{id} |
*NotificationAPI* | [**ListNotification**](docs/NotificationAPI.md#listnotification) | **Get** /api/v1/notification |
*NotificationAPI* | [**ListNotificationSchema**](docs/NotificationAPI.md#listnotificationschema) | **Get** /api/v1/notification/schema |
*NotificationAPI* | [**TestNotification**](docs/NotificationAPI.md#testnotification) | **Post** /api/v1/notification/test |
*NotificationAPI* | [**TestallNotification**](docs/NotificationAPI.md#testallnotification) | **Post** /api/v1/notification/testall |
*NotificationAPI* | [**UpdateNotification**](docs/NotificationAPI.md#updatenotification) | **Put** /api/v1/notification/{id} |
*ParseAPI* | [**GetParse**](docs/ParseAPI.md#getparse) | **Get** /api/v1/parse |
*PingAPI* | [**GetPing**](docs/PingAPI.md#getping) | **Get** /ping |
*PingAPI* | [**HeadPing**](docs/PingAPI.md#headping) | **Head** /ping |
*QualityDefinitionAPI* | [**GetQualityDefinitionById**](docs/QualityDefinitionAPI.md#getqualitydefinitionbyid) | **Get** /api/v1/qualitydefinition/{id} |
*QualityDefinitionAPI* | [**ListQualityDefinition**](docs/QualityDefinitionAPI.md#listqualitydefinition) | **Get** /api/v1/qualitydefinition |
*QualityDefinitionAPI* | [**PutQualityDefinitionUpdate**](docs/QualityDefinitionAPI.md#putqualitydefinitionupdate) | **Put** /api/v1/qualitydefinition/update |
*QualityDefinitionAPI* | [**UpdateQualityDefinition**](docs/QualityDefinitionAPI.md#updatequalitydefinition) | **Put** /api/v1/qualitydefinition/{id} |
*QualityProfileAPI* | [**CreateQualityProfile**](docs/QualityProfileAPI.md#createqualityprofile) | **Post** /api/v1/qualityprofile |
*QualityProfileAPI* | [**DeleteQualityProfile**](docs/QualityProfileAPI.md#deletequalityprofile) | **Delete** /api/v1/qualityprofile/{id} |
*QualityProfileAPI* | [**GetQualityProfileById**](docs/QualityProfileAPI.md#getqualityprofilebyid) | **Get** /api/v1/qualityprofile/{id} |
*QualityProfileAPI* | [**ListQualityProfile**](docs/QualityProfileAPI.md#listqualityprofile) | **Get** /api/v1/qualityprofile |
*QualityProfileAPI* | [**UpdateQualityProfile**](docs/QualityProfileAPI.md#updatequalityprofile) | **Put** /api/v1/qualityprofile/{id} |
*QualityProfileSchemaAPI* | [**GetQualityprofileSchema**](docs/QualityProfileSchemaAPI.md#getqualityprofileschema) | **Get** /api/v1/qualityprofile/schema |
*QueueAPI* | [**DeleteQueue**](docs/QueueAPI.md#deletequeue) | **Delete** /api/v1/queue/{id} |
*QueueAPI* | [**DeleteQueueBulk**](docs/QueueAPI.md#deletequeuebulk) | **Delete** /api/v1/queue/bulk |
*QueueAPI* | [**GetQueue**](docs/QueueAPI.md#getqueue) | **Get** /api/v1/queue |
*QueueActionAPI* | [**CreateQueueGrabBulk**](docs/QueueActionAPI.md#createqueuegrabbulk) | **Post** /api/v1/queue/grab/bulk |
*QueueActionAPI* | [**CreateQueueGrabById**](docs/QueueActionAPI.md#createqueuegrabbyid) | **Post** /api/v1/queue/grab/{id} |
*QueueDetailsAPI* | [**ListQueueDetails**](docs/QueueDetailsAPI.md#listqueuedetails) | **Get** /api/v1/queue/details |
*QueueStatusAPI* | [**GetQueueStatus**](docs/QueueStatusAPI.md#getqueuestatus) | **Get** /api/v1/queue/status |
*ReleaseAPI* | [**CreateRelease**](docs/ReleaseAPI.md#createrelease) | **Post** /api/v1/release |
*ReleaseAPI* | [**ListRelease**](docs/ReleaseAPI.md#listrelease) | **Get** /api/v1/release |
*ReleaseProfileAPI* | [**CreateReleaseProfile**](docs/ReleaseProfileAPI.md#createreleaseprofile) | **Post** /api/v1/releaseprofile |
*ReleaseProfileAPI* | [**DeleteReleaseProfile**](docs/ReleaseProfileAPI.md#deletereleaseprofile) | **Delete** /api/v1/releaseprofile/{id} |
*ReleaseProfileAPI* | [**GetReleaseProfileById**](docs/ReleaseProfileAPI.md#getreleaseprofilebyid) | **Get** /api/v1/releaseprofile/{id} |
*ReleaseProfileAPI* | [**ListReleaseProfile**](docs/ReleaseProfileAPI.md#listreleaseprofile) | **Get** /api/v1/releaseprofile |
*ReleaseProfileAPI* | [**UpdateReleaseProfile**](docs/ReleaseProfileAPI.md#updatereleaseprofile) | **Put** /api/v1/releaseprofile/{id} |
*ReleasePushAPI* | [**CreateReleasePush**](docs/ReleasePushAPI.md#createreleasepush) | **Post** /api/v1/release/push |
*RemotePathMappingAPI* | [**CreateRemotePathMapping**](docs/RemotePathMappingAPI.md#createremotepathmapping) | **Post** /api/v1/remotepathmapping |
*RemotePathMappingAPI* | [**DeleteRemotePathMapping**](docs/RemotePathMappingAPI.md#deleteremotepathmapping) | **Delete** /api/v1/remotepathmapping/{id} |
*RemotePathMappingAPI* | [**GetRemotePathMappingById**](docs/RemotePathMappingAPI.md#getremotepathmappingbyid) | **Get** /api/v1/remotepathmapping/{id} |
*RemotePathMappingAPI* | [**ListRemotePathMapping**](docs/RemotePathMappingAPI.md#listremotepathmapping) | **Get** /api/v1/remotepathmapping |
*RemotePathMappingAPI* | [**UpdateRemotePathMapping**](docs/RemotePathMappingAPI.md#updateremotepathmapping) | **Put** /api/v1/remotepathmapping/{id} |
*RenameTrackAPI* | [**ListRename**](docs/RenameTrackAPI.md#listrename) | **Get** /api/v1/rename |
*RetagTrackAPI* | [**ListRetag**](docs/RetagTrackAPI.md#listretag) | **Get** /api/v1/retag |
*RootFolderAPI* | [**CreateRootFolder**](docs/RootFolderAPI.md#createrootfolder) | **Post** /api/v1/rootfolder |
*RootFolderAPI* | [**DeleteRootFolder**](docs/RootFolderAPI.md#deleterootfolder) | **Delete** /api/v1/rootfolder/{id} |
*RootFolderAPI* | [**GetRootFolderById**](docs/RootFolderAPI.md#getrootfolderbyid) | **Get** /api/v1/rootfolder/{id} |
*RootFolderAPI* | [**ListRootFolder**](docs/RootFolderAPI.md#listrootfolder) | **Get** /api/v1/rootfolder |
*RootFolderAPI* | [**UpdateRootFolder**](docs/RootFolderAPI.md#updaterootfolder) | **Put** /api/v1/rootfolder/{id} |
*SearchAPI* | [**ListSearch**](docs/SearchAPI.md#listsearch) | **Get** /api/v1/search |
*StaticResourceAPI* | [**GetByPath**](docs/StaticResourceAPI.md#getbypath) | **Get** /{path} |
*StaticResourceAPI* | [**GetContentByPath**](docs/StaticResourceAPI.md#getcontentbypath) | **Get** /content/{path} |
*StaticResourceAPI* | [**GetLogin**](docs/StaticResourceAPI.md#getlogin) | **Get** /login |
*SystemAPI* | [**CreateSystemRestart**](docs/SystemAPI.md#createsystemrestart) | **Post** /api/v1/system/restart |
*SystemAPI* | [**CreateSystemShutdown**](docs/SystemAPI.md#createsystemshutdown) | **Post** /api/v1/system/shutdown |
*SystemAPI* | [**GetSystemRoutes**](docs/SystemAPI.md#getsystemroutes) | **Get** /api/v1/system/routes |
*SystemAPI* | [**GetSystemRoutesDuplicate**](docs/SystemAPI.md#getsystemroutesduplicate) | **Get** /api/v1/system/routes/duplicate |
*SystemAPI* | [**GetSystemStatus**](docs/SystemAPI.md#getsystemstatus) | **Get** /api/v1/system/status |
*TagAPI* | [**CreateTag**](docs/TagAPI.md#createtag) | **Post** /api/v1/tag |
*TagAPI* | [**DeleteTag**](docs/TagAPI.md#deletetag) | **Delete** /api/v1/tag/{id} |
*TagAPI* | [**GetTagById**](docs/TagAPI.md#gettagbyid) | **Get** /api/v1/tag/{id} |
*TagAPI* | [**ListTag**](docs/TagAPI.md#listtag) | **Get** /api/v1/tag |
*TagAPI* | [**UpdateTag**](docs/TagAPI.md#updatetag) | **Put** /api/v1/tag/{id} |
*TagDetailsAPI* | [**GetTagDetailById**](docs/TagDetailsAPI.md#gettagdetailbyid) | **Get** /api/v1/tag/detail/{id} |
*TagDetailsAPI* | [**ListTagDetail**](docs/TagDetailsAPI.md#listtagdetail) | **Get** /api/v1/tag/detail |
*TaskAPI* | [**GetSystemTaskById**](docs/TaskAPI.md#getsystemtaskbyid) | **Get** /api/v1/system/task/{id} |
*TaskAPI* | [**ListSystemTask**](docs/TaskAPI.md#listsystemtask) | **Get** /api/v1/system/task |
*TrackAPI* | [**GetTrackById**](docs/TrackAPI.md#gettrackbyid) | **Get** /api/v1/track/{id} |
*TrackAPI* | [**ListTrack**](docs/TrackAPI.md#listtrack) | **Get** /api/v1/track |
*TrackFileAPI* | [**DeleteTrackFile**](docs/TrackFileAPI.md#deletetrackfile) | **Delete** /api/v1/trackfile/{id} |
*TrackFileAPI* | [**DeleteTrackFileBulk**](docs/TrackFileAPI.md#deletetrackfilebulk) | **Delete** /api/v1/trackfile/bulk |
*TrackFileAPI* | [**GetTrackFileById**](docs/TrackFileAPI.md#gettrackfilebyid) | **Get** /api/v1/trackfile/{id} |
*TrackFileAPI* | [**ListTrackFile**](docs/TrackFileAPI.md#listtrackfile) | **Get** /api/v1/trackfile |
*TrackFileAPI* | [**PutTrackFileEditor**](docs/TrackFileAPI.md#puttrackfileeditor) | **Put** /api/v1/trackfile/editor |
*TrackFileAPI* | [**UpdateTrackFile**](docs/TrackFileAPI.md#updatetrackfile) | **Put** /api/v1/trackfile/{id} |
*UiConfigAPI* | [**GetUiConfig**](docs/UiConfigAPI.md#getuiconfig) | **Get** /api/v1/config/ui |
*UiConfigAPI* | [**GetUiConfigById**](docs/UiConfigAPI.md#getuiconfigbyid) | **Get** /api/v1/config/ui/{id} |
*UiConfigAPI* | [**UpdateUiConfig**](docs/UiConfigAPI.md#updateuiconfig) | **Put** /api/v1/config/ui/{id} |
*UpdateAPI* | [**ListUpdate**](docs/UpdateAPI.md#listupdate) | **Get** /api/v1/update |
*UpdateLogFileAPI* | [**GetLogFileUpdateByFilename**](docs/UpdateLogFileAPI.md#getlogfileupdatebyfilename) | **Get** /api/v1/log/file/update/{filename} |
*UpdateLogFileAPI* | [**ListLogFileUpdate**](docs/UpdateLogFileAPI.md#listlogfileupdate) | **Get** /api/v1/log/file/update |

## Documentation For Models

- [AddAlbumOptions](docs/AddAlbumOptions.md)
- [AddArtistOptions](docs/AddArtistOptions.md)
- [AlbumAddType](docs/AlbumAddType.md)
- [AlbumReleaseResource](docs/AlbumReleaseResource.md)
- [AlbumResource](docs/AlbumResource.md)
- [AlbumResourcePagingResource](docs/AlbumResourcePagingResource.md)
- [AlbumStatisticsResource](docs/AlbumStatisticsResource.md)
- [AlbumStudioArtistResource](docs/AlbumStudioArtistResource.md)
- [AlbumStudioResource](docs/AlbumStudioResource.md)
- [AlbumsMonitoredResource](docs/AlbumsMonitoredResource.md)
- [AllowFingerprinting](docs/AllowFingerprinting.md)
- [ApplyTags](docs/ApplyTags.md)
- [ArtistEditorResource](docs/ArtistEditorResource.md)
- [ArtistResource](docs/ArtistResource.md)
- [ArtistStatisticsResource](docs/ArtistStatisticsResource.md)
- [ArtistStatusType](docs/ArtistStatusType.md)
- [ArtistTitleInfo](docs/ArtistTitleInfo.md)
- [AuthenticationRequiredType](docs/AuthenticationRequiredType.md)
- [AuthenticationType](docs/AuthenticationType.md)
- [AutoTaggingResource](docs/AutoTaggingResource.md)
- [AutoTaggingSpecificationSchema](docs/AutoTaggingSpecificationSchema.md)
- [BackupResource](docs/BackupResource.md)
- [BackupType](docs/BackupType.md)
- [BlocklistBulkResource](docs/BlocklistBulkResource.md)
- [BlocklistResource](docs/BlocklistResource.md)
- [BlocklistResourcePagingResource](docs/BlocklistResourcePagingResource.md)
- [CertificateValidationType](docs/CertificateValidationType.md)
- [Command](docs/Command.md)
- [CommandPriority](docs/CommandPriority.md)
- [CommandResource](docs/CommandResource.md)
- [CommandResult](docs/CommandResult.md)
- [CommandStatus](docs/CommandStatus.md)
- [CommandTrigger](docs/CommandTrigger.md)
- [CustomFilterResource](docs/CustomFilterResource.md)
- [CustomFormatBulkResource](docs/CustomFormatBulkResource.md)
- [CustomFormatResource](docs/CustomFormatResource.md)
- [CustomFormatSpecificationSchema](docs/CustomFormatSpecificationSchema.md)
- [DatabaseType](docs/DatabaseType.md)
- [DelayProfileResource](docs/DelayProfileResource.md)
- [DiskSpaceResource](docs/DiskSpaceResource.md)
- [DownloadClientBulkResource](docs/DownloadClientBulkResource.md)
- [DownloadClientConfigResource](docs/DownloadClientConfigResource.md)
- [DownloadClientResource](docs/DownloadClientResource.md)
- [DownloadProtocol](docs/DownloadProtocol.md)
- [EntityHistoryEventType](docs/EntityHistoryEventType.md)
- [Field](docs/Field.md)
- [FileDateType](docs/FileDateType.md)
- [HealthCheckResult](docs/HealthCheckResult.md)
- [HealthResource](docs/HealthResource.md)
- [HistoryResource](docs/HistoryResource.md)
- [HistoryResourcePagingResource](docs/HistoryResourcePagingResource.md)
- [HostConfigResource](docs/HostConfigResource.md)
- [ImportListBulkResource](docs/ImportListBulkResource.md)
- [ImportListExclusionResource](docs/ImportListExclusionResource.md)
- [ImportListMonitorType](docs/ImportListMonitorType.md)
- [ImportListResource](docs/ImportListResource.md)
- [ImportListType](docs/ImportListType.md)
- [IndexerBulkResource](docs/IndexerBulkResource.md)
- [IndexerConfigResource](docs/IndexerConfigResource.md)
- [IndexerFlagResource](docs/IndexerFlagResource.md)
- [IndexerResource](docs/IndexerResource.md)
- [IsoCountry](docs/IsoCountry.md)
- [LanguageResource](docs/LanguageResource.md)
- [Links](docs/Links.md)
- [LocalizationResource](docs/LocalizationResource.md)
- [LogFileResource](docs/LogFileResource.md)
- [LogResource](docs/LogResource.md)
- [LogResourcePagingResource](docs/LogResourcePagingResource.md)
- [ManualImportResource](docs/ManualImportResource.md)
- [ManualImportUpdateResource](docs/ManualImportUpdateResource.md)
- [MediaCover](docs/MediaCover.md)
- [MediaCoverTypes](docs/MediaCoverTypes.md)
- [MediaInfoModel](docs/MediaInfoModel.md)
- [MediaInfoResource](docs/MediaInfoResource.md)
- [MediaManagementConfigResource](docs/MediaManagementConfigResource.md)
- [MediumResource](docs/MediumResource.md)
- [Member](docs/Member.md)
- [MetadataProfileResource](docs/MetadataProfileResource.md)
- [MetadataProviderConfigResource](docs/MetadataProviderConfigResource.md)
- [MetadataResource](docs/MetadataResource.md)
- [MonitorTypes](docs/MonitorTypes.md)
- [MonitoringOptions](docs/MonitoringOptions.md)
- [NamingConfigResource](docs/NamingConfigResource.md)
- [NewItemMonitorTypes](docs/NewItemMonitorTypes.md)
- [NotificationResource](docs/NotificationResource.md)
- [ParseResource](docs/ParseResource.md)
- [ParsedAlbumInfo](docs/ParsedAlbumInfo.md)
- [ParsedTrackInfo](docs/ParsedTrackInfo.md)
- [PingResource](docs/PingResource.md)
- [PrimaryAlbumType](docs/PrimaryAlbumType.md)
- [PrivacyLevel](docs/PrivacyLevel.md)
- [ProfileFormatItemResource](docs/ProfileFormatItemResource.md)
- [ProfilePrimaryAlbumTypeItemResource](docs/ProfilePrimaryAlbumTypeItemResource.md)
- [ProfileReleaseStatusItemResource](docs/ProfileReleaseStatusItemResource.md)
- [ProfileSecondaryAlbumTypeItemResource](docs/ProfileSecondaryAlbumTypeItemResource.md)
- [ProperDownloadTypes](docs/ProperDownloadTypes.md)
- [ProviderMessage](docs/ProviderMessage.md)
- [ProviderMessageType](docs/ProviderMessageType.md)
- [ProxyType](docs/ProxyType.md)
- [Quality](docs/Quality.md)
- [QualityDefinitionResource](docs/QualityDefinitionResource.md)
- [QualityModel](docs/QualityModel.md)
- [QualityProfileQualityItemResource](docs/QualityProfileQualityItemResource.md)
- [QualityProfileResource](docs/QualityProfileResource.md)
- [QueueBulkResource](docs/QueueBulkResource.md)
- [QueueResource](docs/QueueResource.md)
- [QueueResourcePagingResource](docs/QueueResourcePagingResource.md)
- [QueueStatusResource](docs/QueueStatusResource.md)
- [Ratings](docs/Ratings.md)
- [Rejection](docs/Rejection.md)
- [RejectionType](docs/RejectionType.md)
- [ReleaseProfileResource](docs/ReleaseProfileResource.md)
- [ReleaseResource](docs/ReleaseResource.md)
- [ReleaseStatus](docs/ReleaseStatus.md)
- [RemotePathMappingResource](docs/RemotePathMappingResource.md)
- [RenameTrackResource](docs/RenameTrackResource.md)
- [RescanAfterRefreshType](docs/RescanAfterRefreshType.md)
- [RetagTrackResource](docs/RetagTrackResource.md)
- [Revision](docs/Revision.md)
- [RootFolderResource](docs/RootFolderResource.md)
- [RuntimeMode](docs/RuntimeMode.md)
- [SearchResource](docs/SearchResource.md)
- [SecondaryAlbumType](docs/SecondaryAlbumType.md)
- [SelectOption](docs/SelectOption.md)
- [SortDirection](docs/SortDirection.md)
- [SystemResource](docs/SystemResource.md)
- [TagDetailsResource](docs/TagDetailsResource.md)
- [TagDifference](docs/TagDifference.md)
- [TagResource](docs/TagResource.md)
- [TaskResource](docs/TaskResource.md)
- [TrackFileListResource](docs/TrackFileListResource.md)
- [TrackFileResource](docs/TrackFileResource.md)
- [TrackResource](docs/TrackResource.md)
- [TrackedDownloadState](docs/TrackedDownloadState.md)
- [TrackedDownloadStatus](docs/TrackedDownloadStatus.md)
- [TrackedDownloadStatusMessage](docs/TrackedDownloadStatusMessage.md)
- [UiConfigResource](docs/UiConfigResource.md)
- [UpdateChanges](docs/UpdateChanges.md)
- [UpdateMechanism](docs/UpdateMechanism.md)
- [UpdateResource](docs/UpdateResource.md)
- [WriteAudioTagsType](docs/WriteAudioTagsType.md)

## Documentation For Authorization

Authentication schemes defined for the API:
### X-Api-Key

- **Type**: API key
- **API key parameter name**: X-Api-Key
- **Location**: HTTP header

Note, each API key must be added to a map of `map[string]APIKey` where the key is: X-Api-Key and passed in as the auth context for each request.

Example

```go
auth := context.WithValue(
context.Background(),
lidarr.ContextAPIKeys,
map[string]lidarr.APIKey{
"X-Api-Key": {Key: "API_KEY_STRING"},
},
)
r, err := client.Service.Operation(auth, args)
```

### apikey

- **Type**: API key
- **API key parameter name**: apikey
- **Location**: URL query string

Note, each API key must be added to a map of `map[string]APIKey` where the key is: apikey and passed in as the auth context for each request.

Example

```go
auth := context.WithValue(
context.Background(),
lidarr.ContextAPIKeys,
map[string]lidarr.APIKey{
"apikey": {Key: "API_KEY_STRING"},
},
)
r, err := client.Service.Operation(auth, args)
```

## Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains
a number of utility functions to easily obtain pointers to values of basic types.
Each of these functions takes a value of the given basic type and returns a pointer to it:

* `PtrBool`
* `PtrInt`
* `PtrInt32`
* `PtrInt64`
* `PtrFloat`
* `PtrFloat32`
* `PtrFloat64`
* `PtrString`
* `PtrTime`

## Author