@jellyfin/sdk 0.8.2 → 0.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -4
- package/lib/api.d.ts +1 -0
- package/lib/api.js +4 -4
- package/lib/discovery/discovery-service.js +4 -9
- package/lib/discovery/recommended-server-discovery.js +39 -36
- package/lib/generated-client/api/activity-log-api.js +19 -11
- package/lib/generated-client/api/api-key-api.js +35 -31
- package/lib/generated-client/api/artists-api.d.ts +28 -26
- package/lib/generated-client/api/artists-api.js +47 -43
- package/lib/generated-client/api/audio-api.d.ts +20 -20
- package/lib/generated-client/api/audio-api.js +45 -43
- package/lib/generated-client/api/branding-api.js +32 -28
- package/lib/generated-client/api/channels-api.d.ts +9 -8
- package/lib/generated-client/api/channels-api.js +54 -54
- package/lib/generated-client/api/client-log-api.js +19 -11
- package/lib/generated-client/api/collection-api.js +35 -31
- package/lib/generated-client/api/configuration-api.d.ts +0 -47
- package/lib/generated-client/api/configuration-api.js +51 -117
- package/lib/generated-client/api/dashboard-api.js +26 -20
- package/lib/generated-client/api/devices-api.d.ts +3 -12
- package/lib/generated-client/api/devices-api.js +54 -60
- package/lib/generated-client/api/display-preferences-api.d.ts +22 -22
- package/lib/generated-client/api/display-preferences-api.js +39 -37
- package/lib/generated-client/api/dynamic-hls-api.d.ts +49 -31
- package/lib/generated-client/api/dynamic-hls-api.js +104 -100
- package/lib/generated-client/api/environment-api.js +59 -61
- package/lib/generated-client/api/filter-api.d.ts +9 -8
- package/lib/generated-client/api/filter-api.js +30 -24
- package/lib/generated-client/api/genres-api.d.ts +9 -8
- package/lib/generated-client/api/genres-api.js +30 -24
- package/lib/generated-client/api/hls-segment-api.js +48 -48
- package/lib/generated-client/api/image-api.d.ts +109 -1184
- package/lib/generated-client/api/image-api.js +394 -1307
- package/lib/generated-client/api/instant-mix-api.d.ts +35 -35
- package/lib/generated-client/api/instant-mix-api.js +125 -131
- package/lib/generated-client/api/item-lookup-api.js +99 -111
- package/lib/generated-client/api/item-refresh-api.js +19 -11
- package/lib/generated-client/api/item-update-api.js +35 -31
- package/lib/generated-client/api/items-api.d.ts +333 -1012
- package/lib/generated-client/api/items-api.js +191 -617
- package/lib/generated-client/api/library-api.d.ts +9 -8
- package/lib/generated-client/api/library-api.js +214 -254
- package/lib/generated-client/api/library-structure-api.js +75 -81
- package/lib/generated-client/api/live-tv-api.d.ts +17 -16
- package/lib/generated-client/api/live-tv-api.js +343 -415
- package/lib/generated-client/api/localization-api.js +43 -41
- package/lib/generated-client/api/lyrics-api.d.ts +344 -0
- package/lib/generated-client/api/lyrics-api.js +449 -0
- package/lib/generated-client/api/media-info-api.d.ts +7 -7
- package/lib/generated-client/api/media-info-api.js +54 -56
- package/lib/generated-client/api/movies-api.js +19 -11
- package/lib/generated-client/api/music-genres-api.d.ts +9 -8
- package/lib/generated-client/api/music-genres-api.js +30 -24
- package/lib/generated-client/api/package-api.js +59 -61
- package/lib/generated-client/api/persons-api.js +27 -21
- package/lib/generated-client/api/playlists-api.d.ts +315 -36
- package/lib/generated-client/api/playlists-api.js +416 -71
- package/lib/generated-client/api/playstate-api.d.ts +41 -68
- package/lib/generated-client/api/playstate-api.js +127 -153
- package/lib/generated-client/api/plugins-api.js +83 -91
- package/lib/generated-client/api/quick-connect-api.d.ts +46 -37
- package/lib/generated-client/api/quick-connect-api.js +83 -75
- package/lib/generated-client/api/remote-image-api.js +35 -31
- package/lib/generated-client/api/scheduled-tasks-api.js +51 -51
- package/lib/generated-client/api/search-api.d.ts +41 -40
- package/lib/generated-client/api/search-api.js +34 -26
- package/lib/generated-client/api/session-api.d.ts +9 -17
- package/lib/generated-client/api/session-api.js +145 -173
- package/lib/generated-client/api/startup-api.js +67 -71
- package/lib/generated-client/api/studios-api.js +27 -21
- package/lib/generated-client/api/subtitle-api.d.ts +7 -7
- package/lib/generated-client/api/subtitle-api.js +99 -109
- package/lib/generated-client/api/suggestions-api.d.ts +14 -13
- package/lib/generated-client/api/suggestions-api.js +31 -23
- package/lib/generated-client/api/sync-play-api.js +179 -211
- package/lib/generated-client/api/system-api.js +88 -98
- package/lib/generated-client/api/time-sync-api.js +18 -10
- package/lib/generated-client/api/tmdb-api.js +19 -11
- package/lib/generated-client/api/trailers-api.d.ts +35 -33
- package/lib/generated-client/api/trailers-api.js +40 -32
- package/lib/generated-client/api/trickplay-api.d.ts +176 -0
- package/lib/generated-client/api/trickplay-api.js +208 -0
- package/lib/generated-client/api/tv-shows-api.d.ts +25 -15
- package/lib/generated-client/api/tv-shows-api.js +58 -50
- package/lib/generated-client/api/universal-audio-api.d.ts +17 -16
- package/lib/generated-client/api/universal-audio-api.js +33 -27
- package/lib/generated-client/api/user-api.d.ts +35 -155
- package/lib/generated-client/api/user-api.js +152 -319
- package/lib/generated-client/api/user-library-api.d.ts +100 -100
- package/lib/generated-client/api/user-library-api.js +190 -200
- package/lib/generated-client/api/user-views-api.d.ts +22 -21
- package/lib/generated-client/api/user-views-api.js +47 -41
- package/lib/generated-client/api/video-attachments-api.js +18 -10
- package/lib/generated-client/api/videos-api.d.ts +12 -12
- package/lib/generated-client/api/videos-api.js +63 -67
- package/lib/generated-client/api/years-api.d.ts +15 -13
- package/lib/generated-client/api/years-api.js +33 -27
- package/lib/generated-client/api.d.ts +2 -4
- package/lib/generated-client/base.js +13 -0
- package/lib/generated-client/common.js +19 -11
- package/lib/generated-client/index.js +19 -10
- package/lib/generated-client/models/activity-log-entry-message.d.ts +37 -0
- package/lib/generated-client/models/activity-log-entry-start-message.d.ts +30 -0
- package/lib/generated-client/models/activity-log-entry-stop-message.d.ts +24 -0
- package/lib/generated-client/models/audio-spatial-format.d.ts +21 -0
- package/lib/generated-client/models/audio-spatial-format.js +24 -0
- package/lib/generated-client/models/authenticate-user-by-name.d.ts +0 -7
- package/lib/generated-client/models/base-item-dto.d.ts +37 -17
- package/lib/generated-client/models/base-item-person.d.ts +4 -3
- package/lib/generated-client/models/cast-receiver-application.d.ts +29 -0
- package/lib/generated-client/models/client-capabilities-dto.d.ts +17 -20
- package/lib/generated-client/models/client-capabilities.d.ts +16 -19
- package/lib/generated-client/models/collection-type-options.d.ts +9 -9
- package/lib/generated-client/models/collection-type-options.js +9 -9
- package/lib/generated-client/models/collection-type.d.ts +31 -0
- package/lib/generated-client/models/collection-type.js +34 -0
- package/lib/generated-client/models/container-profile.d.ts +1 -1
- package/lib/generated-client/models/create-playlist-dto.d.ts +18 -4
- package/lib/generated-client/models/create-user-by-name.d.ts +1 -1
- package/lib/generated-client/models/device-info.d.ts +6 -0
- package/lib/generated-client/models/device-profile.d.ts +0 -171
- package/lib/generated-client/models/dlna-profile-type.d.ts +1 -0
- package/lib/generated-client/models/dlna-profile-type.js +2 -1
- package/lib/generated-client/models/down-mix-stereo-algorithms.d.ts +21 -0
- package/lib/generated-client/models/down-mix-stereo-algorithms.js +24 -0
- package/lib/generated-client/models/encoding-options.d.ts +77 -40
- package/lib/generated-client/models/external-id-media-type.d.ts +1 -0
- package/lib/generated-client/models/external-id-media-type.js +2 -1
- package/lib/generated-client/models/extra-type.d.ts +30 -0
- package/lib/generated-client/models/extra-type.js +33 -0
- package/lib/generated-client/models/force-keep-alive-message.d.ts +36 -0
- package/lib/generated-client/models/general-command-message.d.ts +37 -0
- package/lib/generated-client/models/general-command-type.d.ts +1 -0
- package/lib/generated-client/models/general-command-type.js +2 -1
- package/lib/generated-client/models/get-programs-dto.d.ts +4 -3
- package/lib/generated-client/models/group-info-dto-group-update.d.ts +37 -0
- package/lib/generated-client/models/group-state-update-group-update.d.ts +37 -0
- package/lib/generated-client/models/group-state-update.d.ts +31 -0
- package/lib/generated-client/models/group-update.d.ts +20 -0
- package/lib/generated-client/models/hardware-encoding-type.d.ts +1 -0
- package/lib/generated-client/models/hardware-encoding-type.js +2 -1
- package/lib/generated-client/models/image-format.d.ts +1 -0
- package/lib/generated-client/models/image-format.js +2 -1
- package/lib/generated-client/models/image-resolution.d.ts +27 -0
- package/lib/generated-client/models/{ffmpeg-location.js → image-resolution.js} +12 -7
- package/lib/generated-client/models/inbound-keep-alive-message.d.ts +24 -0
- package/lib/generated-client/models/inbound-web-socket-message.d.ts +23 -0
- package/lib/generated-client/models/index.d.ts +74 -25
- package/lib/generated-client/models/index.js +17 -6
- package/lib/generated-client/models/item-fields.d.ts +1 -2
- package/lib/generated-client/models/item-fields.js +1 -2
- package/lib/generated-client/models/item-sort-by.d.ts +50 -0
- package/lib/generated-client/models/item-sort-by.js +53 -0
- package/lib/generated-client/models/library-changed-message.d.ts +37 -0
- package/lib/generated-client/models/library-options.d.ts +36 -0
- package/lib/generated-client/models/live-tv-options.d.ts +12 -0
- package/lib/generated-client/models/log-file.d.ts +1 -1
- package/lib/generated-client/models/lyric-dto.d.ts +31 -0
- package/lib/generated-client/models/lyric-line.d.ts +29 -0
- package/lib/generated-client/models/lyric-metadata.d.ts +77 -0
- package/lib/generated-client/models/media-source-info.d.ts +3 -2
- package/lib/generated-client/models/media-stream-protocol.d.ts +20 -0
- package/lib/generated-client/models/{header-match-type.js → media-stream-protocol.js} +5 -6
- package/lib/generated-client/models/media-stream-type.d.ts +1 -0
- package/lib/generated-client/models/media-stream-type.js +2 -1
- package/lib/generated-client/models/media-stream.d.ts +27 -6
- package/lib/generated-client/models/media-type.d.ts +23 -0
- package/lib/generated-client/models/{architecture.js → media-type.js} +8 -9
- package/lib/generated-client/models/metadata-editor-info.d.ts +3 -2
- package/lib/generated-client/models/network-configuration.d.ts +50 -116
- package/lib/generated-client/models/outbound-keep-alive-message.d.ts +30 -0
- package/lib/generated-client/models/outbound-web-socket-message.d.ts +44 -0
- package/lib/generated-client/models/parental-rating.d.ts +1 -1
- package/lib/generated-client/models/person-kind.d.ts +43 -0
- package/lib/generated-client/models/person-kind.js +46 -0
- package/lib/generated-client/models/play-message.d.ts +37 -0
- package/lib/generated-client/models/play-queue-update-group-update.d.ts +37 -0
- package/lib/generated-client/models/play-queue-update-reason.d.ts +28 -0
- package/lib/generated-client/models/play-queue-update-reason.js +31 -0
- package/lib/generated-client/models/play-queue-update.d.ts +69 -0
- package/lib/generated-client/models/playback-order.d.ts +20 -0
- package/lib/generated-client/models/{send-to-user-type.js → playback-order.js} +5 -6
- package/lib/generated-client/models/playback-progress-info.d.ts +7 -0
- package/lib/generated-client/models/playback-request-type.d.ts +35 -0
- package/lib/generated-client/models/playback-request-type.js +38 -0
- package/lib/generated-client/models/playback-start-info.d.ts +7 -0
- package/lib/generated-client/models/player-state-info.d.ts +7 -0
- package/lib/generated-client/models/playlist-user-permissions.d.ts +29 -0
- package/lib/generated-client/models/playstate-message.d.ts +37 -0
- package/lib/generated-client/models/plugin-installation-cancelled-message.d.ts +37 -0
- package/lib/generated-client/models/plugin-installation-completed-message.d.ts +37 -0
- package/lib/generated-client/models/plugin-installation-failed-message.d.ts +37 -0
- package/lib/generated-client/models/plugin-installing-message.d.ts +37 -0
- package/lib/generated-client/models/plugin-uninstalled-message.d.ts +37 -0
- package/lib/generated-client/models/process-priority-class.d.ts +24 -0
- package/lib/generated-client/models/process-priority-class.js +27 -0
- package/lib/generated-client/models/public-system-info.d.ts +1 -0
- package/lib/generated-client/models/refresh-progress-message.d.ts +38 -0
- package/lib/generated-client/models/remote-lyric-info-dto.d.ts +36 -0
- package/lib/generated-client/models/remote-subtitle-info.d.ts +30 -0
- package/lib/generated-client/models/remove-from-playlist-request-dto.d.ts +1 -1
- package/lib/generated-client/models/restart-required-message.d.ts +30 -0
- package/lib/generated-client/models/scheduled-task-ended-message.d.ts +37 -0
- package/lib/generated-client/models/scheduled-tasks-info-message.d.ts +37 -0
- package/lib/generated-client/models/scheduled-tasks-info-start-message.d.ts +30 -0
- package/lib/generated-client/models/scheduled-tasks-info-stop-message.d.ts +24 -0
- package/lib/generated-client/models/search-hint.d.ts +19 -16
- package/lib/generated-client/models/series-status.d.ts +2 -1
- package/lib/generated-client/models/series-status.js +3 -2
- package/lib/generated-client/models/series-timer-cancelled-message.d.ts +37 -0
- package/lib/generated-client/models/series-timer-created-message.d.ts +37 -0
- package/lib/generated-client/models/server-configuration.d.ts +45 -0
- package/lib/generated-client/models/server-restarting-message.d.ts +30 -0
- package/lib/generated-client/models/server-shutting-down-message.d.ts +30 -0
- package/lib/generated-client/models/session-info.d.ts +9 -9
- package/lib/generated-client/models/sessions-message.d.ts +37 -0
- package/lib/generated-client/models/sessions-start-message.d.ts +30 -0
- package/lib/generated-client/models/sessions-stop-message.d.ts +24 -0
- package/lib/generated-client/models/string-group-update.d.ts +36 -0
- package/lib/generated-client/models/sync-play-command-message.d.ts +37 -0
- package/lib/generated-client/models/sync-play-group-update-command-message.d.ts +37 -0
- package/lib/generated-client/models/sync-play-queue-item.d.ts +29 -0
- package/lib/generated-client/models/system-info.d.ts +17 -6
- package/lib/generated-client/models/timer-cancelled-message.d.ts +37 -0
- package/lib/generated-client/models/timer-created-message.d.ts +37 -0
- package/lib/generated-client/models/transcoding-info.d.ts +3 -2
- package/lib/generated-client/models/transcoding-info.js +15 -0
- package/lib/generated-client/models/transcoding-profile.d.ts +3 -2
- package/lib/generated-client/models/trickplay-info.d.ts +59 -0
- package/lib/generated-client/models/trickplay-options.d.ts +85 -0
- package/lib/generated-client/models/trickplay-scan-behavior.d.ts +20 -0
- package/lib/generated-client/models/{notification-level.js → trickplay-scan-behavior.js} +5 -6
- package/lib/generated-client/models/tuner-host-info.d.ts +6 -0
- package/lib/generated-client/models/update-playlist-dto.d.ts +42 -0
- package/lib/generated-client/models/update-playlist-user-dto.d.ts +23 -0
- package/lib/generated-client/models/update-user-item-data-dto.d.ts +83 -0
- package/lib/generated-client/models/upload-subtitle-dto.d.ts +6 -0
- package/lib/generated-client/models/user-configuration.d.ts +6 -0
- package/lib/generated-client/models/user-data-change-info.d.ts +30 -0
- package/lib/generated-client/models/user-data-changed-message.d.ts +37 -0
- package/lib/generated-client/models/user-deleted-message.d.ts +36 -0
- package/lib/generated-client/models/user-dto.d.ts +1 -0
- package/lib/generated-client/models/user-policy.d.ts +26 -2
- package/lib/generated-client/models/user-updated-message.d.ts +37 -0
- package/lib/generated-client/models/video-range-type.d.ts +27 -0
- package/lib/generated-client/models/video-range-type.js +30 -0
- package/lib/generated-client/models/video-range.d.ts +21 -0
- package/lib/generated-client/models/{device-profile-type.js → video-range.js} +6 -5
- package/lib/generated-client/models/web-socket-message.d.ts +18 -0
- package/lib/utils/api/image-api.d.ts +2 -2
- package/lib/utils/api/image-api.js +2 -2
- package/lib/utils/api/image-urls-api.d.ts +55 -0
- package/lib/utils/api/image-urls-api.js +115 -0
- package/lib/utils/api/index.d.ts +2 -4
- package/lib/utils/api/index.js +2 -4
- package/lib/utils/api/{dlna-api.d.ts → lyrics-api.d.ts} +2 -2
- package/lib/utils/api/{dlna-api.js → lyrics-api.js} +4 -4
- package/lib/utils/api/{dlna-server-api.d.ts → trickplay-api.d.ts} +2 -2
- package/lib/utils/api/trickplay-api.js +12 -0
- package/lib/utils/authentication.js +5 -6
- package/lib/utils/index.d.ts +2 -1
- package/lib/utils/index.js +2 -1
- package/lib/utils/versioning.d.ts +9 -0
- package/lib/utils/versioning.js +32 -0
- package/lib/versions.d.ts +2 -2
- package/lib/versions.js +2 -2
- package/package.json +17 -22
- package/lib/generated-client/api/dlna-api.js +0 -422
- package/lib/generated-client/api/dlna-server-api.js +0 -1088
- package/lib/generated-client/api/image-by-name-api.js +0 -423
- package/lib/generated-client/api/notifications-api.js +0 -484
- package/lib/node_modules/tslib/tslib.es6.js +0 -26
- package/lib/utils/api/dlna-server-api.js +0 -12
- package/lib/utils/api/image-by-name-api.d.ts +0 -8
- package/lib/utils/api/image-by-name-api.js +0 -12
- package/lib/utils/api/notifications-api.d.ts +0 -8
- package/lib/utils/api/notifications-api.js +0 -12
|
@@ -17,6 +17,8 @@ import { BaseItemKind } from '../models';
|
|
|
17
17
|
import { ImageType } from '../models';
|
|
18
18
|
import { ItemFields } from '../models';
|
|
19
19
|
import { ItemFilter } from '../models';
|
|
20
|
+
import { ItemSortBy } from '../models';
|
|
21
|
+
import { MediaType } from '../models';
|
|
20
22
|
import { SortOrder } from '../models';
|
|
21
23
|
/**
|
|
22
24
|
* ArtistsApi - axios parameter creator
|
|
@@ -36,7 +38,7 @@ export declare const ArtistsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
36
38
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
37
39
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
|
|
38
40
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
39
|
-
* @param {Array<
|
|
41
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
40
42
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
41
43
|
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
42
44
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -54,14 +56,14 @@ export declare const ArtistsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
54
56
|
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
55
57
|
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
56
58
|
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
57
|
-
* @param {Array<
|
|
59
|
+
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
|
|
58
60
|
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
59
61
|
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
60
62
|
* @param {boolean} [enableTotalRecordCount] Total record count.
|
|
61
63
|
* @param {*} [options] Override http request option.
|
|
62
64
|
* @throws {RequiredError}
|
|
63
65
|
*/
|
|
64
|
-
getAlbumArtists: (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<
|
|
66
|
+
getAlbumArtists: (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, genres?: Array<string>, genreIds?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, studioIds?: Array<string>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
65
67
|
/**
|
|
66
68
|
*
|
|
67
69
|
* @summary Gets an artist by name.
|
|
@@ -84,7 +86,7 @@ export declare const ArtistsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
84
86
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
85
87
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
|
|
86
88
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
87
|
-
* @param {Array<
|
|
89
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
88
90
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
89
91
|
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
90
92
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -102,14 +104,14 @@ export declare const ArtistsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
102
104
|
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
103
105
|
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
104
106
|
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
105
|
-
* @param {Array<
|
|
107
|
+
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
|
|
106
108
|
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
107
109
|
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
108
110
|
* @param {boolean} [enableTotalRecordCount] Total record count.
|
|
109
111
|
* @param {*} [options] Override http request option.
|
|
110
112
|
* @throws {RequiredError}
|
|
111
113
|
*/
|
|
112
|
-
getArtists: (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<
|
|
114
|
+
getArtists: (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, genres?: Array<string>, genreIds?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, studioIds?: Array<string>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
113
115
|
};
|
|
114
116
|
/**
|
|
115
117
|
* ArtistsApi - functional programming interface
|
|
@@ -129,7 +131,7 @@ export declare const ArtistsApiFp: (configuration?: Configuration) => {
|
|
|
129
131
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
130
132
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
|
|
131
133
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
132
|
-
* @param {Array<
|
|
134
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
133
135
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
134
136
|
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
135
137
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -147,14 +149,14 @@ export declare const ArtistsApiFp: (configuration?: Configuration) => {
|
|
|
147
149
|
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
148
150
|
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
149
151
|
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
150
|
-
* @param {Array<
|
|
152
|
+
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
|
|
151
153
|
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
152
154
|
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
153
155
|
* @param {boolean} [enableTotalRecordCount] Total record count.
|
|
154
156
|
* @param {*} [options] Override http request option.
|
|
155
157
|
* @throws {RequiredError}
|
|
156
158
|
*/
|
|
157
|
-
getAlbumArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<
|
|
159
|
+
getAlbumArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, genres?: Array<string>, genreIds?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, studioIds?: Array<string>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
|
|
158
160
|
/**
|
|
159
161
|
*
|
|
160
162
|
* @summary Gets an artist by name.
|
|
@@ -177,7 +179,7 @@ export declare const ArtistsApiFp: (configuration?: Configuration) => {
|
|
|
177
179
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
178
180
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
|
|
179
181
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
180
|
-
* @param {Array<
|
|
182
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
181
183
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
182
184
|
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
183
185
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -195,14 +197,14 @@ export declare const ArtistsApiFp: (configuration?: Configuration) => {
|
|
|
195
197
|
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
196
198
|
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
197
199
|
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
198
|
-
* @param {Array<
|
|
200
|
+
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
|
|
199
201
|
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
200
202
|
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
201
203
|
* @param {boolean} [enableTotalRecordCount] Total record count.
|
|
202
204
|
* @param {*} [options] Override http request option.
|
|
203
205
|
* @throws {RequiredError}
|
|
204
206
|
*/
|
|
205
|
-
getArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<
|
|
207
|
+
getArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, genres?: Array<string>, genreIds?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, studioIds?: Array<string>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
|
|
206
208
|
};
|
|
207
209
|
/**
|
|
208
210
|
* ArtistsApi - factory interface
|
|
@@ -222,7 +224,7 @@ export declare const ArtistsApiFactory: (configuration?: Configuration, basePath
|
|
|
222
224
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
223
225
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
|
|
224
226
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
225
|
-
* @param {Array<
|
|
227
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
226
228
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
227
229
|
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
228
230
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -240,14 +242,14 @@ export declare const ArtistsApiFactory: (configuration?: Configuration, basePath
|
|
|
240
242
|
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
241
243
|
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
242
244
|
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
243
|
-
* @param {Array<
|
|
245
|
+
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
|
|
244
246
|
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
245
247
|
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
246
248
|
* @param {boolean} [enableTotalRecordCount] Total record count.
|
|
247
249
|
* @param {*} [options] Override http request option.
|
|
248
250
|
* @throws {RequiredError}
|
|
249
251
|
*/
|
|
250
|
-
getAlbumArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<
|
|
252
|
+
getAlbumArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, genres?: Array<string>, genreIds?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, studioIds?: Array<string>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>;
|
|
251
253
|
/**
|
|
252
254
|
*
|
|
253
255
|
* @summary Gets an artist by name.
|
|
@@ -270,7 +272,7 @@ export declare const ArtistsApiFactory: (configuration?: Configuration, basePath
|
|
|
270
272
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
271
273
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
|
|
272
274
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
273
|
-
* @param {Array<
|
|
275
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
274
276
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
275
277
|
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
276
278
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -288,14 +290,14 @@ export declare const ArtistsApiFactory: (configuration?: Configuration, basePath
|
|
|
288
290
|
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
289
291
|
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
290
292
|
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
291
|
-
* @param {Array<
|
|
293
|
+
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
|
|
292
294
|
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
293
295
|
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
294
296
|
* @param {boolean} [enableTotalRecordCount] Total record count.
|
|
295
297
|
* @param {*} [options] Override http request option.
|
|
296
298
|
* @throws {RequiredError}
|
|
297
299
|
*/
|
|
298
|
-
getArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<
|
|
300
|
+
getArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, genres?: Array<string>, genreIds?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, studioIds?: Array<string>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>;
|
|
299
301
|
};
|
|
300
302
|
/**
|
|
301
303
|
* Request parameters for getAlbumArtists operation in ArtistsApi.
|
|
@@ -365,10 +367,10 @@ export interface ArtistsApiGetAlbumArtistsRequest {
|
|
|
365
367
|
readonly isFavorite?: boolean;
|
|
366
368
|
/**
|
|
367
369
|
* Optional filter by MediaType. Allows multiple, comma delimited.
|
|
368
|
-
* @type {Array<
|
|
370
|
+
* @type {Array<MediaType>}
|
|
369
371
|
* @memberof ArtistsApiGetAlbumArtists
|
|
370
372
|
*/
|
|
371
|
-
readonly mediaTypes?: Array<
|
|
373
|
+
readonly mediaTypes?: Array<MediaType>;
|
|
372
374
|
/**
|
|
373
375
|
* Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
374
376
|
* @type {Array<string>}
|
|
@@ -473,10 +475,10 @@ export interface ArtistsApiGetAlbumArtistsRequest {
|
|
|
473
475
|
readonly nameLessThan?: string;
|
|
474
476
|
/**
|
|
475
477
|
* Optional. Specify one or more sort orders, comma delimited.
|
|
476
|
-
* @type {Array<
|
|
478
|
+
* @type {Array<ItemSortBy>}
|
|
477
479
|
* @memberof ArtistsApiGetAlbumArtists
|
|
478
480
|
*/
|
|
479
|
-
readonly sortBy?: Array<
|
|
481
|
+
readonly sortBy?: Array<ItemSortBy>;
|
|
480
482
|
/**
|
|
481
483
|
* Sort Order - Ascending,Descending.
|
|
482
484
|
* @type {Array<SortOrder>}
|
|
@@ -583,10 +585,10 @@ export interface ArtistsApiGetArtistsRequest {
|
|
|
583
585
|
readonly isFavorite?: boolean;
|
|
584
586
|
/**
|
|
585
587
|
* Optional filter by MediaType. Allows multiple, comma delimited.
|
|
586
|
-
* @type {Array<
|
|
588
|
+
* @type {Array<MediaType>}
|
|
587
589
|
* @memberof ArtistsApiGetArtists
|
|
588
590
|
*/
|
|
589
|
-
readonly mediaTypes?: Array<
|
|
591
|
+
readonly mediaTypes?: Array<MediaType>;
|
|
590
592
|
/**
|
|
591
593
|
* Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
592
594
|
* @type {Array<string>}
|
|
@@ -691,10 +693,10 @@ export interface ArtistsApiGetArtistsRequest {
|
|
|
691
693
|
readonly nameLessThan?: string;
|
|
692
694
|
/**
|
|
693
695
|
* Optional. Specify one or more sort orders, comma delimited.
|
|
694
|
-
* @type {Array<
|
|
696
|
+
* @type {Array<ItemSortBy>}
|
|
695
697
|
* @memberof ArtistsApiGetArtists
|
|
696
698
|
*/
|
|
697
|
-
readonly sortBy?: Array<
|
|
699
|
+
readonly sortBy?: Array<ItemSortBy>;
|
|
698
700
|
/**
|
|
699
701
|
* Sort Order - Ascending,Descending.
|
|
700
702
|
* @type {Array<SortOrder>}
|
|
@@ -1,9 +1,19 @@
|
|
|
1
|
-
import { __awaiter } from '../../node_modules/tslib/tslib.es6.js';
|
|
2
1
|
import globalAxios from 'axios';
|
|
3
2
|
import { DUMMY_BASE_URL, setApiKeyToObject, setSearchParams, toPathString, assertParamExists, createRequestFunction } from '../common.js';
|
|
4
3
|
import { BaseAPI, BASE_PATH } from '../base.js';
|
|
5
4
|
|
|
6
5
|
/* tslint:disable */
|
|
6
|
+
/* eslint-disable */
|
|
7
|
+
/**
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* Do not edit the class manually.
|
|
10
|
+
*
|
|
11
|
+
* Jellyfin API
|
|
12
|
+
*
|
|
13
|
+
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
14
|
+
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
15
|
+
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
16
|
+
*/
|
|
7
17
|
/**
|
|
8
18
|
* ArtistsApi - axios parameter creator
|
|
9
19
|
* @export
|
|
@@ -23,7 +33,7 @@ const ArtistsApiAxiosParamCreator = function (configuration) {
|
|
|
23
33
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
24
34
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
|
|
25
35
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
26
|
-
* @param {Array<
|
|
36
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
27
37
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
28
38
|
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
29
39
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -41,14 +51,14 @@ const ArtistsApiAxiosParamCreator = function (configuration) {
|
|
|
41
51
|
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
42
52
|
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
43
53
|
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
44
|
-
* @param {Array<
|
|
54
|
+
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
|
|
45
55
|
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
46
56
|
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
47
57
|
* @param {boolean} [enableTotalRecordCount] Total record count.
|
|
48
58
|
* @param {*} [options] Override http request option.
|
|
49
59
|
* @throws {RequiredError}
|
|
50
60
|
*/
|
|
51
|
-
getAlbumArtists: (minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, options = {}) =>
|
|
61
|
+
getAlbumArtists: async (minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, options = {}) => {
|
|
52
62
|
const localVarPath = `/Artists/AlbumArtists`;
|
|
53
63
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
54
64
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -56,11 +66,11 @@ const ArtistsApiAxiosParamCreator = function (configuration) {
|
|
|
56
66
|
if (configuration) {
|
|
57
67
|
baseOptions = configuration.baseOptions;
|
|
58
68
|
}
|
|
59
|
-
const localVarRequestOptions =
|
|
69
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
60
70
|
const localVarHeaderParameter = {};
|
|
61
71
|
const localVarQueryParameter = {};
|
|
62
72
|
// authentication CustomAuthentication required
|
|
63
|
-
|
|
73
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
64
74
|
if (minCommunityRating !== undefined) {
|
|
65
75
|
localVarQueryParameter['minCommunityRating'] = minCommunityRating;
|
|
66
76
|
}
|
|
@@ -159,12 +169,12 @@ const ArtistsApiAxiosParamCreator = function (configuration) {
|
|
|
159
169
|
}
|
|
160
170
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
161
171
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
162
|
-
localVarRequestOptions.headers =
|
|
172
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
163
173
|
return {
|
|
164
174
|
url: toPathString(localVarUrlObj),
|
|
165
175
|
options: localVarRequestOptions,
|
|
166
176
|
};
|
|
167
|
-
}
|
|
177
|
+
},
|
|
168
178
|
/**
|
|
169
179
|
*
|
|
170
180
|
* @summary Gets an artist by name.
|
|
@@ -173,7 +183,7 @@ const ArtistsApiAxiosParamCreator = function (configuration) {
|
|
|
173
183
|
* @param {*} [options] Override http request option.
|
|
174
184
|
* @throws {RequiredError}
|
|
175
185
|
*/
|
|
176
|
-
getArtistByName: (name, userId, options = {}) =>
|
|
186
|
+
getArtistByName: async (name, userId, options = {}) => {
|
|
177
187
|
// verify required parameter 'name' is not null or undefined
|
|
178
188
|
assertParamExists('getArtistByName', 'name', name);
|
|
179
189
|
const localVarPath = `/Artists/{name}`
|
|
@@ -184,22 +194,22 @@ const ArtistsApiAxiosParamCreator = function (configuration) {
|
|
|
184
194
|
if (configuration) {
|
|
185
195
|
baseOptions = configuration.baseOptions;
|
|
186
196
|
}
|
|
187
|
-
const localVarRequestOptions =
|
|
197
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
188
198
|
const localVarHeaderParameter = {};
|
|
189
199
|
const localVarQueryParameter = {};
|
|
190
200
|
// authentication CustomAuthentication required
|
|
191
|
-
|
|
201
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
192
202
|
if (userId !== undefined) {
|
|
193
203
|
localVarQueryParameter['userId'] = userId;
|
|
194
204
|
}
|
|
195
205
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
196
206
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
197
|
-
localVarRequestOptions.headers =
|
|
207
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
198
208
|
return {
|
|
199
209
|
url: toPathString(localVarUrlObj),
|
|
200
210
|
options: localVarRequestOptions,
|
|
201
211
|
};
|
|
202
|
-
}
|
|
212
|
+
},
|
|
203
213
|
/**
|
|
204
214
|
*
|
|
205
215
|
* @summary Gets all artists from a given item, folder, or the entire library.
|
|
@@ -213,7 +223,7 @@ const ArtistsApiAxiosParamCreator = function (configuration) {
|
|
|
213
223
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
214
224
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
|
|
215
225
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
216
|
-
* @param {Array<
|
|
226
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
217
227
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
218
228
|
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
219
229
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -231,14 +241,14 @@ const ArtistsApiAxiosParamCreator = function (configuration) {
|
|
|
231
241
|
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
232
242
|
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
233
243
|
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
234
|
-
* @param {Array<
|
|
244
|
+
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
|
|
235
245
|
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
236
246
|
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
237
247
|
* @param {boolean} [enableTotalRecordCount] Total record count.
|
|
238
248
|
* @param {*} [options] Override http request option.
|
|
239
249
|
* @throws {RequiredError}
|
|
240
250
|
*/
|
|
241
|
-
getArtists: (minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, options = {}) =>
|
|
251
|
+
getArtists: async (minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, options = {}) => {
|
|
242
252
|
const localVarPath = `/Artists`;
|
|
243
253
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
244
254
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -246,11 +256,11 @@ const ArtistsApiAxiosParamCreator = function (configuration) {
|
|
|
246
256
|
if (configuration) {
|
|
247
257
|
baseOptions = configuration.baseOptions;
|
|
248
258
|
}
|
|
249
|
-
const localVarRequestOptions =
|
|
259
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
250
260
|
const localVarHeaderParameter = {};
|
|
251
261
|
const localVarQueryParameter = {};
|
|
252
262
|
// authentication CustomAuthentication required
|
|
253
|
-
|
|
263
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
254
264
|
if (minCommunityRating !== undefined) {
|
|
255
265
|
localVarQueryParameter['minCommunityRating'] = minCommunityRating;
|
|
256
266
|
}
|
|
@@ -349,12 +359,12 @@ const ArtistsApiAxiosParamCreator = function (configuration) {
|
|
|
349
359
|
}
|
|
350
360
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
351
361
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
352
|
-
localVarRequestOptions.headers =
|
|
362
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
353
363
|
return {
|
|
354
364
|
url: toPathString(localVarUrlObj),
|
|
355
365
|
options: localVarRequestOptions,
|
|
356
366
|
};
|
|
357
|
-
}
|
|
367
|
+
},
|
|
358
368
|
};
|
|
359
369
|
};
|
|
360
370
|
/**
|
|
@@ -377,7 +387,7 @@ const ArtistsApiFp = function (configuration) {
|
|
|
377
387
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
378
388
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
|
|
379
389
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
380
|
-
* @param {Array<
|
|
390
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
381
391
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
382
392
|
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
383
393
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -395,18 +405,16 @@ const ArtistsApiFp = function (configuration) {
|
|
|
395
405
|
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
396
406
|
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
397
407
|
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
398
|
-
* @param {Array<
|
|
408
|
+
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
|
|
399
409
|
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
400
410
|
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
401
411
|
* @param {boolean} [enableTotalRecordCount] Total record count.
|
|
402
412
|
* @param {*} [options] Override http request option.
|
|
403
413
|
* @throws {RequiredError}
|
|
404
414
|
*/
|
|
405
|
-
getAlbumArtists(minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, options) {
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
409
|
-
});
|
|
415
|
+
async getAlbumArtists(minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, options) {
|
|
416
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAlbumArtists(minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, options);
|
|
417
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
410
418
|
},
|
|
411
419
|
/**
|
|
412
420
|
*
|
|
@@ -416,11 +424,9 @@ const ArtistsApiFp = function (configuration) {
|
|
|
416
424
|
* @param {*} [options] Override http request option.
|
|
417
425
|
* @throws {RequiredError}
|
|
418
426
|
*/
|
|
419
|
-
getArtistByName(name, userId, options) {
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
423
|
-
});
|
|
427
|
+
async getArtistByName(name, userId, options) {
|
|
428
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getArtistByName(name, userId, options);
|
|
429
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
424
430
|
},
|
|
425
431
|
/**
|
|
426
432
|
*
|
|
@@ -435,7 +441,7 @@ const ArtistsApiFp = function (configuration) {
|
|
|
435
441
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
436
442
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
|
|
437
443
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
438
|
-
* @param {Array<
|
|
444
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
439
445
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
440
446
|
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
441
447
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -453,18 +459,16 @@ const ArtistsApiFp = function (configuration) {
|
|
|
453
459
|
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
454
460
|
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
455
461
|
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
456
|
-
* @param {Array<
|
|
462
|
+
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
|
|
457
463
|
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
458
464
|
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
459
465
|
* @param {boolean} [enableTotalRecordCount] Total record count.
|
|
460
466
|
* @param {*} [options] Override http request option.
|
|
461
467
|
* @throws {RequiredError}
|
|
462
468
|
*/
|
|
463
|
-
getArtists(minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, options) {
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
467
|
-
});
|
|
469
|
+
async getArtists(minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, options) {
|
|
470
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getArtists(minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, options);
|
|
471
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
468
472
|
},
|
|
469
473
|
};
|
|
470
474
|
};
|
|
@@ -488,7 +492,7 @@ const ArtistsApiFactory = function (configuration, basePath, axios) {
|
|
|
488
492
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
489
493
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
|
|
490
494
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
491
|
-
* @param {Array<
|
|
495
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
492
496
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
493
497
|
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
494
498
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -506,7 +510,7 @@ const ArtistsApiFactory = function (configuration, basePath, axios) {
|
|
|
506
510
|
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
507
511
|
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
508
512
|
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
509
|
-
* @param {Array<
|
|
513
|
+
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
|
|
510
514
|
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
511
515
|
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
512
516
|
* @param {boolean} [enableTotalRecordCount] Total record count.
|
|
@@ -540,7 +544,7 @@ const ArtistsApiFactory = function (configuration, basePath, axios) {
|
|
|
540
544
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
541
545
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
|
|
542
546
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
543
|
-
* @param {Array<
|
|
547
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
544
548
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
545
549
|
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
546
550
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -558,7 +562,7 @@ const ArtistsApiFactory = function (configuration, basePath, axios) {
|
|
|
558
562
|
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
559
563
|
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
560
564
|
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
561
|
-
* @param {Array<
|
|
565
|
+
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
|
|
562
566
|
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
563
567
|
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
564
568
|
* @param {boolean} [enableTotalRecordCount] Total record count.
|