@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
|
@@ -16,7 +16,9 @@ import { BaseItemKind } from '../models';
|
|
|
16
16
|
import { ImageType } from '../models';
|
|
17
17
|
import { ItemFields } from '../models';
|
|
18
18
|
import { ItemFilter } from '../models';
|
|
19
|
+
import { ItemSortBy } from '../models';
|
|
19
20
|
import { LocationType } from '../models';
|
|
21
|
+
import { MediaType } from '../models';
|
|
20
22
|
import { SeriesStatus } from '../models';
|
|
21
23
|
import { SortOrder } from '../models';
|
|
22
24
|
import { VideoType } from '../models';
|
|
@@ -28,7 +30,7 @@ export declare const TrailersApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
28
30
|
/**
|
|
29
31
|
*
|
|
30
32
|
* @summary Finds movies and trailers similar to a given trailer.
|
|
31
|
-
* @param {string} [userId] The user id.
|
|
33
|
+
* @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key.
|
|
32
34
|
* @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
|
|
33
35
|
* @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
|
|
34
36
|
* @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
|
|
@@ -51,9 +53,9 @@ export declare const TrailersApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
51
53
|
* @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO.
|
|
52
54
|
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO.
|
|
53
55
|
* @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
|
|
54
|
-
* @param {boolean} [hasImdbId] Optional filter by items that have an
|
|
55
|
-
* @param {boolean} [hasTmdbId] Optional filter by items that have a
|
|
56
|
-
* @param {boolean} [hasTvdbId] Optional filter by items that have a
|
|
56
|
+
* @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not.
|
|
57
|
+
* @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not.
|
|
58
|
+
* @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not.
|
|
57
59
|
* @param {boolean} [isMovie] Optional filter for live tv movies.
|
|
58
60
|
* @param {boolean} [isSeries] Optional filter for live tv series.
|
|
59
61
|
* @param {boolean} [isNews] Optional filter for live tv news.
|
|
@@ -64,15 +66,15 @@ export declare const TrailersApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
64
66
|
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
65
67
|
* @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
66
68
|
* @param {string} [searchTerm] Optional. Filter based on a search term.
|
|
67
|
-
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
69
|
+
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending, Descending.
|
|
68
70
|
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
69
71
|
* @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.
|
|
70
72
|
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
71
73
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
|
|
72
74
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
73
|
-
* @param {Array<
|
|
75
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
74
76
|
* @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
|
|
75
|
-
* @param {Array<
|
|
77
|
+
* @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.
|
|
76
78
|
* @param {boolean} [isPlayed] Optional filter by items that are played, or not.
|
|
77
79
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
78
80
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -115,7 +117,7 @@ export declare const TrailersApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
115
117
|
* @param {*} [options] Override http request option.
|
|
116
118
|
* @throws {RequiredError}
|
|
117
119
|
*/
|
|
118
|
-
getTrailers: (userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array<LocationType>, excludeLocationTypes?: Array<LocationType>, isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, excludeItemIds?: Array<string>, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<
|
|
120
|
+
getTrailers: (userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array<LocationType>, excludeLocationTypes?: Array<LocationType>, isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, excludeItemIds?: Array<string>, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, imageTypes?: Array<ImageType>, sortBy?: Array<ItemSortBy>, isPlayed?: boolean, genres?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, artists?: Array<string>, excludeArtistIds?: Array<string>, artistIds?: Array<string>, albumArtistIds?: Array<string>, contributingArtistIds?: Array<string>, albums?: Array<string>, albumIds?: Array<string>, ids?: Array<string>, videoTypes?: Array<VideoType>, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array<SeriesStatus>, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array<string>, genreIds?: Array<string>, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
119
121
|
};
|
|
120
122
|
/**
|
|
121
123
|
* TrailersApi - functional programming interface
|
|
@@ -125,7 +127,7 @@ export declare const TrailersApiFp: (configuration?: Configuration) => {
|
|
|
125
127
|
/**
|
|
126
128
|
*
|
|
127
129
|
* @summary Finds movies and trailers similar to a given trailer.
|
|
128
|
-
* @param {string} [userId] The user id.
|
|
130
|
+
* @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key.
|
|
129
131
|
* @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
|
|
130
132
|
* @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
|
|
131
133
|
* @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
|
|
@@ -148,9 +150,9 @@ export declare const TrailersApiFp: (configuration?: Configuration) => {
|
|
|
148
150
|
* @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO.
|
|
149
151
|
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO.
|
|
150
152
|
* @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
|
|
151
|
-
* @param {boolean} [hasImdbId] Optional filter by items that have an
|
|
152
|
-
* @param {boolean} [hasTmdbId] Optional filter by items that have a
|
|
153
|
-
* @param {boolean} [hasTvdbId] Optional filter by items that have a
|
|
153
|
+
* @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not.
|
|
154
|
+
* @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not.
|
|
155
|
+
* @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not.
|
|
154
156
|
* @param {boolean} [isMovie] Optional filter for live tv movies.
|
|
155
157
|
* @param {boolean} [isSeries] Optional filter for live tv series.
|
|
156
158
|
* @param {boolean} [isNews] Optional filter for live tv news.
|
|
@@ -161,15 +163,15 @@ export declare const TrailersApiFp: (configuration?: Configuration) => {
|
|
|
161
163
|
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
162
164
|
* @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
163
165
|
* @param {string} [searchTerm] Optional. Filter based on a search term.
|
|
164
|
-
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
166
|
+
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending, Descending.
|
|
165
167
|
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
166
168
|
* @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.
|
|
167
169
|
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
168
170
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
|
|
169
171
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
170
|
-
* @param {Array<
|
|
172
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
171
173
|
* @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
|
|
172
|
-
* @param {Array<
|
|
174
|
+
* @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.
|
|
173
175
|
* @param {boolean} [isPlayed] Optional filter by items that are played, or not.
|
|
174
176
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
175
177
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -212,7 +214,7 @@ export declare const TrailersApiFp: (configuration?: Configuration) => {
|
|
|
212
214
|
* @param {*} [options] Override http request option.
|
|
213
215
|
* @throws {RequiredError}
|
|
214
216
|
*/
|
|
215
|
-
getTrailers(userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array<LocationType>, excludeLocationTypes?: Array<LocationType>, isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, excludeItemIds?: Array<string>, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<
|
|
217
|
+
getTrailers(userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array<LocationType>, excludeLocationTypes?: Array<LocationType>, isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, excludeItemIds?: Array<string>, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, imageTypes?: Array<ImageType>, sortBy?: Array<ItemSortBy>, isPlayed?: boolean, genres?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, artists?: Array<string>, excludeArtistIds?: Array<string>, artistIds?: Array<string>, albumArtistIds?: Array<string>, contributingArtistIds?: Array<string>, albums?: Array<string>, albumIds?: Array<string>, ids?: Array<string>, videoTypes?: Array<VideoType>, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array<SeriesStatus>, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array<string>, genreIds?: Array<string>, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
|
|
216
218
|
};
|
|
217
219
|
/**
|
|
218
220
|
* TrailersApi - factory interface
|
|
@@ -222,7 +224,7 @@ export declare const TrailersApiFactory: (configuration?: Configuration, basePat
|
|
|
222
224
|
/**
|
|
223
225
|
*
|
|
224
226
|
* @summary Finds movies and trailers similar to a given trailer.
|
|
225
|
-
* @param {string} [userId] The user id.
|
|
227
|
+
* @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key.
|
|
226
228
|
* @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
|
|
227
229
|
* @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
|
|
228
230
|
* @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
|
|
@@ -245,9 +247,9 @@ export declare const TrailersApiFactory: (configuration?: Configuration, basePat
|
|
|
245
247
|
* @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO.
|
|
246
248
|
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO.
|
|
247
249
|
* @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
|
|
248
|
-
* @param {boolean} [hasImdbId] Optional filter by items that have an
|
|
249
|
-
* @param {boolean} [hasTmdbId] Optional filter by items that have a
|
|
250
|
-
* @param {boolean} [hasTvdbId] Optional filter by items that have a
|
|
250
|
+
* @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not.
|
|
251
|
+
* @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not.
|
|
252
|
+
* @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not.
|
|
251
253
|
* @param {boolean} [isMovie] Optional filter for live tv movies.
|
|
252
254
|
* @param {boolean} [isSeries] Optional filter for live tv series.
|
|
253
255
|
* @param {boolean} [isNews] Optional filter for live tv news.
|
|
@@ -258,15 +260,15 @@ export declare const TrailersApiFactory: (configuration?: Configuration, basePat
|
|
|
258
260
|
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
259
261
|
* @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
260
262
|
* @param {string} [searchTerm] Optional. Filter based on a search term.
|
|
261
|
-
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
263
|
+
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending, Descending.
|
|
262
264
|
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
263
265
|
* @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.
|
|
264
266
|
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
265
267
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
|
|
266
268
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
267
|
-
* @param {Array<
|
|
269
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
268
270
|
* @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
|
|
269
|
-
* @param {Array<
|
|
271
|
+
* @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.
|
|
270
272
|
* @param {boolean} [isPlayed] Optional filter by items that are played, or not.
|
|
271
273
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
272
274
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -309,7 +311,7 @@ export declare const TrailersApiFactory: (configuration?: Configuration, basePat
|
|
|
309
311
|
* @param {*} [options] Override http request option.
|
|
310
312
|
* @throws {RequiredError}
|
|
311
313
|
*/
|
|
312
|
-
getTrailers(userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array<LocationType>, excludeLocationTypes?: Array<LocationType>, isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, excludeItemIds?: Array<string>, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<
|
|
314
|
+
getTrailers(userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array<LocationType>, excludeLocationTypes?: Array<LocationType>, isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, excludeItemIds?: Array<string>, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, imageTypes?: Array<ImageType>, sortBy?: Array<ItemSortBy>, isPlayed?: boolean, genres?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, artists?: Array<string>, excludeArtistIds?: Array<string>, artistIds?: Array<string>, albumArtistIds?: Array<string>, contributingArtistIds?: Array<string>, albums?: Array<string>, albumIds?: Array<string>, ids?: Array<string>, videoTypes?: Array<VideoType>, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array<SeriesStatus>, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array<string>, genreIds?: Array<string>, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>;
|
|
313
315
|
};
|
|
314
316
|
/**
|
|
315
317
|
* Request parameters for getTrailers operation in TrailersApi.
|
|
@@ -318,7 +320,7 @@ export declare const TrailersApiFactory: (configuration?: Configuration, basePat
|
|
|
318
320
|
*/
|
|
319
321
|
export interface TrailersApiGetTrailersRequest {
|
|
320
322
|
/**
|
|
321
|
-
* The user id.
|
|
323
|
+
* The user id supplied as query parameter; this is required when not using an API key.
|
|
322
324
|
* @type {string}
|
|
323
325
|
* @memberof TrailersApiGetTrailers
|
|
324
326
|
*/
|
|
@@ -456,19 +458,19 @@ export interface TrailersApiGetTrailersRequest {
|
|
|
456
458
|
*/
|
|
457
459
|
readonly hasOverview?: boolean;
|
|
458
460
|
/**
|
|
459
|
-
* Optional filter by items that have an
|
|
461
|
+
* Optional filter by items that have an IMDb id or not.
|
|
460
462
|
* @type {boolean}
|
|
461
463
|
* @memberof TrailersApiGetTrailers
|
|
462
464
|
*/
|
|
463
465
|
readonly hasImdbId?: boolean;
|
|
464
466
|
/**
|
|
465
|
-
* Optional filter by items that have a
|
|
467
|
+
* Optional filter by items that have a TMDb id or not.
|
|
466
468
|
* @type {boolean}
|
|
467
469
|
* @memberof TrailersApiGetTrailers
|
|
468
470
|
*/
|
|
469
471
|
readonly hasTmdbId?: boolean;
|
|
470
472
|
/**
|
|
471
|
-
* Optional filter by items that have a
|
|
473
|
+
* Optional filter by items that have a TVDb id or not.
|
|
472
474
|
* @type {boolean}
|
|
473
475
|
* @memberof TrailersApiGetTrailers
|
|
474
476
|
*/
|
|
@@ -534,7 +536,7 @@ export interface TrailersApiGetTrailersRequest {
|
|
|
534
536
|
*/
|
|
535
537
|
readonly searchTerm?: string;
|
|
536
538
|
/**
|
|
537
|
-
* Sort Order - Ascending,Descending.
|
|
539
|
+
* Sort Order - Ascending, Descending.
|
|
538
540
|
* @type {Array<SortOrder>}
|
|
539
541
|
* @memberof TrailersApiGetTrailers
|
|
540
542
|
*/
|
|
@@ -571,10 +573,10 @@ export interface TrailersApiGetTrailersRequest {
|
|
|
571
573
|
readonly isFavorite?: boolean;
|
|
572
574
|
/**
|
|
573
575
|
* Optional filter by MediaType. Allows multiple, comma delimited.
|
|
574
|
-
* @type {Array<
|
|
576
|
+
* @type {Array<MediaType>}
|
|
575
577
|
* @memberof TrailersApiGetTrailers
|
|
576
578
|
*/
|
|
577
|
-
readonly mediaTypes?: Array<
|
|
579
|
+
readonly mediaTypes?: Array<MediaType>;
|
|
578
580
|
/**
|
|
579
581
|
* Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
|
|
580
582
|
* @type {Array<ImageType>}
|
|
@@ -583,10 +585,10 @@ export interface TrailersApiGetTrailersRequest {
|
|
|
583
585
|
readonly imageTypes?: Array<ImageType>;
|
|
584
586
|
/**
|
|
585
587
|
* 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.
|
|
586
|
-
* @type {Array<
|
|
588
|
+
* @type {Array<ItemSortBy>}
|
|
587
589
|
* @memberof TrailersApiGetTrailers
|
|
588
590
|
*/
|
|
589
|
-
readonly sortBy?: Array<
|
|
591
|
+
readonly sortBy?: Array<ItemSortBy>;
|
|
590
592
|
/**
|
|
591
593
|
* Optional filter by items that are played, or not.
|
|
592
594
|
* @type {boolean}
|
|
@@ -1,9 +1,19 @@
|
|
|
1
|
-
import { __awaiter } from '../../node_modules/tslib/tslib.es6.js';
|
|
2
1
|
import globalAxios from 'axios';
|
|
3
2
|
import { DUMMY_BASE_URL, setApiKeyToObject, setSearchParams, toPathString, createRequestFunction } from '../common.js';
|
|
4
3
|
import { BaseAPI, BASE_PATH } from '../base.js';
|
|
5
4
|
|
|
6
5
|
/* tslint:disable */
|
|
6
|
+
/* eslint-disable */
|
|
7
|
+
/**
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* Do not edit the class manually.
|
|
10
|
+
*
|
|
11
|
+
* Jellyfin API
|
|
12
|
+
*
|
|
13
|
+
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
14
|
+
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
15
|
+
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
16
|
+
*/
|
|
7
17
|
/**
|
|
8
18
|
* TrailersApi - axios parameter creator
|
|
9
19
|
* @export
|
|
@@ -13,7 +23,7 @@ const TrailersApiAxiosParamCreator = function (configuration) {
|
|
|
13
23
|
/**
|
|
14
24
|
*
|
|
15
25
|
* @summary Finds movies and trailers similar to a given trailer.
|
|
16
|
-
* @param {string} [userId] The user id.
|
|
26
|
+
* @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key.
|
|
17
27
|
* @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
|
|
18
28
|
* @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
|
|
19
29
|
* @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
|
|
@@ -36,9 +46,9 @@ const TrailersApiAxiosParamCreator = function (configuration) {
|
|
|
36
46
|
* @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO.
|
|
37
47
|
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO.
|
|
38
48
|
* @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
|
|
39
|
-
* @param {boolean} [hasImdbId] Optional filter by items that have an
|
|
40
|
-
* @param {boolean} [hasTmdbId] Optional filter by items that have a
|
|
41
|
-
* @param {boolean} [hasTvdbId] Optional filter by items that have a
|
|
49
|
+
* @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not.
|
|
50
|
+
* @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not.
|
|
51
|
+
* @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not.
|
|
42
52
|
* @param {boolean} [isMovie] Optional filter for live tv movies.
|
|
43
53
|
* @param {boolean} [isSeries] Optional filter for live tv series.
|
|
44
54
|
* @param {boolean} [isNews] Optional filter for live tv news.
|
|
@@ -49,15 +59,15 @@ const TrailersApiAxiosParamCreator = function (configuration) {
|
|
|
49
59
|
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
50
60
|
* @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
51
61
|
* @param {string} [searchTerm] Optional. Filter based on a search term.
|
|
52
|
-
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
62
|
+
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending, Descending.
|
|
53
63
|
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
54
64
|
* @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
65
|
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
56
66
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
|
|
57
67
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
58
|
-
* @param {Array<
|
|
68
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
59
69
|
* @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
|
|
60
|
-
* @param {Array<
|
|
70
|
+
* @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.
|
|
61
71
|
* @param {boolean} [isPlayed] Optional filter by items that are played, or not.
|
|
62
72
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
63
73
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -100,7 +110,7 @@ const TrailersApiAxiosParamCreator = function (configuration) {
|
|
|
100
110
|
* @param {*} [options] Override http request option.
|
|
101
111
|
* @throws {RequiredError}
|
|
102
112
|
*/
|
|
103
|
-
getTrailers: (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, 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 = {}) =>
|
|
113
|
+
getTrailers: 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, 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 = {}) => {
|
|
104
114
|
const localVarPath = `/Trailers`;
|
|
105
115
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
106
116
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -108,11 +118,11 @@ const TrailersApiAxiosParamCreator = function (configuration) {
|
|
|
108
118
|
if (configuration) {
|
|
109
119
|
baseOptions = configuration.baseOptions;
|
|
110
120
|
}
|
|
111
|
-
const localVarRequestOptions =
|
|
121
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
112
122
|
const localVarHeaderParameter = {};
|
|
113
123
|
const localVarQueryParameter = {};
|
|
114
124
|
// authentication CustomAuthentication required
|
|
115
|
-
|
|
125
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
116
126
|
if (userId !== undefined) {
|
|
117
127
|
localVarQueryParameter['userId'] = userId;
|
|
118
128
|
}
|
|
@@ -375,12 +385,12 @@ const TrailersApiAxiosParamCreator = function (configuration) {
|
|
|
375
385
|
}
|
|
376
386
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
377
387
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
378
|
-
localVarRequestOptions.headers =
|
|
388
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
379
389
|
return {
|
|
380
390
|
url: toPathString(localVarUrlObj),
|
|
381
391
|
options: localVarRequestOptions,
|
|
382
392
|
};
|
|
383
|
-
}
|
|
393
|
+
},
|
|
384
394
|
};
|
|
385
395
|
};
|
|
386
396
|
/**
|
|
@@ -393,7 +403,7 @@ const TrailersApiFp = function (configuration) {
|
|
|
393
403
|
/**
|
|
394
404
|
*
|
|
395
405
|
* @summary Finds movies and trailers similar to a given trailer.
|
|
396
|
-
* @param {string} [userId] The user id.
|
|
406
|
+
* @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key.
|
|
397
407
|
* @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
|
|
398
408
|
* @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
|
|
399
409
|
* @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
|
|
@@ -416,9 +426,9 @@ const TrailersApiFp = function (configuration) {
|
|
|
416
426
|
* @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO.
|
|
417
427
|
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO.
|
|
418
428
|
* @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
|
|
419
|
-
* @param {boolean} [hasImdbId] Optional filter by items that have an
|
|
420
|
-
* @param {boolean} [hasTmdbId] Optional filter by items that have a
|
|
421
|
-
* @param {boolean} [hasTvdbId] Optional filter by items that have a
|
|
429
|
+
* @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not.
|
|
430
|
+
* @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not.
|
|
431
|
+
* @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not.
|
|
422
432
|
* @param {boolean} [isMovie] Optional filter for live tv movies.
|
|
423
433
|
* @param {boolean} [isSeries] Optional filter for live tv series.
|
|
424
434
|
* @param {boolean} [isNews] Optional filter for live tv news.
|
|
@@ -429,15 +439,15 @@ const TrailersApiFp = function (configuration) {
|
|
|
429
439
|
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
430
440
|
* @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
431
441
|
* @param {string} [searchTerm] Optional. Filter based on a search term.
|
|
432
|
-
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
442
|
+
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending, Descending.
|
|
433
443
|
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
434
444
|
* @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.
|
|
435
445
|
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
436
446
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
|
|
437
447
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
438
|
-
* @param {Array<
|
|
448
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
439
449
|
* @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
|
|
440
|
-
* @param {Array<
|
|
450
|
+
* @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.
|
|
441
451
|
* @param {boolean} [isPlayed] Optional filter by items that are played, or not.
|
|
442
452
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
443
453
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -480,11 +490,9 @@ const TrailersApiFp = function (configuration) {
|
|
|
480
490
|
* @param {*} [options] Override http request option.
|
|
481
491
|
* @throws {RequiredError}
|
|
482
492
|
*/
|
|
483
|
-
getTrailers(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, 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) {
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
487
|
-
});
|
|
493
|
+
async getTrailers(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, 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) {
|
|
494
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getTrailers(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, 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);
|
|
495
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
488
496
|
},
|
|
489
497
|
};
|
|
490
498
|
};
|
|
@@ -498,7 +506,7 @@ const TrailersApiFactory = function (configuration, basePath, axios) {
|
|
|
498
506
|
/**
|
|
499
507
|
*
|
|
500
508
|
* @summary Finds movies and trailers similar to a given trailer.
|
|
501
|
-
* @param {string} [userId] The user id.
|
|
509
|
+
* @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key.
|
|
502
510
|
* @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
|
|
503
511
|
* @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
|
|
504
512
|
* @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
|
|
@@ -521,9 +529,9 @@ const TrailersApiFactory = function (configuration, basePath, axios) {
|
|
|
521
529
|
* @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO.
|
|
522
530
|
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO.
|
|
523
531
|
* @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
|
|
524
|
-
* @param {boolean} [hasImdbId] Optional filter by items that have an
|
|
525
|
-
* @param {boolean} [hasTmdbId] Optional filter by items that have a
|
|
526
|
-
* @param {boolean} [hasTvdbId] Optional filter by items that have a
|
|
532
|
+
* @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not.
|
|
533
|
+
* @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not.
|
|
534
|
+
* @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not.
|
|
527
535
|
* @param {boolean} [isMovie] Optional filter for live tv movies.
|
|
528
536
|
* @param {boolean} [isSeries] Optional filter for live tv series.
|
|
529
537
|
* @param {boolean} [isNews] Optional filter for live tv news.
|
|
@@ -534,15 +542,15 @@ const TrailersApiFactory = function (configuration, basePath, axios) {
|
|
|
534
542
|
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
535
543
|
* @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
536
544
|
* @param {string} [searchTerm] Optional. Filter based on a search term.
|
|
537
|
-
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
545
|
+
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending, Descending.
|
|
538
546
|
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
539
547
|
* @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.
|
|
540
548
|
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
541
549
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
|
|
542
550
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
543
|
-
* @param {Array<
|
|
551
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
544
552
|
* @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
|
|
545
|
-
* @param {Array<
|
|
553
|
+
* @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.
|
|
546
554
|
* @param {boolean} [isPlayed] Optional filter by items that are played, or not.
|
|
547
555
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
548
556
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|