@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
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3
|
+
* Do not edit the class manually.
|
|
4
|
+
*
|
|
5
|
+
* Jellyfin API
|
|
6
|
+
*
|
|
7
|
+
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
8
|
+
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
9
|
+
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
10
|
+
*/
|
|
11
|
+
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
12
|
+
import { Configuration } from '../configuration';
|
|
13
|
+
import { RequestArgs, BaseAPI } from '../base';
|
|
14
|
+
/**
|
|
15
|
+
* TrickplayApi - axios parameter creator
|
|
16
|
+
* @export
|
|
17
|
+
*/
|
|
18
|
+
export declare const TrickplayApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @summary Gets an image tiles playlist for trickplay.
|
|
22
|
+
* @param {string} itemId The item id.
|
|
23
|
+
* @param {number} width The width of a single tile.
|
|
24
|
+
* @param {string} [mediaSourceId] The media version id, if using an alternate version.
|
|
25
|
+
* @param {*} [options] Override http request option.
|
|
26
|
+
* @throws {RequiredError}
|
|
27
|
+
*/
|
|
28
|
+
getTrickplayHlsPlaylist: (itemId: string, width: number, mediaSourceId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
29
|
+
/**
|
|
30
|
+
*
|
|
31
|
+
* @summary Gets a trickplay tile image.
|
|
32
|
+
* @param {string} itemId The item id.
|
|
33
|
+
* @param {number} width The width of a single tile.
|
|
34
|
+
* @param {number} index The index of the desired tile.
|
|
35
|
+
* @param {string} [mediaSourceId] The media version id, if using an alternate version.
|
|
36
|
+
* @param {*} [options] Override http request option.
|
|
37
|
+
* @throws {RequiredError}
|
|
38
|
+
*/
|
|
39
|
+
getTrickplayTileImage: (itemId: string, width: number, index: number, mediaSourceId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
40
|
+
};
|
|
41
|
+
/**
|
|
42
|
+
* TrickplayApi - functional programming interface
|
|
43
|
+
* @export
|
|
44
|
+
*/
|
|
45
|
+
export declare const TrickplayApiFp: (configuration?: Configuration) => {
|
|
46
|
+
/**
|
|
47
|
+
*
|
|
48
|
+
* @summary Gets an image tiles playlist for trickplay.
|
|
49
|
+
* @param {string} itemId The item id.
|
|
50
|
+
* @param {number} width The width of a single tile.
|
|
51
|
+
* @param {string} [mediaSourceId] The media version id, if using an alternate version.
|
|
52
|
+
* @param {*} [options] Override http request option.
|
|
53
|
+
* @throws {RequiredError}
|
|
54
|
+
*/
|
|
55
|
+
getTrickplayHlsPlaylist(itemId: string, width: number, mediaSourceId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
56
|
+
/**
|
|
57
|
+
*
|
|
58
|
+
* @summary Gets a trickplay tile image.
|
|
59
|
+
* @param {string} itemId The item id.
|
|
60
|
+
* @param {number} width The width of a single tile.
|
|
61
|
+
* @param {number} index The index of the desired tile.
|
|
62
|
+
* @param {string} [mediaSourceId] The media version id, if using an alternate version.
|
|
63
|
+
* @param {*} [options] Override http request option.
|
|
64
|
+
* @throws {RequiredError}
|
|
65
|
+
*/
|
|
66
|
+
getTrickplayTileImage(itemId: string, width: number, index: number, mediaSourceId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
67
|
+
};
|
|
68
|
+
/**
|
|
69
|
+
* TrickplayApi - factory interface
|
|
70
|
+
* @export
|
|
71
|
+
*/
|
|
72
|
+
export declare const TrickplayApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
73
|
+
/**
|
|
74
|
+
*
|
|
75
|
+
* @summary Gets an image tiles playlist for trickplay.
|
|
76
|
+
* @param {string} itemId The item id.
|
|
77
|
+
* @param {number} width The width of a single tile.
|
|
78
|
+
* @param {string} [mediaSourceId] The media version id, if using an alternate version.
|
|
79
|
+
* @param {*} [options] Override http request option.
|
|
80
|
+
* @throws {RequiredError}
|
|
81
|
+
*/
|
|
82
|
+
getTrickplayHlsPlaylist(itemId: string, width: number, mediaSourceId?: string, options?: any): AxiosPromise<any>;
|
|
83
|
+
/**
|
|
84
|
+
*
|
|
85
|
+
* @summary Gets a trickplay tile image.
|
|
86
|
+
* @param {string} itemId The item id.
|
|
87
|
+
* @param {number} width The width of a single tile.
|
|
88
|
+
* @param {number} index The index of the desired tile.
|
|
89
|
+
* @param {string} [mediaSourceId] The media version id, if using an alternate version.
|
|
90
|
+
* @param {*} [options] Override http request option.
|
|
91
|
+
* @throws {RequiredError}
|
|
92
|
+
*/
|
|
93
|
+
getTrickplayTileImage(itemId: string, width: number, index: number, mediaSourceId?: string, options?: any): AxiosPromise<any>;
|
|
94
|
+
};
|
|
95
|
+
/**
|
|
96
|
+
* Request parameters for getTrickplayHlsPlaylist operation in TrickplayApi.
|
|
97
|
+
* @export
|
|
98
|
+
* @interface TrickplayApiGetTrickplayHlsPlaylistRequest
|
|
99
|
+
*/
|
|
100
|
+
export interface TrickplayApiGetTrickplayHlsPlaylistRequest {
|
|
101
|
+
/**
|
|
102
|
+
* The item id.
|
|
103
|
+
* @type {string}
|
|
104
|
+
* @memberof TrickplayApiGetTrickplayHlsPlaylist
|
|
105
|
+
*/
|
|
106
|
+
readonly itemId: string;
|
|
107
|
+
/**
|
|
108
|
+
* The width of a single tile.
|
|
109
|
+
* @type {number}
|
|
110
|
+
* @memberof TrickplayApiGetTrickplayHlsPlaylist
|
|
111
|
+
*/
|
|
112
|
+
readonly width: number;
|
|
113
|
+
/**
|
|
114
|
+
* The media version id, if using an alternate version.
|
|
115
|
+
* @type {string}
|
|
116
|
+
* @memberof TrickplayApiGetTrickplayHlsPlaylist
|
|
117
|
+
*/
|
|
118
|
+
readonly mediaSourceId?: string;
|
|
119
|
+
}
|
|
120
|
+
/**
|
|
121
|
+
* Request parameters for getTrickplayTileImage operation in TrickplayApi.
|
|
122
|
+
* @export
|
|
123
|
+
* @interface TrickplayApiGetTrickplayTileImageRequest
|
|
124
|
+
*/
|
|
125
|
+
export interface TrickplayApiGetTrickplayTileImageRequest {
|
|
126
|
+
/**
|
|
127
|
+
* The item id.
|
|
128
|
+
* @type {string}
|
|
129
|
+
* @memberof TrickplayApiGetTrickplayTileImage
|
|
130
|
+
*/
|
|
131
|
+
readonly itemId: string;
|
|
132
|
+
/**
|
|
133
|
+
* The width of a single tile.
|
|
134
|
+
* @type {number}
|
|
135
|
+
* @memberof TrickplayApiGetTrickplayTileImage
|
|
136
|
+
*/
|
|
137
|
+
readonly width: number;
|
|
138
|
+
/**
|
|
139
|
+
* The index of the desired tile.
|
|
140
|
+
* @type {number}
|
|
141
|
+
* @memberof TrickplayApiGetTrickplayTileImage
|
|
142
|
+
*/
|
|
143
|
+
readonly index: number;
|
|
144
|
+
/**
|
|
145
|
+
* The media version id, if using an alternate version.
|
|
146
|
+
* @type {string}
|
|
147
|
+
* @memberof TrickplayApiGetTrickplayTileImage
|
|
148
|
+
*/
|
|
149
|
+
readonly mediaSourceId?: string;
|
|
150
|
+
}
|
|
151
|
+
/**
|
|
152
|
+
* TrickplayApi - object-oriented interface
|
|
153
|
+
* @export
|
|
154
|
+
* @class TrickplayApi
|
|
155
|
+
* @extends {BaseAPI}
|
|
156
|
+
*/
|
|
157
|
+
export declare class TrickplayApi extends BaseAPI {
|
|
158
|
+
/**
|
|
159
|
+
*
|
|
160
|
+
* @summary Gets an image tiles playlist for trickplay.
|
|
161
|
+
* @param {TrickplayApiGetTrickplayHlsPlaylistRequest} requestParameters Request parameters.
|
|
162
|
+
* @param {*} [options] Override http request option.
|
|
163
|
+
* @throws {RequiredError}
|
|
164
|
+
* @memberof TrickplayApi
|
|
165
|
+
*/
|
|
166
|
+
getTrickplayHlsPlaylist(requestParameters: TrickplayApiGetTrickplayHlsPlaylistRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
|
|
167
|
+
/**
|
|
168
|
+
*
|
|
169
|
+
* @summary Gets a trickplay tile image.
|
|
170
|
+
* @param {TrickplayApiGetTrickplayTileImageRequest} requestParameters Request parameters.
|
|
171
|
+
* @param {*} [options] Override http request option.
|
|
172
|
+
* @throws {RequiredError}
|
|
173
|
+
* @memberof TrickplayApi
|
|
174
|
+
*/
|
|
175
|
+
getTrickplayTileImage(requestParameters: TrickplayApiGetTrickplayTileImageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
|
|
176
|
+
}
|
|
@@ -0,0 +1,208 @@
|
|
|
1
|
+
import globalAxios from 'axios';
|
|
2
|
+
import { assertParamExists, DUMMY_BASE_URL, setApiKeyToObject, setSearchParams, toPathString, createRequestFunction } from '../common.js';
|
|
3
|
+
import { BaseAPI, BASE_PATH } from '../base.js';
|
|
4
|
+
|
|
5
|
+
/* tslint:disable */
|
|
6
|
+
/* eslint-disable */
|
|
7
|
+
/**
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* Do not edit the class manually.
|
|
10
|
+
*
|
|
11
|
+
* Jellyfin API
|
|
12
|
+
*
|
|
13
|
+
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
14
|
+
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
15
|
+
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
16
|
+
*/
|
|
17
|
+
/**
|
|
18
|
+
* TrickplayApi - axios parameter creator
|
|
19
|
+
* @export
|
|
20
|
+
*/
|
|
21
|
+
const TrickplayApiAxiosParamCreator = function (configuration) {
|
|
22
|
+
return {
|
|
23
|
+
/**
|
|
24
|
+
*
|
|
25
|
+
* @summary Gets an image tiles playlist for trickplay.
|
|
26
|
+
* @param {string} itemId The item id.
|
|
27
|
+
* @param {number} width The width of a single tile.
|
|
28
|
+
* @param {string} [mediaSourceId] The media version id, if using an alternate version.
|
|
29
|
+
* @param {*} [options] Override http request option.
|
|
30
|
+
* @throws {RequiredError}
|
|
31
|
+
*/
|
|
32
|
+
getTrickplayHlsPlaylist: async (itemId, width, mediaSourceId, options = {}) => {
|
|
33
|
+
// verify required parameter 'itemId' is not null or undefined
|
|
34
|
+
assertParamExists('getTrickplayHlsPlaylist', 'itemId', itemId);
|
|
35
|
+
// verify required parameter 'width' is not null or undefined
|
|
36
|
+
assertParamExists('getTrickplayHlsPlaylist', 'width', width);
|
|
37
|
+
const localVarPath = `/Videos/{itemId}/Trickplay/{width}/tiles.m3u8`
|
|
38
|
+
.replace(`{${"itemId"}}`, encodeURIComponent(String(itemId)))
|
|
39
|
+
.replace(`{${"width"}}`, encodeURIComponent(String(width)));
|
|
40
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
41
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
42
|
+
let baseOptions;
|
|
43
|
+
if (configuration) {
|
|
44
|
+
baseOptions = configuration.baseOptions;
|
|
45
|
+
}
|
|
46
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
47
|
+
const localVarHeaderParameter = {};
|
|
48
|
+
const localVarQueryParameter = {};
|
|
49
|
+
// authentication CustomAuthentication required
|
|
50
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
51
|
+
if (mediaSourceId !== undefined) {
|
|
52
|
+
localVarQueryParameter['mediaSourceId'] = mediaSourceId;
|
|
53
|
+
}
|
|
54
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
55
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
56
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
57
|
+
return {
|
|
58
|
+
url: toPathString(localVarUrlObj),
|
|
59
|
+
options: localVarRequestOptions,
|
|
60
|
+
};
|
|
61
|
+
},
|
|
62
|
+
/**
|
|
63
|
+
*
|
|
64
|
+
* @summary Gets a trickplay tile image.
|
|
65
|
+
* @param {string} itemId The item id.
|
|
66
|
+
* @param {number} width The width of a single tile.
|
|
67
|
+
* @param {number} index The index of the desired tile.
|
|
68
|
+
* @param {string} [mediaSourceId] The media version id, if using an alternate version.
|
|
69
|
+
* @param {*} [options] Override http request option.
|
|
70
|
+
* @throws {RequiredError}
|
|
71
|
+
*/
|
|
72
|
+
getTrickplayTileImage: async (itemId, width, index, mediaSourceId, options = {}) => {
|
|
73
|
+
// verify required parameter 'itemId' is not null or undefined
|
|
74
|
+
assertParamExists('getTrickplayTileImage', 'itemId', itemId);
|
|
75
|
+
// verify required parameter 'width' is not null or undefined
|
|
76
|
+
assertParamExists('getTrickplayTileImage', 'width', width);
|
|
77
|
+
// verify required parameter 'index' is not null or undefined
|
|
78
|
+
assertParamExists('getTrickplayTileImage', 'index', index);
|
|
79
|
+
const localVarPath = `/Videos/{itemId}/Trickplay/{width}/{index}.jpg`
|
|
80
|
+
.replace(`{${"itemId"}}`, encodeURIComponent(String(itemId)))
|
|
81
|
+
.replace(`{${"width"}}`, encodeURIComponent(String(width)))
|
|
82
|
+
.replace(`{${"index"}}`, encodeURIComponent(String(index)));
|
|
83
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
84
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
85
|
+
let baseOptions;
|
|
86
|
+
if (configuration) {
|
|
87
|
+
baseOptions = configuration.baseOptions;
|
|
88
|
+
}
|
|
89
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
90
|
+
const localVarHeaderParameter = {};
|
|
91
|
+
const localVarQueryParameter = {};
|
|
92
|
+
// authentication CustomAuthentication required
|
|
93
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
94
|
+
if (mediaSourceId !== undefined) {
|
|
95
|
+
localVarQueryParameter['mediaSourceId'] = mediaSourceId;
|
|
96
|
+
}
|
|
97
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
98
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
99
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
100
|
+
return {
|
|
101
|
+
url: toPathString(localVarUrlObj),
|
|
102
|
+
options: localVarRequestOptions,
|
|
103
|
+
};
|
|
104
|
+
},
|
|
105
|
+
};
|
|
106
|
+
};
|
|
107
|
+
/**
|
|
108
|
+
* TrickplayApi - functional programming interface
|
|
109
|
+
* @export
|
|
110
|
+
*/
|
|
111
|
+
const TrickplayApiFp = function (configuration) {
|
|
112
|
+
const localVarAxiosParamCreator = TrickplayApiAxiosParamCreator(configuration);
|
|
113
|
+
return {
|
|
114
|
+
/**
|
|
115
|
+
*
|
|
116
|
+
* @summary Gets an image tiles playlist for trickplay.
|
|
117
|
+
* @param {string} itemId The item id.
|
|
118
|
+
* @param {number} width The width of a single tile.
|
|
119
|
+
* @param {string} [mediaSourceId] The media version id, if using an alternate version.
|
|
120
|
+
* @param {*} [options] Override http request option.
|
|
121
|
+
* @throws {RequiredError}
|
|
122
|
+
*/
|
|
123
|
+
async getTrickplayHlsPlaylist(itemId, width, mediaSourceId, options) {
|
|
124
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getTrickplayHlsPlaylist(itemId, width, mediaSourceId, options);
|
|
125
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
126
|
+
},
|
|
127
|
+
/**
|
|
128
|
+
*
|
|
129
|
+
* @summary Gets a trickplay tile image.
|
|
130
|
+
* @param {string} itemId The item id.
|
|
131
|
+
* @param {number} width The width of a single tile.
|
|
132
|
+
* @param {number} index The index of the desired tile.
|
|
133
|
+
* @param {string} [mediaSourceId] The media version id, if using an alternate version.
|
|
134
|
+
* @param {*} [options] Override http request option.
|
|
135
|
+
* @throws {RequiredError}
|
|
136
|
+
*/
|
|
137
|
+
async getTrickplayTileImage(itemId, width, index, mediaSourceId, options) {
|
|
138
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getTrickplayTileImage(itemId, width, index, mediaSourceId, options);
|
|
139
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
140
|
+
},
|
|
141
|
+
};
|
|
142
|
+
};
|
|
143
|
+
/**
|
|
144
|
+
* TrickplayApi - factory interface
|
|
145
|
+
* @export
|
|
146
|
+
*/
|
|
147
|
+
const TrickplayApiFactory = function (configuration, basePath, axios) {
|
|
148
|
+
const localVarFp = TrickplayApiFp(configuration);
|
|
149
|
+
return {
|
|
150
|
+
/**
|
|
151
|
+
*
|
|
152
|
+
* @summary Gets an image tiles playlist for trickplay.
|
|
153
|
+
* @param {string} itemId The item id.
|
|
154
|
+
* @param {number} width The width of a single tile.
|
|
155
|
+
* @param {string} [mediaSourceId] The media version id, if using an alternate version.
|
|
156
|
+
* @param {*} [options] Override http request option.
|
|
157
|
+
* @throws {RequiredError}
|
|
158
|
+
*/
|
|
159
|
+
getTrickplayHlsPlaylist(itemId, width, mediaSourceId, options) {
|
|
160
|
+
return localVarFp.getTrickplayHlsPlaylist(itemId, width, mediaSourceId, options).then((request) => request(axios, basePath));
|
|
161
|
+
},
|
|
162
|
+
/**
|
|
163
|
+
*
|
|
164
|
+
* @summary Gets a trickplay tile image.
|
|
165
|
+
* @param {string} itemId The item id.
|
|
166
|
+
* @param {number} width The width of a single tile.
|
|
167
|
+
* @param {number} index The index of the desired tile.
|
|
168
|
+
* @param {string} [mediaSourceId] The media version id, if using an alternate version.
|
|
169
|
+
* @param {*} [options] Override http request option.
|
|
170
|
+
* @throws {RequiredError}
|
|
171
|
+
*/
|
|
172
|
+
getTrickplayTileImage(itemId, width, index, mediaSourceId, options) {
|
|
173
|
+
return localVarFp.getTrickplayTileImage(itemId, width, index, mediaSourceId, options).then((request) => request(axios, basePath));
|
|
174
|
+
},
|
|
175
|
+
};
|
|
176
|
+
};
|
|
177
|
+
/**
|
|
178
|
+
* TrickplayApi - object-oriented interface
|
|
179
|
+
* @export
|
|
180
|
+
* @class TrickplayApi
|
|
181
|
+
* @extends {BaseAPI}
|
|
182
|
+
*/
|
|
183
|
+
class TrickplayApi extends BaseAPI {
|
|
184
|
+
/**
|
|
185
|
+
*
|
|
186
|
+
* @summary Gets an image tiles playlist for trickplay.
|
|
187
|
+
* @param {TrickplayApiGetTrickplayHlsPlaylistRequest} requestParameters Request parameters.
|
|
188
|
+
* @param {*} [options] Override http request option.
|
|
189
|
+
* @throws {RequiredError}
|
|
190
|
+
* @memberof TrickplayApi
|
|
191
|
+
*/
|
|
192
|
+
getTrickplayHlsPlaylist(requestParameters, options) {
|
|
193
|
+
return TrickplayApiFp(this.configuration).getTrickplayHlsPlaylist(requestParameters.itemId, requestParameters.width, requestParameters.mediaSourceId, options).then((request) => request(this.axios, this.basePath));
|
|
194
|
+
}
|
|
195
|
+
/**
|
|
196
|
+
*
|
|
197
|
+
* @summary Gets a trickplay tile image.
|
|
198
|
+
* @param {TrickplayApiGetTrickplayTileImageRequest} requestParameters Request parameters.
|
|
199
|
+
* @param {*} [options] Override http request option.
|
|
200
|
+
* @throws {RequiredError}
|
|
201
|
+
* @memberof TrickplayApi
|
|
202
|
+
*/
|
|
203
|
+
getTrickplayTileImage(requestParameters, options) {
|
|
204
|
+
return TrickplayApiFp(this.configuration).getTrickplayTileImage(requestParameters.itemId, requestParameters.width, requestParameters.index, requestParameters.mediaSourceId, options).then((request) => request(this.axios, this.basePath));
|
|
205
|
+
}
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
export { TrickplayApi, TrickplayApiAxiosParamCreator, TrickplayApiFactory, TrickplayApiFp };
|
|
@@ -14,6 +14,7 @@ import { RequestArgs, BaseAPI } from '../base';
|
|
|
14
14
|
import { BaseItemDtoQueryResult } from '../models';
|
|
15
15
|
import { ImageType } from '../models';
|
|
16
16
|
import { ItemFields } from '../models';
|
|
17
|
+
import { ItemSortBy } from '../models';
|
|
17
18
|
/**
|
|
18
19
|
* TvShowsApi - axios parameter creator
|
|
19
20
|
* @export
|
|
@@ -36,11 +37,11 @@ export declare const TvShowsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
36
37
|
* @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type.
|
|
37
38
|
* @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
|
|
38
39
|
* @param {boolean} [enableUserData] Optional. Include user data.
|
|
39
|
-
* @param {
|
|
40
|
+
* @param {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.
|
|
40
41
|
* @param {*} [options] Override http request option.
|
|
41
42
|
* @throws {RequiredError}
|
|
42
43
|
*/
|
|
43
|
-
getEpisodes: (seriesId: string, userId?: string, fields?: Array<ItemFields>, season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, sortBy?:
|
|
44
|
+
getEpisodes: (seriesId: string, userId?: string, fields?: Array<ItemFields>, season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, sortBy?: ItemSortBy, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44
45
|
/**
|
|
45
46
|
*
|
|
46
47
|
* @summary Gets a list of next up episodes.
|
|
@@ -57,11 +58,12 @@ export declare const TvShowsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
57
58
|
* @param {string} [nextUpDateCutoff] Optional. Starting date of shows to show in Next Up section.
|
|
58
59
|
* @param {boolean} [enableTotalRecordCount] Whether to enable the total records count. Defaults to true.
|
|
59
60
|
* @param {boolean} [disableFirstEpisode] Whether to disable sending the first episode in a series as next up.
|
|
60
|
-
* @param {boolean} [
|
|
61
|
+
* @param {boolean} [enableResumable] Whether to include resumable episodes in next up results.
|
|
62
|
+
* @param {boolean} [enableRewatching] Whether to include watched episodes in next up results.
|
|
61
63
|
* @param {*} [options] Override http request option.
|
|
62
64
|
* @throws {RequiredError}
|
|
63
65
|
*/
|
|
64
|
-
getNextUp: (userId?: string, startIndex?: number, limit?: number, fields?: Array<ItemFields>, seriesId?: string, parentId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, nextUpDateCutoff?: string, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, enableRewatching?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
66
|
+
getNextUp: (userId?: string, startIndex?: number, limit?: number, fields?: Array<ItemFields>, seriesId?: string, parentId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, nextUpDateCutoff?: string, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, enableResumable?: boolean, enableRewatching?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
65
67
|
/**
|
|
66
68
|
*
|
|
67
69
|
* @summary Gets seasons for a tv series.
|
|
@@ -118,11 +120,11 @@ export declare const TvShowsApiFp: (configuration?: Configuration) => {
|
|
|
118
120
|
* @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type.
|
|
119
121
|
* @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
|
|
120
122
|
* @param {boolean} [enableUserData] Optional. Include user data.
|
|
121
|
-
* @param {
|
|
123
|
+
* @param {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.
|
|
122
124
|
* @param {*} [options] Override http request option.
|
|
123
125
|
* @throws {RequiredError}
|
|
124
126
|
*/
|
|
125
|
-
getEpisodes(seriesId: string, userId?: string, fields?: Array<ItemFields>, season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, sortBy?:
|
|
127
|
+
getEpisodes(seriesId: string, userId?: string, fields?: Array<ItemFields>, season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, sortBy?: ItemSortBy, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
|
|
126
128
|
/**
|
|
127
129
|
*
|
|
128
130
|
* @summary Gets a list of next up episodes.
|
|
@@ -139,11 +141,12 @@ export declare const TvShowsApiFp: (configuration?: Configuration) => {
|
|
|
139
141
|
* @param {string} [nextUpDateCutoff] Optional. Starting date of shows to show in Next Up section.
|
|
140
142
|
* @param {boolean} [enableTotalRecordCount] Whether to enable the total records count. Defaults to true.
|
|
141
143
|
* @param {boolean} [disableFirstEpisode] Whether to disable sending the first episode in a series as next up.
|
|
142
|
-
* @param {boolean} [
|
|
144
|
+
* @param {boolean} [enableResumable] Whether to include resumable episodes in next up results.
|
|
145
|
+
* @param {boolean} [enableRewatching] Whether to include watched episodes in next up results.
|
|
143
146
|
* @param {*} [options] Override http request option.
|
|
144
147
|
* @throws {RequiredError}
|
|
145
148
|
*/
|
|
146
|
-
getNextUp(userId?: string, startIndex?: number, limit?: number, fields?: Array<ItemFields>, seriesId?: string, parentId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, nextUpDateCutoff?: string, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, enableRewatching?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
|
|
149
|
+
getNextUp(userId?: string, startIndex?: number, limit?: number, fields?: Array<ItemFields>, seriesId?: string, parentId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, nextUpDateCutoff?: string, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, enableResumable?: boolean, enableRewatching?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
|
|
147
150
|
/**
|
|
148
151
|
*
|
|
149
152
|
* @summary Gets seasons for a tv series.
|
|
@@ -200,11 +203,11 @@ export declare const TvShowsApiFactory: (configuration?: Configuration, basePath
|
|
|
200
203
|
* @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type.
|
|
201
204
|
* @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
|
|
202
205
|
* @param {boolean} [enableUserData] Optional. Include user data.
|
|
203
|
-
* @param {
|
|
206
|
+
* @param {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.
|
|
204
207
|
* @param {*} [options] Override http request option.
|
|
205
208
|
* @throws {RequiredError}
|
|
206
209
|
*/
|
|
207
|
-
getEpisodes(seriesId: string, userId?: string, fields?: Array<ItemFields>, season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, sortBy?:
|
|
210
|
+
getEpisodes(seriesId: string, userId?: string, fields?: Array<ItemFields>, season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, sortBy?: ItemSortBy, options?: any): AxiosPromise<BaseItemDtoQueryResult>;
|
|
208
211
|
/**
|
|
209
212
|
*
|
|
210
213
|
* @summary Gets a list of next up episodes.
|
|
@@ -221,11 +224,12 @@ export declare const TvShowsApiFactory: (configuration?: Configuration, basePath
|
|
|
221
224
|
* @param {string} [nextUpDateCutoff] Optional. Starting date of shows to show in Next Up section.
|
|
222
225
|
* @param {boolean} [enableTotalRecordCount] Whether to enable the total records count. Defaults to true.
|
|
223
226
|
* @param {boolean} [disableFirstEpisode] Whether to disable sending the first episode in a series as next up.
|
|
224
|
-
* @param {boolean} [
|
|
227
|
+
* @param {boolean} [enableResumable] Whether to include resumable episodes in next up results.
|
|
228
|
+
* @param {boolean} [enableRewatching] Whether to include watched episodes in next up results.
|
|
225
229
|
* @param {*} [options] Override http request option.
|
|
226
230
|
* @throws {RequiredError}
|
|
227
231
|
*/
|
|
228
|
-
getNextUp(userId?: string, startIndex?: number, limit?: number, fields?: Array<ItemFields>, seriesId?: string, parentId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, nextUpDateCutoff?: string, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, enableRewatching?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>;
|
|
232
|
+
getNextUp(userId?: string, startIndex?: number, limit?: number, fields?: Array<ItemFields>, seriesId?: string, parentId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, nextUpDateCutoff?: string, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, enableResumable?: boolean, enableRewatching?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>;
|
|
229
233
|
/**
|
|
230
234
|
*
|
|
231
235
|
* @summary Gets seasons for a tv series.
|
|
@@ -352,10 +356,10 @@ export interface TvShowsApiGetEpisodesRequest {
|
|
|
352
356
|
readonly enableUserData?: boolean;
|
|
353
357
|
/**
|
|
354
358
|
* 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.
|
|
355
|
-
* @type {
|
|
359
|
+
* @type {ItemSortBy}
|
|
356
360
|
* @memberof TvShowsApiGetEpisodes
|
|
357
361
|
*/
|
|
358
|
-
readonly sortBy?:
|
|
362
|
+
readonly sortBy?: ItemSortBy;
|
|
359
363
|
}
|
|
360
364
|
/**
|
|
361
365
|
* Request parameters for getNextUp operation in TvShowsApi.
|
|
@@ -442,7 +446,13 @@ export interface TvShowsApiGetNextUpRequest {
|
|
|
442
446
|
*/
|
|
443
447
|
readonly disableFirstEpisode?: boolean;
|
|
444
448
|
/**
|
|
445
|
-
* Whether to include
|
|
449
|
+
* Whether to include resumable episodes in next up results.
|
|
450
|
+
* @type {boolean}
|
|
451
|
+
* @memberof TvShowsApiGetNextUp
|
|
452
|
+
*/
|
|
453
|
+
readonly enableResumable?: boolean;
|
|
454
|
+
/**
|
|
455
|
+
* Whether to include watched episodes in next up results.
|
|
446
456
|
* @type {boolean}
|
|
447
457
|
* @memberof TvShowsApiGetNextUp
|
|
448
458
|
*/
|