@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
|
@@ -1,394 +1,64 @@
|
|
|
1
|
-
import { __awaiter } from '../../node_modules/tslib/tslib.es6.js';
|
|
2
1
|
import globalAxios from 'axios';
|
|
3
|
-
import { DUMMY_BASE_URL, setApiKeyToObject, setSearchParams, toPathString,
|
|
2
|
+
import { assertParamExists, DUMMY_BASE_URL, setApiKeyToObject, setSearchParams, toPathString, serializeDataIfNeeded, createRequestFunction } from '../common.js';
|
|
4
3
|
import { BaseAPI, BASE_PATH } from '../base.js';
|
|
5
4
|
|
|
6
5
|
/* tslint:disable */
|
|
6
|
+
/* eslint-disable */
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
*
|
|
25
|
-
* @
|
|
26
|
-
* @param {
|
|
27
|
-
* @param {
|
|
28
|
-
* @param {
|
|
29
|
-
* @
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
* @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
|
|
42
|
-
* @param {boolean} [isMovie] Optional filter for live tv movies.
|
|
43
|
-
* @param {boolean} [isSeries] Optional filter for live tv series.
|
|
44
|
-
* @param {boolean} [isNews] Optional filter for live tv news.
|
|
45
|
-
* @param {boolean} [isKids] Optional filter for live tv kids.
|
|
46
|
-
* @param {boolean} [isSports] Optional filter for live tv sports.
|
|
47
|
-
* @param {Array<string>} [excludeItemIds] Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.
|
|
48
|
-
* @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
|
|
49
|
-
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
50
|
-
* @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
51
|
-
* @param {string} [searchTerm] Optional. Filter based on a search term.
|
|
52
|
-
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
53
|
-
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
54
|
-
* @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.
|
|
55
|
-
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
56
|
-
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
|
|
57
|
-
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
|
|
58
|
-
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
59
|
-
* @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
60
|
-
* @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
|
|
61
|
-
* @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
|
|
62
|
-
* @param {boolean} [isPlayed] Optional filter by items that are played, or not.
|
|
63
|
-
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
64
|
-
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
65
|
-
* @param {Array<string>} [tags] Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
|
|
66
|
-
* @param {Array<number>} [years] Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
|
|
67
|
-
* @param {boolean} [enableUserData] Optional, include user data.
|
|
68
|
-
* @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type.
|
|
69
|
-
* @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
|
|
70
|
-
* @param {string} [person] Optional. If specified, results will be filtered to include only those containing the specified person.
|
|
71
|
-
* @param {Array<string>} [personIds] Optional. If specified, results will be filtered to include only those containing the specified person id.
|
|
72
|
-
* @param {Array<string>} [personTypes] Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.
|
|
73
|
-
* @param {Array<string>} [studios] Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
|
|
74
|
-
* @param {Array<string>} [artists] Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.
|
|
75
|
-
* @param {Array<string>} [excludeArtistIds] Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.
|
|
76
|
-
* @param {Array<string>} [artistIds] Optional. If specified, results will be filtered to include only those containing the specified artist id.
|
|
77
|
-
* @param {Array<string>} [albumArtistIds] Optional. If specified, results will be filtered to include only those containing the specified album artist id.
|
|
78
|
-
* @param {Array<string>} [contributingArtistIds] Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.
|
|
79
|
-
* @param {Array<string>} [albums] Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.
|
|
80
|
-
* @param {Array<string>} [albumIds] Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.
|
|
81
|
-
* @param {Array<string>} [ids] Optional. If specific items are needed, specify a list of item id\'s to retrieve. This allows multiple, comma delimited.
|
|
82
|
-
* @param {Array<VideoType>} [videoTypes] Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.
|
|
83
|
-
* @param {string} [minOfficialRating] Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).
|
|
84
|
-
* @param {boolean} [isLocked] Optional filter by items that are locked.
|
|
85
|
-
* @param {boolean} [isPlaceHolder] Optional filter by items that are placeholders.
|
|
86
|
-
* @param {boolean} [hasOfficialRating] Optional filter by items that have official ratings.
|
|
87
|
-
* @param {boolean} [collapseBoxSetItems] Whether or not to hide items behind their boxsets.
|
|
88
|
-
* @param {number} [minWidth] Optional. Filter by the minimum width of the item.
|
|
89
|
-
* @param {number} [minHeight] Optional. Filter by the minimum height of the item.
|
|
90
|
-
* @param {number} [maxWidth] Optional. Filter by the maximum width of the item.
|
|
91
|
-
* @param {number} [maxHeight] Optional. Filter by the maximum height of the item.
|
|
92
|
-
* @param {boolean} [is3D] Optional filter by items that are 3D, or not.
|
|
93
|
-
* @param {Array<SeriesStatus>} [seriesStatus] Optional filter by Series Status. Allows multiple, comma delimited.
|
|
94
|
-
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
95
|
-
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
96
|
-
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
97
|
-
* @param {Array<string>} [studioIds] Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
|
|
98
|
-
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
99
|
-
* @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count.
|
|
100
|
-
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
101
|
-
* @param {*} [options] Override http request option.
|
|
102
|
-
* @throws {RequiredError}
|
|
103
|
-
*/
|
|
104
|
-
getItems: (userId, maxOfficialRating, hasThemeSong, hasThemeVideo, hasSubtitles, hasSpecialFeature, hasTrailer, adjacentTo, parentIndexNumber, hasParentalRating, isHd, is4K, locationTypes, excludeLocationTypes, isMissing, isUnaired, minCommunityRating, minCriticRating, minPremiereDate, minDateLastSaved, minDateLastSavedForUser, maxPremiereDate, hasOverview, hasImdbId, hasTmdbId, hasTvdbId, isMovie, isSeries, isNews, isKids, isSports, excludeItemIds, startIndex, limit, recursive, searchTerm, sortOrder, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, imageTypes, sortBy, isPlayed, genres, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, artists, excludeArtistIds, artistIds, albumArtistIds, contributingArtistIds, albums, albumIds, ids, videoTypes, minOfficialRating, isLocked, isPlaceHolder, hasOfficialRating, collapseBoxSetItems, minWidth, minHeight, maxWidth, maxHeight, is3D, seriesStatus, nameStartsWithOrGreater, nameStartsWith, nameLessThan, studioIds, genreIds, enableTotalRecordCount, enableImages, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
105
|
-
const localVarPath = `/Items`;
|
|
106
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
107
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
108
|
-
let baseOptions;
|
|
109
|
-
if (configuration) {
|
|
110
|
-
baseOptions = configuration.baseOptions;
|
|
111
|
-
}
|
|
112
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
113
|
-
const localVarHeaderParameter = {};
|
|
114
|
-
const localVarQueryParameter = {};
|
|
115
|
-
// authentication CustomAuthentication required
|
|
116
|
-
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
117
|
-
if (userId !== undefined) {
|
|
118
|
-
localVarQueryParameter['userId'] = userId;
|
|
119
|
-
}
|
|
120
|
-
if (maxOfficialRating !== undefined) {
|
|
121
|
-
localVarQueryParameter['maxOfficialRating'] = maxOfficialRating;
|
|
122
|
-
}
|
|
123
|
-
if (hasThemeSong !== undefined) {
|
|
124
|
-
localVarQueryParameter['hasThemeSong'] = hasThemeSong;
|
|
125
|
-
}
|
|
126
|
-
if (hasThemeVideo !== undefined) {
|
|
127
|
-
localVarQueryParameter['hasThemeVideo'] = hasThemeVideo;
|
|
128
|
-
}
|
|
129
|
-
if (hasSubtitles !== undefined) {
|
|
130
|
-
localVarQueryParameter['hasSubtitles'] = hasSubtitles;
|
|
131
|
-
}
|
|
132
|
-
if (hasSpecialFeature !== undefined) {
|
|
133
|
-
localVarQueryParameter['hasSpecialFeature'] = hasSpecialFeature;
|
|
134
|
-
}
|
|
135
|
-
if (hasTrailer !== undefined) {
|
|
136
|
-
localVarQueryParameter['hasTrailer'] = hasTrailer;
|
|
137
|
-
}
|
|
138
|
-
if (adjacentTo !== undefined) {
|
|
139
|
-
localVarQueryParameter['adjacentTo'] = adjacentTo;
|
|
140
|
-
}
|
|
141
|
-
if (parentIndexNumber !== undefined) {
|
|
142
|
-
localVarQueryParameter['parentIndexNumber'] = parentIndexNumber;
|
|
143
|
-
}
|
|
144
|
-
if (hasParentalRating !== undefined) {
|
|
145
|
-
localVarQueryParameter['hasParentalRating'] = hasParentalRating;
|
|
146
|
-
}
|
|
147
|
-
if (isHd !== undefined) {
|
|
148
|
-
localVarQueryParameter['isHd'] = isHd;
|
|
149
|
-
}
|
|
150
|
-
if (is4K !== undefined) {
|
|
151
|
-
localVarQueryParameter['is4K'] = is4K;
|
|
152
|
-
}
|
|
153
|
-
if (locationTypes) {
|
|
154
|
-
localVarQueryParameter['locationTypes'] = locationTypes;
|
|
155
|
-
}
|
|
156
|
-
if (excludeLocationTypes) {
|
|
157
|
-
localVarQueryParameter['excludeLocationTypes'] = excludeLocationTypes;
|
|
158
|
-
}
|
|
159
|
-
if (isMissing !== undefined) {
|
|
160
|
-
localVarQueryParameter['isMissing'] = isMissing;
|
|
161
|
-
}
|
|
162
|
-
if (isUnaired !== undefined) {
|
|
163
|
-
localVarQueryParameter['isUnaired'] = isUnaired;
|
|
164
|
-
}
|
|
165
|
-
if (minCommunityRating !== undefined) {
|
|
166
|
-
localVarQueryParameter['minCommunityRating'] = minCommunityRating;
|
|
167
|
-
}
|
|
168
|
-
if (minCriticRating !== undefined) {
|
|
169
|
-
localVarQueryParameter['minCriticRating'] = minCriticRating;
|
|
170
|
-
}
|
|
171
|
-
if (minPremiereDate !== undefined) {
|
|
172
|
-
localVarQueryParameter['minPremiereDate'] = (minPremiereDate instanceof Date) ?
|
|
173
|
-
minPremiereDate.toISOString() :
|
|
174
|
-
minPremiereDate;
|
|
175
|
-
}
|
|
176
|
-
if (minDateLastSaved !== undefined) {
|
|
177
|
-
localVarQueryParameter['minDateLastSaved'] = (minDateLastSaved instanceof Date) ?
|
|
178
|
-
minDateLastSaved.toISOString() :
|
|
179
|
-
minDateLastSaved;
|
|
180
|
-
}
|
|
181
|
-
if (minDateLastSavedForUser !== undefined) {
|
|
182
|
-
localVarQueryParameter['minDateLastSavedForUser'] = (minDateLastSavedForUser instanceof Date) ?
|
|
183
|
-
minDateLastSavedForUser.toISOString() :
|
|
184
|
-
minDateLastSavedForUser;
|
|
185
|
-
}
|
|
186
|
-
if (maxPremiereDate !== undefined) {
|
|
187
|
-
localVarQueryParameter['maxPremiereDate'] = (maxPremiereDate instanceof Date) ?
|
|
188
|
-
maxPremiereDate.toISOString() :
|
|
189
|
-
maxPremiereDate;
|
|
190
|
-
}
|
|
191
|
-
if (hasOverview !== undefined) {
|
|
192
|
-
localVarQueryParameter['hasOverview'] = hasOverview;
|
|
193
|
-
}
|
|
194
|
-
if (hasImdbId !== undefined) {
|
|
195
|
-
localVarQueryParameter['hasImdbId'] = hasImdbId;
|
|
196
|
-
}
|
|
197
|
-
if (hasTmdbId !== undefined) {
|
|
198
|
-
localVarQueryParameter['hasTmdbId'] = hasTmdbId;
|
|
199
|
-
}
|
|
200
|
-
if (hasTvdbId !== undefined) {
|
|
201
|
-
localVarQueryParameter['hasTvdbId'] = hasTvdbId;
|
|
202
|
-
}
|
|
203
|
-
if (isMovie !== undefined) {
|
|
204
|
-
localVarQueryParameter['isMovie'] = isMovie;
|
|
205
|
-
}
|
|
206
|
-
if (isSeries !== undefined) {
|
|
207
|
-
localVarQueryParameter['isSeries'] = isSeries;
|
|
208
|
-
}
|
|
209
|
-
if (isNews !== undefined) {
|
|
210
|
-
localVarQueryParameter['isNews'] = isNews;
|
|
211
|
-
}
|
|
212
|
-
if (isKids !== undefined) {
|
|
213
|
-
localVarQueryParameter['isKids'] = isKids;
|
|
214
|
-
}
|
|
215
|
-
if (isSports !== undefined) {
|
|
216
|
-
localVarQueryParameter['isSports'] = isSports;
|
|
217
|
-
}
|
|
218
|
-
if (excludeItemIds) {
|
|
219
|
-
localVarQueryParameter['excludeItemIds'] = excludeItemIds;
|
|
220
|
-
}
|
|
221
|
-
if (startIndex !== undefined) {
|
|
222
|
-
localVarQueryParameter['startIndex'] = startIndex;
|
|
223
|
-
}
|
|
224
|
-
if (limit !== undefined) {
|
|
225
|
-
localVarQueryParameter['limit'] = limit;
|
|
226
|
-
}
|
|
227
|
-
if (recursive !== undefined) {
|
|
228
|
-
localVarQueryParameter['recursive'] = recursive;
|
|
229
|
-
}
|
|
230
|
-
if (searchTerm !== undefined) {
|
|
231
|
-
localVarQueryParameter['searchTerm'] = searchTerm;
|
|
232
|
-
}
|
|
233
|
-
if (sortOrder) {
|
|
234
|
-
localVarQueryParameter['sortOrder'] = sortOrder;
|
|
235
|
-
}
|
|
236
|
-
if (parentId !== undefined) {
|
|
237
|
-
localVarQueryParameter['parentId'] = parentId;
|
|
238
|
-
}
|
|
239
|
-
if (fields) {
|
|
240
|
-
localVarQueryParameter['fields'] = fields;
|
|
241
|
-
}
|
|
242
|
-
if (excludeItemTypes) {
|
|
243
|
-
localVarQueryParameter['excludeItemTypes'] = excludeItemTypes;
|
|
244
|
-
}
|
|
245
|
-
if (includeItemTypes) {
|
|
246
|
-
localVarQueryParameter['includeItemTypes'] = includeItemTypes;
|
|
247
|
-
}
|
|
248
|
-
if (filters) {
|
|
249
|
-
localVarQueryParameter['filters'] = filters;
|
|
250
|
-
}
|
|
251
|
-
if (isFavorite !== undefined) {
|
|
252
|
-
localVarQueryParameter['isFavorite'] = isFavorite;
|
|
253
|
-
}
|
|
254
|
-
if (mediaTypes) {
|
|
255
|
-
localVarQueryParameter['mediaTypes'] = mediaTypes;
|
|
256
|
-
}
|
|
257
|
-
if (imageTypes) {
|
|
258
|
-
localVarQueryParameter['imageTypes'] = imageTypes;
|
|
259
|
-
}
|
|
260
|
-
if (sortBy) {
|
|
261
|
-
localVarQueryParameter['sortBy'] = sortBy;
|
|
262
|
-
}
|
|
263
|
-
if (isPlayed !== undefined) {
|
|
264
|
-
localVarQueryParameter['isPlayed'] = isPlayed;
|
|
265
|
-
}
|
|
266
|
-
if (genres) {
|
|
267
|
-
localVarQueryParameter['genres'] = genres;
|
|
268
|
-
}
|
|
269
|
-
if (officialRatings) {
|
|
270
|
-
localVarQueryParameter['officialRatings'] = officialRatings;
|
|
271
|
-
}
|
|
272
|
-
if (tags) {
|
|
273
|
-
localVarQueryParameter['tags'] = tags;
|
|
274
|
-
}
|
|
275
|
-
if (years) {
|
|
276
|
-
localVarQueryParameter['years'] = years;
|
|
277
|
-
}
|
|
278
|
-
if (enableUserData !== undefined) {
|
|
279
|
-
localVarQueryParameter['enableUserData'] = enableUserData;
|
|
280
|
-
}
|
|
281
|
-
if (imageTypeLimit !== undefined) {
|
|
282
|
-
localVarQueryParameter['imageTypeLimit'] = imageTypeLimit;
|
|
283
|
-
}
|
|
284
|
-
if (enableImageTypes) {
|
|
285
|
-
localVarQueryParameter['enableImageTypes'] = enableImageTypes;
|
|
286
|
-
}
|
|
287
|
-
if (person !== undefined) {
|
|
288
|
-
localVarQueryParameter['person'] = person;
|
|
289
|
-
}
|
|
290
|
-
if (personIds) {
|
|
291
|
-
localVarQueryParameter['personIds'] = personIds;
|
|
292
|
-
}
|
|
293
|
-
if (personTypes) {
|
|
294
|
-
localVarQueryParameter['personTypes'] = personTypes;
|
|
295
|
-
}
|
|
296
|
-
if (studios) {
|
|
297
|
-
localVarQueryParameter['studios'] = studios;
|
|
298
|
-
}
|
|
299
|
-
if (artists) {
|
|
300
|
-
localVarQueryParameter['artists'] = artists;
|
|
301
|
-
}
|
|
302
|
-
if (excludeArtistIds) {
|
|
303
|
-
localVarQueryParameter['excludeArtistIds'] = excludeArtistIds;
|
|
304
|
-
}
|
|
305
|
-
if (artistIds) {
|
|
306
|
-
localVarQueryParameter['artistIds'] = artistIds;
|
|
307
|
-
}
|
|
308
|
-
if (albumArtistIds) {
|
|
309
|
-
localVarQueryParameter['albumArtistIds'] = albumArtistIds;
|
|
310
|
-
}
|
|
311
|
-
if (contributingArtistIds) {
|
|
312
|
-
localVarQueryParameter['contributingArtistIds'] = contributingArtistIds;
|
|
313
|
-
}
|
|
314
|
-
if (albums) {
|
|
315
|
-
localVarQueryParameter['albums'] = albums;
|
|
316
|
-
}
|
|
317
|
-
if (albumIds) {
|
|
318
|
-
localVarQueryParameter['albumIds'] = albumIds;
|
|
319
|
-
}
|
|
320
|
-
if (ids) {
|
|
321
|
-
localVarQueryParameter['ids'] = ids;
|
|
322
|
-
}
|
|
323
|
-
if (videoTypes) {
|
|
324
|
-
localVarQueryParameter['videoTypes'] = videoTypes;
|
|
325
|
-
}
|
|
326
|
-
if (minOfficialRating !== undefined) {
|
|
327
|
-
localVarQueryParameter['minOfficialRating'] = minOfficialRating;
|
|
328
|
-
}
|
|
329
|
-
if (isLocked !== undefined) {
|
|
330
|
-
localVarQueryParameter['isLocked'] = isLocked;
|
|
331
|
-
}
|
|
332
|
-
if (isPlaceHolder !== undefined) {
|
|
333
|
-
localVarQueryParameter['isPlaceHolder'] = isPlaceHolder;
|
|
334
|
-
}
|
|
335
|
-
if (hasOfficialRating !== undefined) {
|
|
336
|
-
localVarQueryParameter['hasOfficialRating'] = hasOfficialRating;
|
|
337
|
-
}
|
|
338
|
-
if (collapseBoxSetItems !== undefined) {
|
|
339
|
-
localVarQueryParameter['collapseBoxSetItems'] = collapseBoxSetItems;
|
|
340
|
-
}
|
|
341
|
-
if (minWidth !== undefined) {
|
|
342
|
-
localVarQueryParameter['minWidth'] = minWidth;
|
|
343
|
-
}
|
|
344
|
-
if (minHeight !== undefined) {
|
|
345
|
-
localVarQueryParameter['minHeight'] = minHeight;
|
|
346
|
-
}
|
|
347
|
-
if (maxWidth !== undefined) {
|
|
348
|
-
localVarQueryParameter['maxWidth'] = maxWidth;
|
|
349
|
-
}
|
|
350
|
-
if (maxHeight !== undefined) {
|
|
351
|
-
localVarQueryParameter['maxHeight'] = maxHeight;
|
|
352
|
-
}
|
|
353
|
-
if (is3D !== undefined) {
|
|
354
|
-
localVarQueryParameter['is3D'] = is3D;
|
|
355
|
-
}
|
|
356
|
-
if (seriesStatus) {
|
|
357
|
-
localVarQueryParameter['seriesStatus'] = seriesStatus;
|
|
358
|
-
}
|
|
359
|
-
if (nameStartsWithOrGreater !== undefined) {
|
|
360
|
-
localVarQueryParameter['nameStartsWithOrGreater'] = nameStartsWithOrGreater;
|
|
361
|
-
}
|
|
362
|
-
if (nameStartsWith !== undefined) {
|
|
363
|
-
localVarQueryParameter['nameStartsWith'] = nameStartsWith;
|
|
364
|
-
}
|
|
365
|
-
if (nameLessThan !== undefined) {
|
|
366
|
-
localVarQueryParameter['nameLessThan'] = nameLessThan;
|
|
367
|
-
}
|
|
368
|
-
if (studioIds) {
|
|
369
|
-
localVarQueryParameter['studioIds'] = studioIds;
|
|
370
|
-
}
|
|
371
|
-
if (genreIds) {
|
|
372
|
-
localVarQueryParameter['genreIds'] = genreIds;
|
|
373
|
-
}
|
|
374
|
-
if (enableTotalRecordCount !== undefined) {
|
|
375
|
-
localVarQueryParameter['enableTotalRecordCount'] = enableTotalRecordCount;
|
|
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
|
+
*/
|
|
17
|
+
/**
|
|
18
|
+
* ItemsApi - axios parameter creator
|
|
19
|
+
* @export
|
|
20
|
+
*/
|
|
21
|
+
const ItemsApiAxiosParamCreator = function (configuration) {
|
|
22
|
+
return {
|
|
23
|
+
/**
|
|
24
|
+
*
|
|
25
|
+
* @summary Get Item User Data.
|
|
26
|
+
* @param {string} itemId The item id.
|
|
27
|
+
* @param {string} [userId] The user id.
|
|
28
|
+
* @param {*} [options] Override http request option.
|
|
29
|
+
* @throws {RequiredError}
|
|
30
|
+
*/
|
|
31
|
+
getItemUserData: async (itemId, userId, options = {}) => {
|
|
32
|
+
// verify required parameter 'itemId' is not null or undefined
|
|
33
|
+
assertParamExists('getItemUserData', 'itemId', itemId);
|
|
34
|
+
const localVarPath = `/UserItems/{itemId}/UserData`
|
|
35
|
+
.replace(`{${"itemId"}}`, encodeURIComponent(String(itemId)));
|
|
36
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
37
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
38
|
+
let baseOptions;
|
|
39
|
+
if (configuration) {
|
|
40
|
+
baseOptions = configuration.baseOptions;
|
|
376
41
|
}
|
|
377
|
-
|
|
378
|
-
|
|
42
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
43
|
+
const localVarHeaderParameter = {};
|
|
44
|
+
const localVarQueryParameter = {};
|
|
45
|
+
// authentication CustomAuthentication required
|
|
46
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
47
|
+
if (userId !== undefined) {
|
|
48
|
+
localVarQueryParameter['userId'] = userId;
|
|
379
49
|
}
|
|
380
50
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
381
51
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
382
|
-
localVarRequestOptions.headers =
|
|
52
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
383
53
|
return {
|
|
384
54
|
url: toPathString(localVarUrlObj),
|
|
385
55
|
options: localVarRequestOptions,
|
|
386
56
|
};
|
|
387
|
-
}
|
|
57
|
+
},
|
|
388
58
|
/**
|
|
389
59
|
*
|
|
390
60
|
* @summary Gets items based on a query.
|
|
391
|
-
* @param {string} userId The user id supplied as query parameter.
|
|
61
|
+
* @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key.
|
|
392
62
|
* @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
|
|
393
63
|
* @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
|
|
394
64
|
* @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
|
|
@@ -411,9 +81,9 @@ const ItemsApiAxiosParamCreator = function (configuration) {
|
|
|
411
81
|
* @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO.
|
|
412
82
|
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO.
|
|
413
83
|
* @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
|
|
414
|
-
* @param {boolean} [hasImdbId] Optional filter by items that have an
|
|
415
|
-
* @param {boolean} [hasTmdbId] Optional filter by items that have a
|
|
416
|
-
* @param {boolean} [hasTvdbId] Optional filter by items that have a
|
|
84
|
+
* @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not.
|
|
85
|
+
* @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not.
|
|
86
|
+
* @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not.
|
|
417
87
|
* @param {boolean} [isMovie] Optional filter for live tv movies.
|
|
418
88
|
* @param {boolean} [isSeries] Optional filter for live tv series.
|
|
419
89
|
* @param {boolean} [isNews] Optional filter for live tv news.
|
|
@@ -424,16 +94,16 @@ const ItemsApiAxiosParamCreator = function (configuration) {
|
|
|
424
94
|
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
425
95
|
* @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
426
96
|
* @param {string} [searchTerm] Optional. Filter based on a search term.
|
|
427
|
-
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
97
|
+
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending, Descending.
|
|
428
98
|
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
429
99
|
* @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.
|
|
430
100
|
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
431
101
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
|
|
432
102
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
|
|
433
103
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
434
|
-
* @param {Array<
|
|
104
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
435
105
|
* @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
|
|
436
|
-
* @param {Array<
|
|
106
|
+
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
|
|
437
107
|
* @param {boolean} [isPlayed] Optional filter by items that are played, or not.
|
|
438
108
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
439
109
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -476,22 +146,22 @@ const ItemsApiAxiosParamCreator = function (configuration) {
|
|
|
476
146
|
* @param {*} [options] Override http request option.
|
|
477
147
|
* @throws {RequiredError}
|
|
478
148
|
*/
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
assertParamExists('getItemsByUserId', 'userId', userId);
|
|
482
|
-
const localVarPath = `/Users/{userId}/Items`
|
|
483
|
-
.replace(`{${"userId"}}`, encodeURIComponent(String(userId)));
|
|
149
|
+
getItems: async (userId, maxOfficialRating, hasThemeSong, hasThemeVideo, hasSubtitles, hasSpecialFeature, hasTrailer, adjacentTo, parentIndexNumber, hasParentalRating, isHd, is4K, locationTypes, excludeLocationTypes, isMissing, isUnaired, minCommunityRating, minCriticRating, minPremiereDate, minDateLastSaved, minDateLastSavedForUser, maxPremiereDate, hasOverview, hasImdbId, hasTmdbId, hasTvdbId, isMovie, isSeries, isNews, isKids, isSports, excludeItemIds, startIndex, limit, recursive, searchTerm, sortOrder, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, imageTypes, sortBy, isPlayed, genres, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, artists, excludeArtistIds, artistIds, albumArtistIds, contributingArtistIds, albums, albumIds, ids, videoTypes, minOfficialRating, isLocked, isPlaceHolder, hasOfficialRating, collapseBoxSetItems, minWidth, minHeight, maxWidth, maxHeight, is3D, seriesStatus, nameStartsWithOrGreater, nameStartsWith, nameLessThan, studioIds, genreIds, enableTotalRecordCount, enableImages, options = {}) => {
|
|
150
|
+
const localVarPath = `/Items`;
|
|
484
151
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
485
152
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
486
153
|
let baseOptions;
|
|
487
154
|
if (configuration) {
|
|
488
155
|
baseOptions = configuration.baseOptions;
|
|
489
156
|
}
|
|
490
|
-
const localVarRequestOptions =
|
|
157
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
491
158
|
const localVarHeaderParameter = {};
|
|
492
159
|
const localVarQueryParameter = {};
|
|
493
160
|
// authentication CustomAuthentication required
|
|
494
|
-
|
|
161
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
162
|
+
if (userId !== undefined) {
|
|
163
|
+
localVarQueryParameter['userId'] = userId;
|
|
164
|
+
}
|
|
495
165
|
if (maxOfficialRating !== undefined) {
|
|
496
166
|
localVarQueryParameter['maxOfficialRating'] = maxOfficialRating;
|
|
497
167
|
}
|
|
@@ -754,22 +424,22 @@ const ItemsApiAxiosParamCreator = function (configuration) {
|
|
|
754
424
|
}
|
|
755
425
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
756
426
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
757
|
-
localVarRequestOptions.headers =
|
|
427
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
758
428
|
return {
|
|
759
429
|
url: toPathString(localVarUrlObj),
|
|
760
430
|
options: localVarRequestOptions,
|
|
761
431
|
};
|
|
762
|
-
}
|
|
432
|
+
},
|
|
763
433
|
/**
|
|
764
434
|
*
|
|
765
435
|
* @summary Gets items based on a query.
|
|
766
|
-
* @param {string} userId The user id.
|
|
436
|
+
* @param {string} [userId] The user id.
|
|
767
437
|
* @param {number} [startIndex] The start index.
|
|
768
438
|
* @param {number} [limit] The item limit.
|
|
769
439
|
* @param {string} [searchTerm] The search term.
|
|
770
440
|
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
771
441
|
* @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.
|
|
772
|
-
* @param {Array<
|
|
442
|
+
* @param {Array<MediaType>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
|
|
773
443
|
* @param {boolean} [enableUserData] Optional. Include user data.
|
|
774
444
|
* @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type.
|
|
775
445
|
* @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
|
|
@@ -781,22 +451,22 @@ const ItemsApiAxiosParamCreator = function (configuration) {
|
|
|
781
451
|
* @param {*} [options] Override http request option.
|
|
782
452
|
* @throws {RequiredError}
|
|
783
453
|
*/
|
|
784
|
-
getResumeItems: (userId, startIndex, limit, searchTerm, parentId, fields, mediaTypes, enableUserData, imageTypeLimit, enableImageTypes, excludeItemTypes, includeItemTypes, enableTotalRecordCount, enableImages, excludeActiveSessions, options = {}) =>
|
|
785
|
-
|
|
786
|
-
assertParamExists('getResumeItems', 'userId', userId);
|
|
787
|
-
const localVarPath = `/Users/{userId}/Items/Resume`
|
|
788
|
-
.replace(`{${"userId"}}`, encodeURIComponent(String(userId)));
|
|
454
|
+
getResumeItems: async (userId, startIndex, limit, searchTerm, parentId, fields, mediaTypes, enableUserData, imageTypeLimit, enableImageTypes, excludeItemTypes, includeItemTypes, enableTotalRecordCount, enableImages, excludeActiveSessions, options = {}) => {
|
|
455
|
+
const localVarPath = `/UserItems/Resume`;
|
|
789
456
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
790
457
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
791
458
|
let baseOptions;
|
|
792
459
|
if (configuration) {
|
|
793
460
|
baseOptions = configuration.baseOptions;
|
|
794
461
|
}
|
|
795
|
-
const localVarRequestOptions =
|
|
462
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
796
463
|
const localVarHeaderParameter = {};
|
|
797
464
|
const localVarQueryParameter = {};
|
|
798
465
|
// authentication CustomAuthentication required
|
|
799
|
-
|
|
466
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
467
|
+
if (userId !== undefined) {
|
|
468
|
+
localVarQueryParameter['userId'] = userId;
|
|
469
|
+
}
|
|
800
470
|
if (startIndex !== undefined) {
|
|
801
471
|
localVarQueryParameter['startIndex'] = startIndex;
|
|
802
472
|
}
|
|
@@ -841,12 +511,52 @@ const ItemsApiAxiosParamCreator = function (configuration) {
|
|
|
841
511
|
}
|
|
842
512
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
843
513
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
844
|
-
localVarRequestOptions.headers =
|
|
514
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
515
|
+
return {
|
|
516
|
+
url: toPathString(localVarUrlObj),
|
|
517
|
+
options: localVarRequestOptions,
|
|
518
|
+
};
|
|
519
|
+
},
|
|
520
|
+
/**
|
|
521
|
+
*
|
|
522
|
+
* @summary Update Item User Data.
|
|
523
|
+
* @param {string} itemId The item id.
|
|
524
|
+
* @param {UpdateUserItemDataDto} updateUserItemDataDto New user data object.
|
|
525
|
+
* @param {string} [userId] The user id.
|
|
526
|
+
* @param {*} [options] Override http request option.
|
|
527
|
+
* @throws {RequiredError}
|
|
528
|
+
*/
|
|
529
|
+
updateItemUserData: async (itemId, updateUserItemDataDto, userId, options = {}) => {
|
|
530
|
+
// verify required parameter 'itemId' is not null or undefined
|
|
531
|
+
assertParamExists('updateItemUserData', 'itemId', itemId);
|
|
532
|
+
// verify required parameter 'updateUserItemDataDto' is not null or undefined
|
|
533
|
+
assertParamExists('updateItemUserData', 'updateUserItemDataDto', updateUserItemDataDto);
|
|
534
|
+
const localVarPath = `/UserItems/{itemId}/UserData`
|
|
535
|
+
.replace(`{${"itemId"}}`, encodeURIComponent(String(itemId)));
|
|
536
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
537
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
538
|
+
let baseOptions;
|
|
539
|
+
if (configuration) {
|
|
540
|
+
baseOptions = configuration.baseOptions;
|
|
541
|
+
}
|
|
542
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
543
|
+
const localVarHeaderParameter = {};
|
|
544
|
+
const localVarQueryParameter = {};
|
|
545
|
+
// authentication CustomAuthentication required
|
|
546
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
547
|
+
if (userId !== undefined) {
|
|
548
|
+
localVarQueryParameter['userId'] = userId;
|
|
549
|
+
}
|
|
550
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
551
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
552
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
553
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
554
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateUserItemDataDto, localVarRequestOptions, configuration);
|
|
845
555
|
return {
|
|
846
556
|
url: toPathString(localVarUrlObj),
|
|
847
557
|
options: localVarRequestOptions,
|
|
848
558
|
};
|
|
849
|
-
}
|
|
559
|
+
},
|
|
850
560
|
};
|
|
851
561
|
};
|
|
852
562
|
/**
|
|
@@ -858,105 +568,20 @@ const ItemsApiFp = function (configuration) {
|
|
|
858
568
|
return {
|
|
859
569
|
/**
|
|
860
570
|
*
|
|
861
|
-
* @summary
|
|
862
|
-
* @param {string}
|
|
863
|
-
* @param {string} [
|
|
864
|
-
* @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
|
|
865
|
-
* @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
|
|
866
|
-
* @param {boolean} [hasSubtitles] Optional filter by items with subtitles.
|
|
867
|
-
* @param {boolean} [hasSpecialFeature] Optional filter by items with special features.
|
|
868
|
-
* @param {boolean} [hasTrailer] Optional filter by items with trailers.
|
|
869
|
-
* @param {string} [adjacentTo] Optional. Return items that are siblings of a supplied item.
|
|
870
|
-
* @param {number} [parentIndexNumber] Optional filter by parent index number.
|
|
871
|
-
* @param {boolean} [hasParentalRating] Optional filter by items that have or do not have a parental rating.
|
|
872
|
-
* @param {boolean} [isHd] Optional filter by items that are HD or not.
|
|
873
|
-
* @param {boolean} [is4K] Optional filter by items that are 4K or not.
|
|
874
|
-
* @param {Array<LocationType>} [locationTypes] Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.
|
|
875
|
-
* @param {Array<LocationType>} [excludeLocationTypes] Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.
|
|
876
|
-
* @param {boolean} [isMissing] Optional filter by items that are missing episodes or not.
|
|
877
|
-
* @param {boolean} [isUnaired] Optional filter by items that are unaired episodes or not.
|
|
878
|
-
* @param {number} [minCommunityRating] Optional filter by minimum community rating.
|
|
879
|
-
* @param {number} [minCriticRating] Optional filter by minimum critic rating.
|
|
880
|
-
* @param {string} [minPremiereDate] Optional. The minimum premiere date. Format = ISO.
|
|
881
|
-
* @param {string} [minDateLastSaved] Optional. The minimum last saved date. Format = ISO.
|
|
882
|
-
* @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO.
|
|
883
|
-
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO.
|
|
884
|
-
* @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
|
|
885
|
-
* @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
|
|
886
|
-
* @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
|
|
887
|
-
* @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
|
|
888
|
-
* @param {boolean} [isMovie] Optional filter for live tv movies.
|
|
889
|
-
* @param {boolean} [isSeries] Optional filter for live tv series.
|
|
890
|
-
* @param {boolean} [isNews] Optional filter for live tv news.
|
|
891
|
-
* @param {boolean} [isKids] Optional filter for live tv kids.
|
|
892
|
-
* @param {boolean} [isSports] Optional filter for live tv sports.
|
|
893
|
-
* @param {Array<string>} [excludeItemIds] Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.
|
|
894
|
-
* @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
|
|
895
|
-
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
896
|
-
* @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
897
|
-
* @param {string} [searchTerm] Optional. Filter based on a search term.
|
|
898
|
-
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
899
|
-
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
900
|
-
* @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.
|
|
901
|
-
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
902
|
-
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
|
|
903
|
-
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
|
|
904
|
-
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
905
|
-
* @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
906
|
-
* @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
|
|
907
|
-
* @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
|
|
908
|
-
* @param {boolean} [isPlayed] Optional filter by items that are played, or not.
|
|
909
|
-
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
910
|
-
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
911
|
-
* @param {Array<string>} [tags] Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
|
|
912
|
-
* @param {Array<number>} [years] Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
|
|
913
|
-
* @param {boolean} [enableUserData] Optional, include user data.
|
|
914
|
-
* @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type.
|
|
915
|
-
* @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
|
|
916
|
-
* @param {string} [person] Optional. If specified, results will be filtered to include only those containing the specified person.
|
|
917
|
-
* @param {Array<string>} [personIds] Optional. If specified, results will be filtered to include only those containing the specified person id.
|
|
918
|
-
* @param {Array<string>} [personTypes] Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.
|
|
919
|
-
* @param {Array<string>} [studios] Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
|
|
920
|
-
* @param {Array<string>} [artists] Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.
|
|
921
|
-
* @param {Array<string>} [excludeArtistIds] Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.
|
|
922
|
-
* @param {Array<string>} [artistIds] Optional. If specified, results will be filtered to include only those containing the specified artist id.
|
|
923
|
-
* @param {Array<string>} [albumArtistIds] Optional. If specified, results will be filtered to include only those containing the specified album artist id.
|
|
924
|
-
* @param {Array<string>} [contributingArtistIds] Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.
|
|
925
|
-
* @param {Array<string>} [albums] Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.
|
|
926
|
-
* @param {Array<string>} [albumIds] Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.
|
|
927
|
-
* @param {Array<string>} [ids] Optional. If specific items are needed, specify a list of item id\'s to retrieve. This allows multiple, comma delimited.
|
|
928
|
-
* @param {Array<VideoType>} [videoTypes] Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.
|
|
929
|
-
* @param {string} [minOfficialRating] Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).
|
|
930
|
-
* @param {boolean} [isLocked] Optional filter by items that are locked.
|
|
931
|
-
* @param {boolean} [isPlaceHolder] Optional filter by items that are placeholders.
|
|
932
|
-
* @param {boolean} [hasOfficialRating] Optional filter by items that have official ratings.
|
|
933
|
-
* @param {boolean} [collapseBoxSetItems] Whether or not to hide items behind their boxsets.
|
|
934
|
-
* @param {number} [minWidth] Optional. Filter by the minimum width of the item.
|
|
935
|
-
* @param {number} [minHeight] Optional. Filter by the minimum height of the item.
|
|
936
|
-
* @param {number} [maxWidth] Optional. Filter by the maximum width of the item.
|
|
937
|
-
* @param {number} [maxHeight] Optional. Filter by the maximum height of the item.
|
|
938
|
-
* @param {boolean} [is3D] Optional filter by items that are 3D, or not.
|
|
939
|
-
* @param {Array<SeriesStatus>} [seriesStatus] Optional filter by Series Status. Allows multiple, comma delimited.
|
|
940
|
-
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
941
|
-
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
942
|
-
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
943
|
-
* @param {Array<string>} [studioIds] Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
|
|
944
|
-
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
945
|
-
* @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count.
|
|
946
|
-
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
571
|
+
* @summary Get Item User Data.
|
|
572
|
+
* @param {string} itemId The item id.
|
|
573
|
+
* @param {string} [userId] The user id.
|
|
947
574
|
* @param {*} [options] Override http request option.
|
|
948
575
|
* @throws {RequiredError}
|
|
949
576
|
*/
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
|
|
953
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
954
|
-
});
|
|
577
|
+
async getItemUserData(itemId, userId, options) {
|
|
578
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getItemUserData(itemId, userId, options);
|
|
579
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
955
580
|
},
|
|
956
581
|
/**
|
|
957
582
|
*
|
|
958
583
|
* @summary Gets items based on a query.
|
|
959
|
-
* @param {string} userId The user id supplied as query parameter.
|
|
584
|
+
* @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key.
|
|
960
585
|
* @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
|
|
961
586
|
* @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
|
|
962
587
|
* @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
|
|
@@ -979,9 +604,9 @@ const ItemsApiFp = function (configuration) {
|
|
|
979
604
|
* @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO.
|
|
980
605
|
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO.
|
|
981
606
|
* @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
|
|
982
|
-
* @param {boolean} [hasImdbId] Optional filter by items that have an
|
|
983
|
-
* @param {boolean} [hasTmdbId] Optional filter by items that have a
|
|
984
|
-
* @param {boolean} [hasTvdbId] Optional filter by items that have a
|
|
607
|
+
* @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not.
|
|
608
|
+
* @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not.
|
|
609
|
+
* @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not.
|
|
985
610
|
* @param {boolean} [isMovie] Optional filter for live tv movies.
|
|
986
611
|
* @param {boolean} [isSeries] Optional filter for live tv series.
|
|
987
612
|
* @param {boolean} [isNews] Optional filter for live tv news.
|
|
@@ -992,16 +617,16 @@ const ItemsApiFp = function (configuration) {
|
|
|
992
617
|
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
993
618
|
* @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
994
619
|
* @param {string} [searchTerm] Optional. Filter based on a search term.
|
|
995
|
-
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
620
|
+
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending, Descending.
|
|
996
621
|
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
997
622
|
* @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.
|
|
998
623
|
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
999
624
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
|
|
1000
625
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
|
|
1001
626
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
1002
|
-
* @param {Array<
|
|
627
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
1003
628
|
* @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
|
|
1004
|
-
* @param {Array<
|
|
629
|
+
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
|
|
1005
630
|
* @param {boolean} [isPlayed] Optional filter by items that are played, or not.
|
|
1006
631
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
1007
632
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -1044,22 +669,20 @@ const ItemsApiFp = function (configuration) {
|
|
|
1044
669
|
* @param {*} [options] Override http request option.
|
|
1045
670
|
* @throws {RequiredError}
|
|
1046
671
|
*/
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1051
|
-
});
|
|
672
|
+
async getItems(userId, maxOfficialRating, hasThemeSong, hasThemeVideo, hasSubtitles, hasSpecialFeature, hasTrailer, adjacentTo, parentIndexNumber, hasParentalRating, isHd, is4K, locationTypes, excludeLocationTypes, isMissing, isUnaired, minCommunityRating, minCriticRating, minPremiereDate, minDateLastSaved, minDateLastSavedForUser, maxPremiereDate, hasOverview, hasImdbId, hasTmdbId, hasTvdbId, isMovie, isSeries, isNews, isKids, isSports, excludeItemIds, startIndex, limit, recursive, searchTerm, sortOrder, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, imageTypes, sortBy, isPlayed, genres, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, artists, excludeArtistIds, artistIds, albumArtistIds, contributingArtistIds, albums, albumIds, ids, videoTypes, minOfficialRating, isLocked, isPlaceHolder, hasOfficialRating, collapseBoxSetItems, minWidth, minHeight, maxWidth, maxHeight, is3D, seriesStatus, nameStartsWithOrGreater, nameStartsWith, nameLessThan, studioIds, genreIds, enableTotalRecordCount, enableImages, options) {
|
|
673
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getItems(userId, maxOfficialRating, hasThemeSong, hasThemeVideo, hasSubtitles, hasSpecialFeature, hasTrailer, adjacentTo, parentIndexNumber, hasParentalRating, isHd, is4K, locationTypes, excludeLocationTypes, isMissing, isUnaired, minCommunityRating, minCriticRating, minPremiereDate, minDateLastSaved, minDateLastSavedForUser, maxPremiereDate, hasOverview, hasImdbId, hasTmdbId, hasTvdbId, isMovie, isSeries, isNews, isKids, isSports, excludeItemIds, startIndex, limit, recursive, searchTerm, sortOrder, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, imageTypes, sortBy, isPlayed, genres, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, artists, excludeArtistIds, artistIds, albumArtistIds, contributingArtistIds, albums, albumIds, ids, videoTypes, minOfficialRating, isLocked, isPlaceHolder, hasOfficialRating, collapseBoxSetItems, minWidth, minHeight, maxWidth, maxHeight, is3D, seriesStatus, nameStartsWithOrGreater, nameStartsWith, nameLessThan, studioIds, genreIds, enableTotalRecordCount, enableImages, options);
|
|
674
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1052
675
|
},
|
|
1053
676
|
/**
|
|
1054
677
|
*
|
|
1055
678
|
* @summary Gets items based on a query.
|
|
1056
|
-
* @param {string} userId The user id.
|
|
679
|
+
* @param {string} [userId] The user id.
|
|
1057
680
|
* @param {number} [startIndex] The start index.
|
|
1058
681
|
* @param {number} [limit] The item limit.
|
|
1059
682
|
* @param {string} [searchTerm] The search term.
|
|
1060
683
|
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
1061
684
|
* @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.
|
|
1062
|
-
* @param {Array<
|
|
685
|
+
* @param {Array<MediaType>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
|
|
1063
686
|
* @param {boolean} [enableUserData] Optional. Include user data.
|
|
1064
687
|
* @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type.
|
|
1065
688
|
* @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
|
|
@@ -1071,11 +694,22 @@ const ItemsApiFp = function (configuration) {
|
|
|
1071
694
|
* @param {*} [options] Override http request option.
|
|
1072
695
|
* @throws {RequiredError}
|
|
1073
696
|
*/
|
|
1074
|
-
getResumeItems(userId, startIndex, limit, searchTerm, parentId, fields, mediaTypes, enableUserData, imageTypeLimit, enableImageTypes, excludeItemTypes, includeItemTypes, enableTotalRecordCount, enableImages, excludeActiveSessions, options) {
|
|
1075
|
-
|
|
1076
|
-
|
|
1077
|
-
|
|
1078
|
-
|
|
697
|
+
async getResumeItems(userId, startIndex, limit, searchTerm, parentId, fields, mediaTypes, enableUserData, imageTypeLimit, enableImageTypes, excludeItemTypes, includeItemTypes, enableTotalRecordCount, enableImages, excludeActiveSessions, options) {
|
|
698
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getResumeItems(userId, startIndex, limit, searchTerm, parentId, fields, mediaTypes, enableUserData, imageTypeLimit, enableImageTypes, excludeItemTypes, includeItemTypes, enableTotalRecordCount, enableImages, excludeActiveSessions, options);
|
|
699
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
700
|
+
},
|
|
701
|
+
/**
|
|
702
|
+
*
|
|
703
|
+
* @summary Update Item User Data.
|
|
704
|
+
* @param {string} itemId The item id.
|
|
705
|
+
* @param {UpdateUserItemDataDto} updateUserItemDataDto New user data object.
|
|
706
|
+
* @param {string} [userId] The user id.
|
|
707
|
+
* @param {*} [options] Override http request option.
|
|
708
|
+
* @throws {RequiredError}
|
|
709
|
+
*/
|
|
710
|
+
async updateItemUserData(itemId, updateUserItemDataDto, userId, options) {
|
|
711
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateItemUserData(itemId, updateUserItemDataDto, userId, options);
|
|
712
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1079
713
|
},
|
|
1080
714
|
};
|
|
1081
715
|
};
|
|
@@ -1088,102 +722,19 @@ const ItemsApiFactory = function (configuration, basePath, axios) {
|
|
|
1088
722
|
return {
|
|
1089
723
|
/**
|
|
1090
724
|
*
|
|
1091
|
-
* @summary
|
|
1092
|
-
* @param {string}
|
|
1093
|
-
* @param {string} [
|
|
1094
|
-
* @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
|
|
1095
|
-
* @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
|
|
1096
|
-
* @param {boolean} [hasSubtitles] Optional filter by items with subtitles.
|
|
1097
|
-
* @param {boolean} [hasSpecialFeature] Optional filter by items with special features.
|
|
1098
|
-
* @param {boolean} [hasTrailer] Optional filter by items with trailers.
|
|
1099
|
-
* @param {string} [adjacentTo] Optional. Return items that are siblings of a supplied item.
|
|
1100
|
-
* @param {number} [parentIndexNumber] Optional filter by parent index number.
|
|
1101
|
-
* @param {boolean} [hasParentalRating] Optional filter by items that have or do not have a parental rating.
|
|
1102
|
-
* @param {boolean} [isHd] Optional filter by items that are HD or not.
|
|
1103
|
-
* @param {boolean} [is4K] Optional filter by items that are 4K or not.
|
|
1104
|
-
* @param {Array<LocationType>} [locationTypes] Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.
|
|
1105
|
-
* @param {Array<LocationType>} [excludeLocationTypes] Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.
|
|
1106
|
-
* @param {boolean} [isMissing] Optional filter by items that are missing episodes or not.
|
|
1107
|
-
* @param {boolean} [isUnaired] Optional filter by items that are unaired episodes or not.
|
|
1108
|
-
* @param {number} [minCommunityRating] Optional filter by minimum community rating.
|
|
1109
|
-
* @param {number} [minCriticRating] Optional filter by minimum critic rating.
|
|
1110
|
-
* @param {string} [minPremiereDate] Optional. The minimum premiere date. Format = ISO.
|
|
1111
|
-
* @param {string} [minDateLastSaved] Optional. The minimum last saved date. Format = ISO.
|
|
1112
|
-
* @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO.
|
|
1113
|
-
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO.
|
|
1114
|
-
* @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
|
|
1115
|
-
* @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
|
|
1116
|
-
* @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
|
|
1117
|
-
* @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
|
|
1118
|
-
* @param {boolean} [isMovie] Optional filter for live tv movies.
|
|
1119
|
-
* @param {boolean} [isSeries] Optional filter for live tv series.
|
|
1120
|
-
* @param {boolean} [isNews] Optional filter for live tv news.
|
|
1121
|
-
* @param {boolean} [isKids] Optional filter for live tv kids.
|
|
1122
|
-
* @param {boolean} [isSports] Optional filter for live tv sports.
|
|
1123
|
-
* @param {Array<string>} [excludeItemIds] Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.
|
|
1124
|
-
* @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
|
|
1125
|
-
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
1126
|
-
* @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
1127
|
-
* @param {string} [searchTerm] Optional. Filter based on a search term.
|
|
1128
|
-
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
1129
|
-
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
1130
|
-
* @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.
|
|
1131
|
-
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
1132
|
-
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
|
|
1133
|
-
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
|
|
1134
|
-
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
1135
|
-
* @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
1136
|
-
* @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
|
|
1137
|
-
* @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
|
|
1138
|
-
* @param {boolean} [isPlayed] Optional filter by items that are played, or not.
|
|
1139
|
-
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
1140
|
-
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
1141
|
-
* @param {Array<string>} [tags] Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
|
|
1142
|
-
* @param {Array<number>} [years] Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
|
|
1143
|
-
* @param {boolean} [enableUserData] Optional, include user data.
|
|
1144
|
-
* @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type.
|
|
1145
|
-
* @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
|
|
1146
|
-
* @param {string} [person] Optional. If specified, results will be filtered to include only those containing the specified person.
|
|
1147
|
-
* @param {Array<string>} [personIds] Optional. If specified, results will be filtered to include only those containing the specified person id.
|
|
1148
|
-
* @param {Array<string>} [personTypes] Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.
|
|
1149
|
-
* @param {Array<string>} [studios] Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
|
|
1150
|
-
* @param {Array<string>} [artists] Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.
|
|
1151
|
-
* @param {Array<string>} [excludeArtistIds] Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.
|
|
1152
|
-
* @param {Array<string>} [artistIds] Optional. If specified, results will be filtered to include only those containing the specified artist id.
|
|
1153
|
-
* @param {Array<string>} [albumArtistIds] Optional. If specified, results will be filtered to include only those containing the specified album artist id.
|
|
1154
|
-
* @param {Array<string>} [contributingArtistIds] Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.
|
|
1155
|
-
* @param {Array<string>} [albums] Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.
|
|
1156
|
-
* @param {Array<string>} [albumIds] Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.
|
|
1157
|
-
* @param {Array<string>} [ids] Optional. If specific items are needed, specify a list of item id\'s to retrieve. This allows multiple, comma delimited.
|
|
1158
|
-
* @param {Array<VideoType>} [videoTypes] Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.
|
|
1159
|
-
* @param {string} [minOfficialRating] Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).
|
|
1160
|
-
* @param {boolean} [isLocked] Optional filter by items that are locked.
|
|
1161
|
-
* @param {boolean} [isPlaceHolder] Optional filter by items that are placeholders.
|
|
1162
|
-
* @param {boolean} [hasOfficialRating] Optional filter by items that have official ratings.
|
|
1163
|
-
* @param {boolean} [collapseBoxSetItems] Whether or not to hide items behind their boxsets.
|
|
1164
|
-
* @param {number} [minWidth] Optional. Filter by the minimum width of the item.
|
|
1165
|
-
* @param {number} [minHeight] Optional. Filter by the minimum height of the item.
|
|
1166
|
-
* @param {number} [maxWidth] Optional. Filter by the maximum width of the item.
|
|
1167
|
-
* @param {number} [maxHeight] Optional. Filter by the maximum height of the item.
|
|
1168
|
-
* @param {boolean} [is3D] Optional filter by items that are 3D, or not.
|
|
1169
|
-
* @param {Array<SeriesStatus>} [seriesStatus] Optional filter by Series Status. Allows multiple, comma delimited.
|
|
1170
|
-
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
1171
|
-
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
1172
|
-
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
1173
|
-
* @param {Array<string>} [studioIds] Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
|
|
1174
|
-
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
1175
|
-
* @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count.
|
|
1176
|
-
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
725
|
+
* @summary Get Item User Data.
|
|
726
|
+
* @param {string} itemId The item id.
|
|
727
|
+
* @param {string} [userId] The user id.
|
|
1177
728
|
* @param {*} [options] Override http request option.
|
|
1178
729
|
* @throws {RequiredError}
|
|
1179
730
|
*/
|
|
1180
|
-
|
|
1181
|
-
return localVarFp.
|
|
731
|
+
getItemUserData(itemId, userId, options) {
|
|
732
|
+
return localVarFp.getItemUserData(itemId, userId, options).then((request) => request(axios, basePath));
|
|
1182
733
|
},
|
|
1183
734
|
/**
|
|
1184
735
|
*
|
|
1185
736
|
* @summary Gets items based on a query.
|
|
1186
|
-
* @param {string} userId The user id supplied as query parameter.
|
|
737
|
+
* @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key.
|
|
1187
738
|
* @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
|
|
1188
739
|
* @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
|
|
1189
740
|
* @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
|
|
@@ -1206,9 +757,9 @@ const ItemsApiFactory = function (configuration, basePath, axios) {
|
|
|
1206
757
|
* @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO.
|
|
1207
758
|
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO.
|
|
1208
759
|
* @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
|
|
1209
|
-
* @param {boolean} [hasImdbId] Optional filter by items that have an
|
|
1210
|
-
* @param {boolean} [hasTmdbId] Optional filter by items that have a
|
|
1211
|
-
* @param {boolean} [hasTvdbId] Optional filter by items that have a
|
|
760
|
+
* @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not.
|
|
761
|
+
* @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not.
|
|
762
|
+
* @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not.
|
|
1212
763
|
* @param {boolean} [isMovie] Optional filter for live tv movies.
|
|
1213
764
|
* @param {boolean} [isSeries] Optional filter for live tv series.
|
|
1214
765
|
* @param {boolean} [isNews] Optional filter for live tv news.
|
|
@@ -1219,16 +770,16 @@ const ItemsApiFactory = function (configuration, basePath, axios) {
|
|
|
1219
770
|
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
1220
771
|
* @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
1221
772
|
* @param {string} [searchTerm] Optional. Filter based on a search term.
|
|
1222
|
-
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
773
|
+
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending, Descending.
|
|
1223
774
|
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
1224
775
|
* @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.
|
|
1225
776
|
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
1226
777
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
|
|
1227
778
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
|
|
1228
779
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
1229
|
-
* @param {Array<
|
|
780
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
1230
781
|
* @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
|
|
1231
|
-
* @param {Array<
|
|
782
|
+
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
|
|
1232
783
|
* @param {boolean} [isPlayed] Optional filter by items that are played, or not.
|
|
1233
784
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
1234
785
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -1271,19 +822,19 @@ const ItemsApiFactory = function (configuration, basePath, axios) {
|
|
|
1271
822
|
* @param {*} [options] Override http request option.
|
|
1272
823
|
* @throws {RequiredError}
|
|
1273
824
|
*/
|
|
1274
|
-
|
|
1275
|
-
return localVarFp.
|
|
825
|
+
getItems(userId, maxOfficialRating, hasThemeSong, hasThemeVideo, hasSubtitles, hasSpecialFeature, hasTrailer, adjacentTo, parentIndexNumber, hasParentalRating, isHd, is4K, locationTypes, excludeLocationTypes, isMissing, isUnaired, minCommunityRating, minCriticRating, minPremiereDate, minDateLastSaved, minDateLastSavedForUser, maxPremiereDate, hasOverview, hasImdbId, hasTmdbId, hasTvdbId, isMovie, isSeries, isNews, isKids, isSports, excludeItemIds, startIndex, limit, recursive, searchTerm, sortOrder, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, imageTypes, sortBy, isPlayed, genres, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, artists, excludeArtistIds, artistIds, albumArtistIds, contributingArtistIds, albums, albumIds, ids, videoTypes, minOfficialRating, isLocked, isPlaceHolder, hasOfficialRating, collapseBoxSetItems, minWidth, minHeight, maxWidth, maxHeight, is3D, seriesStatus, nameStartsWithOrGreater, nameStartsWith, nameLessThan, studioIds, genreIds, enableTotalRecordCount, enableImages, options) {
|
|
826
|
+
return localVarFp.getItems(userId, maxOfficialRating, hasThemeSong, hasThemeVideo, hasSubtitles, hasSpecialFeature, hasTrailer, adjacentTo, parentIndexNumber, hasParentalRating, isHd, is4K, locationTypes, excludeLocationTypes, isMissing, isUnaired, minCommunityRating, minCriticRating, minPremiereDate, minDateLastSaved, minDateLastSavedForUser, maxPremiereDate, hasOverview, hasImdbId, hasTmdbId, hasTvdbId, isMovie, isSeries, isNews, isKids, isSports, excludeItemIds, startIndex, limit, recursive, searchTerm, sortOrder, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, imageTypes, sortBy, isPlayed, genres, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, artists, excludeArtistIds, artistIds, albumArtistIds, contributingArtistIds, albums, albumIds, ids, videoTypes, minOfficialRating, isLocked, isPlaceHolder, hasOfficialRating, collapseBoxSetItems, minWidth, minHeight, maxWidth, maxHeight, is3D, seriesStatus, nameStartsWithOrGreater, nameStartsWith, nameLessThan, studioIds, genreIds, enableTotalRecordCount, enableImages, options).then((request) => request(axios, basePath));
|
|
1276
827
|
},
|
|
1277
828
|
/**
|
|
1278
829
|
*
|
|
1279
830
|
* @summary Gets items based on a query.
|
|
1280
|
-
* @param {string} userId The user id.
|
|
831
|
+
* @param {string} [userId] The user id.
|
|
1281
832
|
* @param {number} [startIndex] The start index.
|
|
1282
833
|
* @param {number} [limit] The item limit.
|
|
1283
834
|
* @param {string} [searchTerm] The search term.
|
|
1284
835
|
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
1285
836
|
* @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.
|
|
1286
|
-
* @param {Array<
|
|
837
|
+
* @param {Array<MediaType>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
|
|
1287
838
|
* @param {boolean} [enableUserData] Optional. Include user data.
|
|
1288
839
|
* @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type.
|
|
1289
840
|
* @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
|
|
@@ -1298,6 +849,18 @@ const ItemsApiFactory = function (configuration, basePath, axios) {
|
|
|
1298
849
|
getResumeItems(userId, startIndex, limit, searchTerm, parentId, fields, mediaTypes, enableUserData, imageTypeLimit, enableImageTypes, excludeItemTypes, includeItemTypes, enableTotalRecordCount, enableImages, excludeActiveSessions, options) {
|
|
1299
850
|
return localVarFp.getResumeItems(userId, startIndex, limit, searchTerm, parentId, fields, mediaTypes, enableUserData, imageTypeLimit, enableImageTypes, excludeItemTypes, includeItemTypes, enableTotalRecordCount, enableImages, excludeActiveSessions, options).then((request) => request(axios, basePath));
|
|
1300
851
|
},
|
|
852
|
+
/**
|
|
853
|
+
*
|
|
854
|
+
* @summary Update Item User Data.
|
|
855
|
+
* @param {string} itemId The item id.
|
|
856
|
+
* @param {UpdateUserItemDataDto} updateUserItemDataDto New user data object.
|
|
857
|
+
* @param {string} [userId] The user id.
|
|
858
|
+
* @param {*} [options] Override http request option.
|
|
859
|
+
* @throws {RequiredError}
|
|
860
|
+
*/
|
|
861
|
+
updateItemUserData(itemId, updateUserItemDataDto, userId, options) {
|
|
862
|
+
return localVarFp.updateItemUserData(itemId, updateUserItemDataDto, userId, options).then((request) => request(axios, basePath));
|
|
863
|
+
},
|
|
1301
864
|
};
|
|
1302
865
|
};
|
|
1303
866
|
/**
|
|
@@ -1307,6 +870,17 @@ const ItemsApiFactory = function (configuration, basePath, axios) {
|
|
|
1307
870
|
* @extends {BaseAPI}
|
|
1308
871
|
*/
|
|
1309
872
|
class ItemsApi extends BaseAPI {
|
|
873
|
+
/**
|
|
874
|
+
*
|
|
875
|
+
* @summary Get Item User Data.
|
|
876
|
+
* @param {ItemsApiGetItemUserDataRequest} requestParameters Request parameters.
|
|
877
|
+
* @param {*} [options] Override http request option.
|
|
878
|
+
* @throws {RequiredError}
|
|
879
|
+
* @memberof ItemsApi
|
|
880
|
+
*/
|
|
881
|
+
getItemUserData(requestParameters, options) {
|
|
882
|
+
return ItemsApiFp(this.configuration).getItemUserData(requestParameters.itemId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
|
|
883
|
+
}
|
|
1310
884
|
/**
|
|
1311
885
|
*
|
|
1312
886
|
* @summary Gets items based on a query.
|
|
@@ -1321,24 +895,24 @@ class ItemsApi extends BaseAPI {
|
|
|
1321
895
|
/**
|
|
1322
896
|
*
|
|
1323
897
|
* @summary Gets items based on a query.
|
|
1324
|
-
* @param {
|
|
898
|
+
* @param {ItemsApiGetResumeItemsRequest} requestParameters Request parameters.
|
|
1325
899
|
* @param {*} [options] Override http request option.
|
|
1326
900
|
* @throws {RequiredError}
|
|
1327
901
|
* @memberof ItemsApi
|
|
1328
902
|
*/
|
|
1329
|
-
|
|
1330
|
-
return ItemsApiFp(this.configuration).
|
|
903
|
+
getResumeItems(requestParameters = {}, options) {
|
|
904
|
+
return ItemsApiFp(this.configuration).getResumeItems(requestParameters.userId, requestParameters.startIndex, requestParameters.limit, requestParameters.searchTerm, requestParameters.parentId, requestParameters.fields, requestParameters.mediaTypes, requestParameters.enableUserData, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, requestParameters.excludeItemTypes, requestParameters.includeItemTypes, requestParameters.enableTotalRecordCount, requestParameters.enableImages, requestParameters.excludeActiveSessions, options).then((request) => request(this.axios, this.basePath));
|
|
1331
905
|
}
|
|
1332
906
|
/**
|
|
1333
907
|
*
|
|
1334
|
-
* @summary
|
|
1335
|
-
* @param {
|
|
908
|
+
* @summary Update Item User Data.
|
|
909
|
+
* @param {ItemsApiUpdateItemUserDataRequest} requestParameters Request parameters.
|
|
1336
910
|
* @param {*} [options] Override http request option.
|
|
1337
911
|
* @throws {RequiredError}
|
|
1338
912
|
* @memberof ItemsApi
|
|
1339
913
|
*/
|
|
1340
|
-
|
|
1341
|
-
return ItemsApiFp(this.configuration).
|
|
914
|
+
updateItemUserData(requestParameters, options) {
|
|
915
|
+
return ItemsApiFp(this.configuration).updateItemUserData(requestParameters.itemId, requestParameters.updateUserItemDataDto, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
|
|
1342
916
|
}
|
|
1343
917
|
}
|
|
1344
918
|
|