readarr-go

module
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 17, 2023 License: MPL-2.0

README

Go API client for readarr

Readarr API docs

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • Package version: 0.4.0

  • API version: 1.0.0

  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

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

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

import readarr "github.com/devopsarr/readarr-go"

To use a proxy, set the environment variable HTTP_PROXY:

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 sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), readarr.ContextServerIndex, 1)
Templated Server URL

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

ctx := context.WithValue(context.Background(), readarr.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 sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

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

Documentation for API Endpoints

All URIs are relative to http://localhost:8787

Class Method HTTP request Description
ApiInfoApi GetApi Get /api
AuthenticationApi CreateLogin Post /login
AuthenticationApi GetLogout Get /logout
AuthorApi CreateAuthor Post /api/v1/author
AuthorApi DeleteAuthor Delete /api/v1/author/{id}
AuthorApi GetAuthorById Get /api/v1/author/{id}
AuthorApi ListAuthor Get /api/v1/author
AuthorApi UpdateAuthor Put /api/v1/author/{id}
AuthorEditorApi DeleteAuthorEditor Delete /api/v1/author/editor
AuthorEditorApi PutAuthorEditor Put /api/v1/author/editor
AuthorLookupApi GetAuthorLookup Get /api/v1/author/lookup
BackupApi CreateSystemBackupRestoreById Post /api/v1/system/backup/restore/{id}
BackupApi CreateSystemBackupRestoreUpload Post /api/v1/system/backup/restore/upload
BackupApi DeleteSystemBackup Delete /api/v1/system/backup/{id}
BackupApi ListSystemBackup Get /api/v1/system/backup
BlocklistApi DeleteBlocklist Delete /api/v1/blocklist/{id}
BlocklistApi DeleteBlocklistBulk Delete /api/v1/blocklist/bulk
BlocklistApi GetBlocklist Get /api/v1/blocklist
BookApi CreateBook Post /api/v1/book
BookApi DeleteBook Delete /api/v1/book/{id}
BookApi GetBookById Get /api/v1/book/{id}
BookApi GetBookidOverview Get /api/v1/book/{id}/overview
BookApi ListBook Get /api/v1/book
BookApi PutBookMonitor Put /api/v1/book/monitor
BookApi UpdateBook Put /api/v1/book/{id}
BookEditorApi DeleteBookEditor Delete /api/v1/book/editor
BookEditorApi PutBookEditor Put /api/v1/book/editor
BookFileApi DeleteBookFile Delete /api/v1/bookfile/{id}
BookFileApi DeleteBookFileBulk Delete /api/v1/bookfile/bulk
BookFileApi GetBookFileById Get /api/v1/bookfile/{id}
BookFileApi ListBookFile Get /api/v1/bookfile
BookFileApi PutBookFileEditor Put /api/v1/bookfile/editor
BookFileApi UpdateBookFile Put /api/v1/bookfile/{id}
BookLookupApi GetBookLookup Get /api/v1/book/lookup
BookshelfApi CreateBookshelf Post /api/v1/bookshelf
CalendarApi GetCalendarById Get /api/v1/calendar/{id}
CalendarApi ListCalendar Get /api/v1/calendar
CalendarFeedApi GetFeedV1CalendarReadarrIcs Get /feed/v1/calendar/readarr.ics
CommandApi CreateCommand Post /api/v1/command
CommandApi DeleteCommand Delete /api/v1/command/{id}
CommandApi GetCommandById Get /api/v1/command/{id}
CommandApi ListCommand Get /api/v1/command
CustomFilterApi CreateCustomFilter Post /api/v1/customfilter
CustomFilterApi DeleteCustomFilter Delete /api/v1/customfilter/{id}
CustomFilterApi GetCustomFilterById Get /api/v1/customfilter/{id}
CustomFilterApi ListCustomFilter Get /api/v1/customfilter
CustomFilterApi UpdateCustomFilter Put /api/v1/customfilter/{id}
CustomFormatApi CreateCustomFormat Post /api/v1/customformat
CustomFormatApi DeleteCustomFormat Delete /api/v1/customformat/{id}
CustomFormatApi GetCustomFormatById Get /api/v1/customformat/{id}
CustomFormatApi GetCustomFormatSchema Get /api/v1/customformat/schema
CustomFormatApi ListCustomFormat Get /api/v1/customformat
CustomFormatApi UpdateCustomFormat Put /api/v1/customformat/{id}
CutoffApi GetWantedCutoff Get /api/v1/wanted/cutoff
CutoffApi GetWantedCutoffById Get /api/v1/wanted/cutoff/{id}
DelayProfileApi CreateDelayProfile Post /api/v1/delayprofile
DelayProfileApi DeleteDelayProfile Delete /api/v1/delayprofile/{id}
DelayProfileApi GetDelayProfileById Get /api/v1/delayprofile/{id}
DelayProfileApi ListDelayProfile Get /api/v1/delayprofile
DelayProfileApi UpdateDelayProfile Put /api/v1/delayprofile/{id}
DelayProfileApi UpdateDelayProfileReorder Put /api/v1/delayprofile/reorder/{id}
DevelopmentConfigApi GetDevelopmentConfig Get /api/v1/config/development
DevelopmentConfigApi GetDevelopmentConfigById Get /api/v1/config/development/{id}
DevelopmentConfigApi UpdateDevelopmentConfig Put /api/v1/config/development/{id}
DiskSpaceApi ListDiskSpace Get /api/v1/diskspace
DownloadClientApi CreateDownloadClient Post /api/v1/downloadclient
DownloadClientApi CreateDownloadClientActionByName Post /api/v1/downloadclient/action/{name}
DownloadClientApi DeleteDownloadClient Delete /api/v1/downloadclient/{id}
DownloadClientApi DeleteDownloadClientBulk Delete /api/v1/downloadclient/bulk
DownloadClientApi GetDownloadClientById Get /api/v1/downloadclient/{id}
DownloadClientApi ListDownloadClient Get /api/v1/downloadclient
DownloadClientApi ListDownloadClientSchema Get /api/v1/downloadclient/schema
DownloadClientApi PutDownloadClientBulk Put /api/v1/downloadclient/bulk
DownloadClientApi TestDownloadClient Post /api/v1/downloadclient/test
DownloadClientApi TestallDownloadClient Post /api/v1/downloadclient/testall
DownloadClientApi UpdateDownloadClient Put /api/v1/downloadclient/{id}
DownloadClientConfigApi GetDownloadClientConfig Get /api/v1/config/downloadclient
DownloadClientConfigApi GetDownloadClientConfigById Get /api/v1/config/downloadclient/{id}
DownloadClientConfigApi UpdateDownloadClientConfig Put /api/v1/config/downloadclient/{id}
EditionApi ListEdition Get /api/v1/edition
FileSystemApi GetFileSystem Get /api/v1/filesystem
FileSystemApi GetFileSystemMediafiles Get /api/v1/filesystem/mediafiles
FileSystemApi GetFileSystemType Get /api/v1/filesystem/type
HealthApi ListHealth Get /api/v1/health
HistoryApi CreateHistoryFailedById Post /api/v1/history/failed/{id}
HistoryApi GetHistory Get /api/v1/history
HistoryApi ListHistoryAuthor Get /api/v1/history/author
HistoryApi ListHistorySince Get /api/v1/history/since
HostConfigApi GetHostConfig Get /api/v1/config/host
HostConfigApi GetHostConfigById Get /api/v1/config/host/{id}
HostConfigApi UpdateHostConfig Put /api/v1/config/host/{id}
ImportListApi CreateImportList Post /api/v1/importlist
ImportListApi CreateImportListActionByName Post /api/v1/importlist/action/{name}
ImportListApi DeleteImportList Delete /api/v1/importlist/{id}
ImportListApi DeleteImportListBulk Delete /api/v1/importlist/bulk
ImportListApi GetImportListById Get /api/v1/importlist/{id}
ImportListApi ListImportList Get /api/v1/importlist
ImportListApi ListImportListSchema Get /api/v1/importlist/schema
ImportListApi PutImportListBulk Put /api/v1/importlist/bulk
ImportListApi TestImportList Post /api/v1/importlist/test
ImportListApi TestallImportList Post /api/v1/importlist/testall
ImportListApi UpdateImportList Put /api/v1/importlist/{id}
ImportListExclusionApi CreateImportListExclusion Post /api/v1/importlistexclusion
ImportListExclusionApi DeleteImportListExclusion Delete /api/v1/importlistexclusion/{id}
ImportListExclusionApi GetImportListExclusionById Get /api/v1/importlistexclusion/{id}
ImportListExclusionApi ListImportListExclusion Get /api/v1/importlistexclusion
ImportListExclusionApi UpdateImportListExclusion Put /api/v1/importlistexclusion/{id}
IndexerApi CreateIndexer Post /api/v1/indexer
IndexerApi CreateIndexerActionByName Post /api/v1/indexer/action/{name}
IndexerApi DeleteIndexer Delete /api/v1/indexer/{id}
IndexerApi DeleteIndexerBulk Delete /api/v1/indexer/bulk
IndexerApi GetIndexerById Get /api/v1/indexer/{id}
IndexerApi ListIndexer Get /api/v1/indexer
IndexerApi ListIndexerSchema Get /api/v1/indexer/schema
IndexerApi PutIndexerBulk Put /api/v1/indexer/bulk
IndexerApi TestIndexer Post /api/v1/indexer/test
IndexerApi TestallIndexer Post /api/v1/indexer/testall
IndexerApi UpdateIndexer Put /api/v1/indexer/{id}
IndexerConfigApi GetIndexerConfig Get /api/v1/config/indexer
IndexerConfigApi GetIndexerConfigById Get /api/v1/config/indexer/{id}
IndexerConfigApi UpdateIndexerConfig Put /api/v1/config/indexer/{id}
InitializeJsApi GetInitializeJs Get /initialize.js
LanguageApi GetLanguageById Get /api/v1/language/{id}
LanguageApi ListLanguage Get /api/v1/language
LocalizationApi GetLocalization Get /api/v1/localization
LogApi GetLog Get /api/v1/log
LogFileApi GetLogFileByFilename Get /api/v1/log/file/{filename}
LogFileApi ListLogFile Get /api/v1/log/file
ManualImportApi CreateManualImport Post /api/v1/manualimport
ManualImportApi ListManualImport Get /api/v1/manualimport
MediaCoverApi GetMediaCoverAuthorauthorIdByFilename Get /api/v1/mediacover/author/{authorId}/{filename}
MediaCoverApi GetMediaCoverBookbookIdByFilename Get /api/v1/mediacover/book/{bookId}/{filename}
MediaManagementConfigApi GetMediaManagementConfig Get /api/v1/config/mediamanagement
MediaManagementConfigApi GetMediaManagementConfigById Get /api/v1/config/mediamanagement/{id}
MediaManagementConfigApi UpdateMediaManagementConfig Put /api/v1/config/mediamanagement/{id}
MetadataApi CreateMetadata Post /api/v1/metadata
MetadataApi CreateMetadataActionByName Post /api/v1/metadata/action/{name}
MetadataApi DeleteMetadata Delete /api/v1/metadata/{id}
MetadataApi GetMetadataById Get /api/v1/metadata/{id}
MetadataApi ListMetadata Get /api/v1/metadata
MetadataApi ListMetadataSchema Get /api/v1/metadata/schema
MetadataApi TestMetadata Post /api/v1/metadata/test
MetadataApi TestallMetadata Post /api/v1/metadata/testall
MetadataApi UpdateMetadata Put /api/v1/metadata/{id}
MetadataProfileApi CreateMetadataProfile Post /api/v1/metadataprofile
MetadataProfileApi DeleteMetadataProfile Delete /api/v1/metadataprofile/{id}
MetadataProfileApi GetMetadataProfileById Get /api/v1/metadataprofile/{id}
MetadataProfileApi ListMetadataProfile Get /api/v1/metadataprofile
MetadataProfileApi UpdateMetadataProfile Put /api/v1/metadataprofile/{id}
MetadataProfileSchemaApi GetMetadataprofileSchema Get /api/v1/metadataprofile/schema
MetadataProviderConfigApi GetMetadataProviderConfig Get /api/v1/config/metadataprovider
MetadataProviderConfigApi GetMetadataProviderConfigById Get /api/v1/config/metadataprovider/{id}
MetadataProviderConfigApi UpdateMetadataProviderConfig Put /api/v1/config/metadataprovider/{id}
MissingApi GetWantedMissing Get /api/v1/wanted/missing
MissingApi GetWantedMissingById Get /api/v1/wanted/missing/{id}
NamingConfigApi GetNamingConfig Get /api/v1/config/naming
NamingConfigApi GetNamingConfigById Get /api/v1/config/naming/{id}
NamingConfigApi GetNamingConfigExamples Get /api/v1/config/naming/examples
NamingConfigApi UpdateNamingConfig Put /api/v1/config/naming/{id}
NotificationApi CreateNotification Post /api/v1/notification
NotificationApi CreateNotificationActionByName Post /api/v1/notification/action/{name}
NotificationApi DeleteNotification Delete /api/v1/notification/{id}
NotificationApi GetNotificationById Get /api/v1/notification/{id}
NotificationApi ListNotification Get /api/v1/notification
NotificationApi ListNotificationSchema Get /api/v1/notification/schema
NotificationApi TestNotification Post /api/v1/notification/test
NotificationApi TestallNotification Post /api/v1/notification/testall
NotificationApi UpdateNotification Put /api/v1/notification/{id}
ParseApi GetParse Get /api/v1/parse
PingApi GetPing Get /ping
QualityDefinitionApi GetQualityDefinitionById Get /api/v1/qualitydefinition/{id}
QualityDefinitionApi ListQualityDefinition Get /api/v1/qualitydefinition
QualityDefinitionApi PutQualityDefinitionUpdate Put /api/v1/qualitydefinition/update
QualityDefinitionApi UpdateQualityDefinition Put /api/v1/qualitydefinition/{id}
QualityProfileApi CreateQualityProfile Post /api/v1/qualityprofile
QualityProfileApi DeleteQualityProfile Delete /api/v1/qualityprofile/{id}
QualityProfileApi GetQualityProfileById Get /api/v1/qualityprofile/{id}
QualityProfileApi ListQualityProfile Get /api/v1/qualityprofile
QualityProfileApi UpdateQualityProfile Put /api/v1/qualityprofile/{id}
QualityProfileSchemaApi GetQualityprofileSchema Get /api/v1/qualityprofile/schema
QueueApi DeleteQueue Delete /api/v1/queue/{id}
QueueApi DeleteQueueBulk Delete /api/v1/queue/bulk
QueueApi GetQueue Get /api/v1/queue
QueueActionApi CreateQueueGrabBulk Post /api/v1/queue/grab/bulk
QueueActionApi CreateQueueGrabById Post /api/v1/queue/grab/{id}
QueueDetailsApi ListQueueDetails Get /api/v1/queue/details
QueueStatusApi GetQueueStatus Get /api/v1/queue/status
ReleaseApi CreateRelease Post /api/v1/release
ReleaseApi ListRelease Get /api/v1/release
ReleaseProfileApi CreateReleaseProfile Post /api/v1/releaseprofile
ReleaseProfileApi DeleteReleaseProfile Delete /api/v1/releaseprofile/{id}
ReleaseProfileApi GetReleaseProfileById Get /api/v1/releaseprofile/{id}
ReleaseProfileApi ListReleaseProfile Get /api/v1/releaseprofile
ReleaseProfileApi UpdateReleaseProfile Put /api/v1/releaseprofile/{id}
ReleasePushApi CreateReleasePush Post /api/v1/release/push
RemotePathMappingApi CreateRemotePathMapping Post /api/v1/remotepathmapping
RemotePathMappingApi DeleteRemotePathMapping Delete /api/v1/remotepathmapping/{id}
RemotePathMappingApi GetRemotePathMappingById Get /api/v1/remotepathmapping/{id}
RemotePathMappingApi ListRemotePathMapping Get /api/v1/remotepathmapping
RemotePathMappingApi UpdateRemotePathMapping Put /api/v1/remotepathmapping/{id}
RenameBookApi ListRename Get /api/v1/rename
RetagBookApi ListRetag Get /api/v1/retag
RootFolderApi CreateRootFolder Post /api/v1/rootfolder
RootFolderApi DeleteRootFolder Delete /api/v1/rootfolder/{id}
RootFolderApi GetRootFolderById Get /api/v1/rootfolder/{id}
RootFolderApi ListRootFolder Get /api/v1/rootfolder
RootFolderApi UpdateRootFolder Put /api/v1/rootfolder/{id}
SearchApi GetSearch Get /api/v1/search
SeriesApi ListSeries Get /api/v1/series
StaticResourceApi Get Get /
StaticResourceApi GetByPath Get /{path}
StaticResourceApi GetContentByPath Get /content/{path}
StaticResourceApi GetLogin Get /login
SystemApi CreateSystemRestart Post /api/v1/system/restart
SystemApi CreateSystemShutdown Post /api/v1/system/shutdown
SystemApi GetSystemRoutes Get /api/v1/system/routes
SystemApi GetSystemRoutesDuplicate Get /api/v1/system/routes/duplicate
SystemApi GetSystemStatus Get /api/v1/system/status
TagApi CreateTag Post /api/v1/tag
TagApi DeleteTag Delete /api/v1/tag/{id}
TagApi GetTagById Get /api/v1/tag/{id}
TagApi ListTag Get /api/v1/tag
TagApi UpdateTag Put /api/v1/tag/{id}
TagDetailsApi GetTagDetailById Get /api/v1/tag/detail/{id}
TagDetailsApi ListTagDetail Get /api/v1/tag/detail
TaskApi GetSystemTaskById Get /api/v1/system/task/{id}
TaskApi ListSystemTask Get /api/v1/system/task
UiConfigApi GetUiConfig Get /api/v1/config/ui
UiConfigApi GetUiConfigById Get /api/v1/config/ui/{id}
UiConfigApi UpdateUiConfig Put /api/v1/config/ui/{id}
UpdateApi ListUpdate Get /api/v1/update
UpdateLogFileApi GetLogFileUpdateByFilename Get /api/v1/log/file/update/{filename}
UpdateLogFileApi ListLogFileUpdate Get /api/v1/log/file/update

Documentation For Models

Documentation For Authorization

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.

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.

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

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.