@jellyfin/sdk 0.8.2 → 0.9.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 +9 -4
- package/lib/api.d.ts +1 -0
- package/lib/api.js +4 -4
- package/lib/discovery/recommended-server-discovery.js +24 -16
- package/lib/generated-client/api/activity-log-api.js +12 -1
- package/lib/generated-client/api/api-key-api.js +14 -3
- package/lib/generated-client/api/artists-api.d.ts +28 -26
- package/lib/generated-client/api/artists-api.js +26 -15
- package/lib/generated-client/api/audio-api.d.ts +8 -8
- package/lib/generated-client/api/audio-api.js +21 -10
- package/lib/generated-client/api/branding-api.js +14 -3
- package/lib/generated-client/api/channels-api.d.ts +9 -8
- package/lib/generated-client/api/channels-api.js +19 -8
- package/lib/generated-client/api/client-log-api.js +12 -1
- package/lib/generated-client/api/collection-api.js +14 -3
- package/lib/generated-client/api/configuration-api.d.ts +0 -47
- package/lib/generated-client/api/configuration-api.js +16 -71
- package/lib/generated-client/api/dashboard-api.js +13 -2
- package/lib/generated-client/api/devices-api.d.ts +3 -12
- package/lib/generated-client/api/devices-api.js +21 -16
- package/lib/generated-client/api/display-preferences-api.d.ts +22 -22
- package/lib/generated-client/api/display-preferences-api.js +29 -22
- package/lib/generated-client/api/dynamic-hls-api.d.ts +28 -10
- package/lib/generated-client/api/dynamic-hls-api.js +45 -22
- package/lib/generated-client/api/environment-api.js +17 -6
- package/lib/generated-client/api/filter-api.d.ts +9 -8
- package/lib/generated-client/api/filter-api.js +16 -5
- package/lib/generated-client/api/genres-api.d.ts +9 -8
- package/lib/generated-client/api/genres-api.js +16 -5
- package/lib/generated-client/api/hls-segment-api.js +16 -5
- package/lib/generated-client/api/image-api.d.ts +109 -1184
- package/lib/generated-client/api/image-api.js +218 -1056
- package/lib/generated-client/api/instant-mix-api.d.ts +35 -35
- package/lib/generated-client/api/instant-mix-api.js +79 -68
- package/lib/generated-client/api/item-lookup-api.js +22 -11
- package/lib/generated-client/api/item-refresh-api.js +12 -1
- package/lib/generated-client/api/item-update-api.js +14 -3
- package/lib/generated-client/api/items-api.d.ts +333 -1012
- package/lib/generated-client/api/items-api.js +178 -595
- package/lib/generated-client/api/library-api.d.ts +9 -8
- package/lib/generated-client/api/library-api.js +39 -28
- package/lib/generated-client/api/library-structure-api.js +19 -8
- package/lib/generated-client/api/live-tv-api.d.ts +17 -16
- package/lib/generated-client/api/live-tv-api.js +58 -47
- package/lib/generated-client/api/localization-api.js +15 -4
- package/lib/generated-client/api/lyrics-api.d.ts +344 -0
- package/lib/generated-client/api/{dlna-api.js → lyrics-api.js} +165 -125
- package/lib/generated-client/api/media-info-api.d.ts +7 -7
- package/lib/generated-client/api/media-info-api.js +19 -10
- package/lib/generated-client/api/movies-api.js +12 -1
- package/lib/generated-client/api/music-genres-api.d.ts +9 -8
- package/lib/generated-client/api/music-genres-api.js +16 -5
- package/lib/generated-client/api/package-api.js +17 -6
- package/lib/generated-client/api/persons-api.js +13 -2
- package/lib/generated-client/api/playlists-api.d.ts +315 -36
- package/lib/generated-client/api/playlists-api.js +395 -29
- package/lib/generated-client/api/playstate-api.d.ts +41 -68
- package/lib/generated-client/api/playstate-api.js +74 -81
- package/lib/generated-client/api/plugins-api.js +20 -9
- package/lib/generated-client/api/quick-connect-api.d.ts +46 -37
- package/lib/generated-client/api/quick-connect-api.js +67 -50
- package/lib/generated-client/api/remote-image-api.js +14 -3
- package/lib/generated-client/api/scheduled-tasks-api.js +16 -5
- package/lib/generated-client/api/search-api.d.ts +41 -40
- package/lib/generated-client/api/search-api.js +29 -18
- package/lib/generated-client/api/session-api.d.ts +9 -17
- package/lib/generated-client/api/session-api.js +35 -30
- package/lib/generated-client/api/startup-api.js +18 -7
- package/lib/generated-client/api/studios-api.js +13 -2
- package/lib/generated-client/api/subtitle-api.d.ts +7 -7
- package/lib/generated-client/api/subtitle-api.js +33 -22
- package/lib/generated-client/api/suggestions-api.d.ts +14 -13
- package/lib/generated-client/api/suggestions-api.js +24 -13
- package/lib/generated-client/api/sync-play-api.js +32 -21
- package/lib/generated-client/api/system-api.js +21 -10
- package/lib/generated-client/api/time-sync-api.js +12 -1
- package/lib/generated-client/api/tmdb-api.js +12 -1
- package/lib/generated-client/api/trailers-api.d.ts +35 -33
- package/lib/generated-client/api/trailers-api.js +33 -22
- package/lib/generated-client/api/trickplay-api.d.ts +176 -0
- package/lib/generated-client/api/trickplay-api.js +213 -0
- package/lib/generated-client/api/tv-shows-api.d.ts +25 -15
- package/lib/generated-client/api/tv-shows-api.js +32 -15
- package/lib/generated-client/api/universal-audio-api.d.ts +17 -16
- package/lib/generated-client/api/universal-audio-api.js +19 -8
- package/lib/generated-client/api/user-api.d.ts +35 -155
- package/lib/generated-client/api/user-api.js +65 -203
- package/lib/generated-client/api/user-library-api.d.ts +100 -100
- package/lib/generated-client/api/user-library-api.js +136 -125
- package/lib/generated-client/api/user-views-api.d.ts +22 -21
- package/lib/generated-client/api/user-views-api.js +33 -22
- package/lib/generated-client/api/video-attachments-api.js +12 -1
- package/lib/generated-client/api/videos-api.js +18 -7
- package/lib/generated-client/api/years-api.d.ts +15 -13
- package/lib/generated-client/api/years-api.js +19 -8
- package/lib/generated-client/api.d.ts +2 -4
- package/lib/generated-client/base.js +13 -0
- package/lib/generated-client/common.js +11 -0
- 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 +20 -17
- 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/node_modules/tslib/tslib.es6.js +9 -2
- 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 +103 -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-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/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,9 +16,13 @@ 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';
|
|
24
|
+
import { UpdateUserItemDataDto } from '../models';
|
|
25
|
+
import { UserItemDataDto } from '../models';
|
|
22
26
|
import { VideoType } from '../models';
|
|
23
27
|
/**
|
|
24
28
|
* ItemsApi - axios parameter creator
|
|
@@ -27,100 +31,17 @@ import { VideoType } from '../models';
|
|
|
27
31
|
export declare const ItemsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
28
32
|
/**
|
|
29
33
|
*
|
|
30
|
-
* @summary
|
|
31
|
-
* @param {string}
|
|
32
|
-
* @param {string} [
|
|
33
|
-
* @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
|
|
34
|
-
* @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
|
|
35
|
-
* @param {boolean} [hasSubtitles] Optional filter by items with subtitles.
|
|
36
|
-
* @param {boolean} [hasSpecialFeature] Optional filter by items with special features.
|
|
37
|
-
* @param {boolean} [hasTrailer] Optional filter by items with trailers.
|
|
38
|
-
* @param {string} [adjacentTo] Optional. Return items that are siblings of a supplied item.
|
|
39
|
-
* @param {number} [parentIndexNumber] Optional filter by parent index number.
|
|
40
|
-
* @param {boolean} [hasParentalRating] Optional filter by items that have or do not have a parental rating.
|
|
41
|
-
* @param {boolean} [isHd] Optional filter by items that are HD or not.
|
|
42
|
-
* @param {boolean} [is4K] Optional filter by items that are 4K or not.
|
|
43
|
-
* @param {Array<LocationType>} [locationTypes] Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.
|
|
44
|
-
* @param {Array<LocationType>} [excludeLocationTypes] Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.
|
|
45
|
-
* @param {boolean} [isMissing] Optional filter by items that are missing episodes or not.
|
|
46
|
-
* @param {boolean} [isUnaired] Optional filter by items that are unaired episodes or not.
|
|
47
|
-
* @param {number} [minCommunityRating] Optional filter by minimum community rating.
|
|
48
|
-
* @param {number} [minCriticRating] Optional filter by minimum critic rating.
|
|
49
|
-
* @param {string} [minPremiereDate] Optional. The minimum premiere date. Format = ISO.
|
|
50
|
-
* @param {string} [minDateLastSaved] Optional. The minimum last saved date. Format = ISO.
|
|
51
|
-
* @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO.
|
|
52
|
-
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO.
|
|
53
|
-
* @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
|
|
54
|
-
* @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
|
|
55
|
-
* @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
|
|
56
|
-
* @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
|
|
57
|
-
* @param {boolean} [isMovie] Optional filter for live tv movies.
|
|
58
|
-
* @param {boolean} [isSeries] Optional filter for live tv series.
|
|
59
|
-
* @param {boolean} [isNews] Optional filter for live tv news.
|
|
60
|
-
* @param {boolean} [isKids] Optional filter for live tv kids.
|
|
61
|
-
* @param {boolean} [isSports] Optional filter for live tv sports.
|
|
62
|
-
* @param {Array<string>} [excludeItemIds] Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.
|
|
63
|
-
* @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
|
|
64
|
-
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
65
|
-
* @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
66
|
-
* @param {string} [searchTerm] Optional. Filter based on a search term.
|
|
67
|
-
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
68
|
-
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
69
|
-
* @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
|
-
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
71
|
-
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
|
|
72
|
-
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
|
|
73
|
-
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
74
|
-
* @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
75
|
-
* @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
|
|
76
|
-
* @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
|
|
77
|
-
* @param {boolean} [isPlayed] Optional filter by items that are played, or not.
|
|
78
|
-
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
79
|
-
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
80
|
-
* @param {Array<string>} [tags] Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
|
|
81
|
-
* @param {Array<number>} [years] Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
|
|
82
|
-
* @param {boolean} [enableUserData] Optional, include user data.
|
|
83
|
-
* @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type.
|
|
84
|
-
* @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
|
|
85
|
-
* @param {string} [person] Optional. If specified, results will be filtered to include only those containing the specified person.
|
|
86
|
-
* @param {Array<string>} [personIds] Optional. If specified, results will be filtered to include only those containing the specified person id.
|
|
87
|
-
* @param {Array<string>} [personTypes] Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.
|
|
88
|
-
* @param {Array<string>} [studios] Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
|
|
89
|
-
* @param {Array<string>} [artists] Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.
|
|
90
|
-
* @param {Array<string>} [excludeArtistIds] Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.
|
|
91
|
-
* @param {Array<string>} [artistIds] Optional. If specified, results will be filtered to include only those containing the specified artist id.
|
|
92
|
-
* @param {Array<string>} [albumArtistIds] Optional. If specified, results will be filtered to include only those containing the specified album artist id.
|
|
93
|
-
* @param {Array<string>} [contributingArtistIds] Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.
|
|
94
|
-
* @param {Array<string>} [albums] Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.
|
|
95
|
-
* @param {Array<string>} [albumIds] Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.
|
|
96
|
-
* @param {Array<string>} [ids] Optional. If specific items are needed, specify a list of item id\'s to retrieve. This allows multiple, comma delimited.
|
|
97
|
-
* @param {Array<VideoType>} [videoTypes] Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.
|
|
98
|
-
* @param {string} [minOfficialRating] Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).
|
|
99
|
-
* @param {boolean} [isLocked] Optional filter by items that are locked.
|
|
100
|
-
* @param {boolean} [isPlaceHolder] Optional filter by items that are placeholders.
|
|
101
|
-
* @param {boolean} [hasOfficialRating] Optional filter by items that have official ratings.
|
|
102
|
-
* @param {boolean} [collapseBoxSetItems] Whether or not to hide items behind their boxsets.
|
|
103
|
-
* @param {number} [minWidth] Optional. Filter by the minimum width of the item.
|
|
104
|
-
* @param {number} [minHeight] Optional. Filter by the minimum height of the item.
|
|
105
|
-
* @param {number} [maxWidth] Optional. Filter by the maximum width of the item.
|
|
106
|
-
* @param {number} [maxHeight] Optional. Filter by the maximum height of the item.
|
|
107
|
-
* @param {boolean} [is3D] Optional filter by items that are 3D, or not.
|
|
108
|
-
* @param {Array<SeriesStatus>} [seriesStatus] Optional filter by Series Status. Allows multiple, comma delimited.
|
|
109
|
-
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
110
|
-
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
111
|
-
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
112
|
-
* @param {Array<string>} [studioIds] Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
|
|
113
|
-
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
114
|
-
* @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count.
|
|
115
|
-
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
34
|
+
* @summary Get Item User Data.
|
|
35
|
+
* @param {string} itemId The item id.
|
|
36
|
+
* @param {string} [userId] The user id.
|
|
116
37
|
* @param {*} [options] Override http request option.
|
|
117
38
|
* @throws {RequiredError}
|
|
118
39
|
*/
|
|
119
|
-
|
|
40
|
+
getItemUserData: (itemId: string, userId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
120
41
|
/**
|
|
121
42
|
*
|
|
122
43
|
* @summary Gets items based on a query.
|
|
123
|
-
* @param {string} userId The user id supplied as query parameter.
|
|
44
|
+
* @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key.
|
|
124
45
|
* @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
|
|
125
46
|
* @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
|
|
126
47
|
* @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
|
|
@@ -143,9 +64,9 @@ export declare const ItemsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
143
64
|
* @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO.
|
|
144
65
|
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO.
|
|
145
66
|
* @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
|
|
146
|
-
* @param {boolean} [hasImdbId] Optional filter by items that have an
|
|
147
|
-
* @param {boolean} [hasTmdbId] Optional filter by items that have a
|
|
148
|
-
* @param {boolean} [hasTvdbId] Optional filter by items that have a
|
|
67
|
+
* @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not.
|
|
68
|
+
* @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not.
|
|
69
|
+
* @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not.
|
|
149
70
|
* @param {boolean} [isMovie] Optional filter for live tv movies.
|
|
150
71
|
* @param {boolean} [isSeries] Optional filter for live tv series.
|
|
151
72
|
* @param {boolean} [isNews] Optional filter for live tv news.
|
|
@@ -156,16 +77,16 @@ export declare const ItemsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
156
77
|
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
157
78
|
* @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
158
79
|
* @param {string} [searchTerm] Optional. Filter based on a search term.
|
|
159
|
-
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
80
|
+
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending, Descending.
|
|
160
81
|
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
161
82
|
* @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.
|
|
162
83
|
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
163
84
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
|
|
164
85
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
|
|
165
86
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
166
|
-
* @param {Array<
|
|
87
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
167
88
|
* @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
|
|
168
|
-
* @param {Array<
|
|
89
|
+
* @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.
|
|
169
90
|
* @param {boolean} [isPlayed] Optional filter by items that are played, or not.
|
|
170
91
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
171
92
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -208,17 +129,17 @@ export declare const ItemsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
208
129
|
* @param {*} [options] Override http request option.
|
|
209
130
|
* @throws {RequiredError}
|
|
210
131
|
*/
|
|
211
|
-
|
|
132
|
+
getItems: (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>, includeItemTypes?: 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>;
|
|
212
133
|
/**
|
|
213
134
|
*
|
|
214
135
|
* @summary Gets items based on a query.
|
|
215
|
-
* @param {string} userId The user id.
|
|
136
|
+
* @param {string} [userId] The user id.
|
|
216
137
|
* @param {number} [startIndex] The start index.
|
|
217
138
|
* @param {number} [limit] The item limit.
|
|
218
139
|
* @param {string} [searchTerm] The search term.
|
|
219
140
|
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
220
141
|
* @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.
|
|
221
|
-
* @param {Array<
|
|
142
|
+
* @param {Array<MediaType>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
|
|
222
143
|
* @param {boolean} [enableUserData] Optional. Include user data.
|
|
223
144
|
* @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type.
|
|
224
145
|
* @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
|
|
@@ -230,7 +151,17 @@ export declare const ItemsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
230
151
|
* @param {*} [options] Override http request option.
|
|
231
152
|
* @throws {RequiredError}
|
|
232
153
|
*/
|
|
233
|
-
getResumeItems: (userId
|
|
154
|
+
getResumeItems: (userId?: string, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, mediaTypes?: Array<MediaType>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, enableTotalRecordCount?: boolean, enableImages?: boolean, excludeActiveSessions?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
155
|
+
/**
|
|
156
|
+
*
|
|
157
|
+
* @summary Update Item User Data.
|
|
158
|
+
* @param {string} itemId The item id.
|
|
159
|
+
* @param {UpdateUserItemDataDto} updateUserItemDataDto New user data object.
|
|
160
|
+
* @param {string} [userId] The user id.
|
|
161
|
+
* @param {*} [options] Override http request option.
|
|
162
|
+
* @throws {RequiredError}
|
|
163
|
+
*/
|
|
164
|
+
updateItemUserData: (itemId: string, updateUserItemDataDto: UpdateUserItemDataDto, userId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
234
165
|
};
|
|
235
166
|
/**
|
|
236
167
|
* ItemsApi - functional programming interface
|
|
@@ -239,100 +170,17 @@ export declare const ItemsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
239
170
|
export declare const ItemsApiFp: (configuration?: Configuration) => {
|
|
240
171
|
/**
|
|
241
172
|
*
|
|
242
|
-
* @summary
|
|
243
|
-
* @param {string}
|
|
244
|
-
* @param {string} [
|
|
245
|
-
* @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
|
|
246
|
-
* @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
|
|
247
|
-
* @param {boolean} [hasSubtitles] Optional filter by items with subtitles.
|
|
248
|
-
* @param {boolean} [hasSpecialFeature] Optional filter by items with special features.
|
|
249
|
-
* @param {boolean} [hasTrailer] Optional filter by items with trailers.
|
|
250
|
-
* @param {string} [adjacentTo] Optional. Return items that are siblings of a supplied item.
|
|
251
|
-
* @param {number} [parentIndexNumber] Optional filter by parent index number.
|
|
252
|
-
* @param {boolean} [hasParentalRating] Optional filter by items that have or do not have a parental rating.
|
|
253
|
-
* @param {boolean} [isHd] Optional filter by items that are HD or not.
|
|
254
|
-
* @param {boolean} [is4K] Optional filter by items that are 4K or not.
|
|
255
|
-
* @param {Array<LocationType>} [locationTypes] Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.
|
|
256
|
-
* @param {Array<LocationType>} [excludeLocationTypes] Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.
|
|
257
|
-
* @param {boolean} [isMissing] Optional filter by items that are missing episodes or not.
|
|
258
|
-
* @param {boolean} [isUnaired] Optional filter by items that are unaired episodes or not.
|
|
259
|
-
* @param {number} [minCommunityRating] Optional filter by minimum community rating.
|
|
260
|
-
* @param {number} [minCriticRating] Optional filter by minimum critic rating.
|
|
261
|
-
* @param {string} [minPremiereDate] Optional. The minimum premiere date. Format = ISO.
|
|
262
|
-
* @param {string} [minDateLastSaved] Optional. The minimum last saved date. Format = ISO.
|
|
263
|
-
* @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO.
|
|
264
|
-
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO.
|
|
265
|
-
* @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
|
|
266
|
-
* @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
|
|
267
|
-
* @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
|
|
268
|
-
* @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
|
|
269
|
-
* @param {boolean} [isMovie] Optional filter for live tv movies.
|
|
270
|
-
* @param {boolean} [isSeries] Optional filter for live tv series.
|
|
271
|
-
* @param {boolean} [isNews] Optional filter for live tv news.
|
|
272
|
-
* @param {boolean} [isKids] Optional filter for live tv kids.
|
|
273
|
-
* @param {boolean} [isSports] Optional filter for live tv sports.
|
|
274
|
-
* @param {Array<string>} [excludeItemIds] Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.
|
|
275
|
-
* @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
|
|
276
|
-
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
277
|
-
* @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
278
|
-
* @param {string} [searchTerm] Optional. Filter based on a search term.
|
|
279
|
-
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
280
|
-
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
281
|
-
* @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.
|
|
282
|
-
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
283
|
-
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
|
|
284
|
-
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
|
|
285
|
-
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
286
|
-
* @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
287
|
-
* @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
|
|
288
|
-
* @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
|
|
289
|
-
* @param {boolean} [isPlayed] Optional filter by items that are played, or not.
|
|
290
|
-
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
291
|
-
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
292
|
-
* @param {Array<string>} [tags] Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
|
|
293
|
-
* @param {Array<number>} [years] Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
|
|
294
|
-
* @param {boolean} [enableUserData] Optional, include user data.
|
|
295
|
-
* @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type.
|
|
296
|
-
* @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
|
|
297
|
-
* @param {string} [person] Optional. If specified, results will be filtered to include only those containing the specified person.
|
|
298
|
-
* @param {Array<string>} [personIds] Optional. If specified, results will be filtered to include only those containing the specified person id.
|
|
299
|
-
* @param {Array<string>} [personTypes] Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.
|
|
300
|
-
* @param {Array<string>} [studios] Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
|
|
301
|
-
* @param {Array<string>} [artists] Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.
|
|
302
|
-
* @param {Array<string>} [excludeArtistIds] Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.
|
|
303
|
-
* @param {Array<string>} [artistIds] Optional. If specified, results will be filtered to include only those containing the specified artist id.
|
|
304
|
-
* @param {Array<string>} [albumArtistIds] Optional. If specified, results will be filtered to include only those containing the specified album artist id.
|
|
305
|
-
* @param {Array<string>} [contributingArtistIds] Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.
|
|
306
|
-
* @param {Array<string>} [albums] Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.
|
|
307
|
-
* @param {Array<string>} [albumIds] Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.
|
|
308
|
-
* @param {Array<string>} [ids] Optional. If specific items are needed, specify a list of item id\'s to retrieve. This allows multiple, comma delimited.
|
|
309
|
-
* @param {Array<VideoType>} [videoTypes] Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.
|
|
310
|
-
* @param {string} [minOfficialRating] Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).
|
|
311
|
-
* @param {boolean} [isLocked] Optional filter by items that are locked.
|
|
312
|
-
* @param {boolean} [isPlaceHolder] Optional filter by items that are placeholders.
|
|
313
|
-
* @param {boolean} [hasOfficialRating] Optional filter by items that have official ratings.
|
|
314
|
-
* @param {boolean} [collapseBoxSetItems] Whether or not to hide items behind their boxsets.
|
|
315
|
-
* @param {number} [minWidth] Optional. Filter by the minimum width of the item.
|
|
316
|
-
* @param {number} [minHeight] Optional. Filter by the minimum height of the item.
|
|
317
|
-
* @param {number} [maxWidth] Optional. Filter by the maximum width of the item.
|
|
318
|
-
* @param {number} [maxHeight] Optional. Filter by the maximum height of the item.
|
|
319
|
-
* @param {boolean} [is3D] Optional filter by items that are 3D, or not.
|
|
320
|
-
* @param {Array<SeriesStatus>} [seriesStatus] Optional filter by Series Status. Allows multiple, comma delimited.
|
|
321
|
-
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
322
|
-
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
323
|
-
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
324
|
-
* @param {Array<string>} [studioIds] Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
|
|
325
|
-
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
326
|
-
* @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count.
|
|
327
|
-
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
173
|
+
* @summary Get Item User Data.
|
|
174
|
+
* @param {string} itemId The item id.
|
|
175
|
+
* @param {string} [userId] The user id.
|
|
328
176
|
* @param {*} [options] Override http request option.
|
|
329
177
|
* @throws {RequiredError}
|
|
330
178
|
*/
|
|
331
|
-
|
|
179
|
+
getItemUserData(itemId: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>;
|
|
332
180
|
/**
|
|
333
181
|
*
|
|
334
182
|
* @summary Gets items based on a query.
|
|
335
|
-
* @param {string} userId The user id supplied as query parameter.
|
|
183
|
+
* @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key.
|
|
336
184
|
* @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
|
|
337
185
|
* @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
|
|
338
186
|
* @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
|
|
@@ -355,9 +203,9 @@ export declare const ItemsApiFp: (configuration?: Configuration) => {
|
|
|
355
203
|
* @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO.
|
|
356
204
|
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO.
|
|
357
205
|
* @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
|
|
358
|
-
* @param {boolean} [hasImdbId] Optional filter by items that have an
|
|
359
|
-
* @param {boolean} [hasTmdbId] Optional filter by items that have a
|
|
360
|
-
* @param {boolean} [hasTvdbId] Optional filter by items that have a
|
|
206
|
+
* @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not.
|
|
207
|
+
* @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not.
|
|
208
|
+
* @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not.
|
|
361
209
|
* @param {boolean} [isMovie] Optional filter for live tv movies.
|
|
362
210
|
* @param {boolean} [isSeries] Optional filter for live tv series.
|
|
363
211
|
* @param {boolean} [isNews] Optional filter for live tv news.
|
|
@@ -368,16 +216,16 @@ export declare const ItemsApiFp: (configuration?: Configuration) => {
|
|
|
368
216
|
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
369
217
|
* @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
370
218
|
* @param {string} [searchTerm] Optional. Filter based on a search term.
|
|
371
|
-
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
219
|
+
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending, Descending.
|
|
372
220
|
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
373
221
|
* @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.
|
|
374
222
|
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
375
223
|
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
|
|
376
224
|
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
|
|
377
225
|
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
378
|
-
* @param {Array<
|
|
226
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
379
227
|
* @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
|
|
380
|
-
* @param {Array<
|
|
228
|
+
* @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.
|
|
381
229
|
* @param {boolean} [isPlayed] Optional filter by items that are played, or not.
|
|
382
230
|
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
383
231
|
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
@@ -420,17 +268,17 @@ export declare const ItemsApiFp: (configuration?: Configuration) => {
|
|
|
420
268
|
* @param {*} [options] Override http request option.
|
|
421
269
|
* @throws {RequiredError}
|
|
422
270
|
*/
|
|
423
|
-
|
|
271
|
+
getItems(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>, includeItemTypes?: 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>>;
|
|
424
272
|
/**
|
|
425
273
|
*
|
|
426
274
|
* @summary Gets items based on a query.
|
|
427
|
-
* @param {string} userId The user id.
|
|
275
|
+
* @param {string} [userId] The user id.
|
|
428
276
|
* @param {number} [startIndex] The start index.
|
|
429
277
|
* @param {number} [limit] The item limit.
|
|
430
278
|
* @param {string} [searchTerm] The search term.
|
|
431
279
|
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
432
280
|
* @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.
|
|
433
|
-
* @param {Array<
|
|
281
|
+
* @param {Array<MediaType>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
|
|
434
282
|
* @param {boolean} [enableUserData] Optional. Include user data.
|
|
435
283
|
* @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type.
|
|
436
284
|
* @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
|
|
@@ -442,1251 +290,690 @@ export declare const ItemsApiFp: (configuration?: Configuration) => {
|
|
|
442
290
|
* @param {*} [options] Override http request option.
|
|
443
291
|
* @throws {RequiredError}
|
|
444
292
|
*/
|
|
445
|
-
getResumeItems(userId
|
|
446
|
-
};
|
|
447
|
-
/**
|
|
448
|
-
* ItemsApi - factory interface
|
|
449
|
-
* @export
|
|
450
|
-
*/
|
|
451
|
-
export declare const ItemsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
293
|
+
getResumeItems(userId?: string, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, mediaTypes?: Array<MediaType>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, enableTotalRecordCount?: boolean, enableImages?: boolean, excludeActiveSessions?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
|
|
452
294
|
/**
|
|
453
295
|
*
|
|
454
|
-
* @summary
|
|
455
|
-
* @param {string}
|
|
456
|
-
* @param {
|
|
457
|
-
* @param {
|
|
458
|
-
* @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
|
|
459
|
-
* @param {boolean} [hasSubtitles] Optional filter by items with subtitles.
|
|
460
|
-
* @param {boolean} [hasSpecialFeature] Optional filter by items with special features.
|
|
461
|
-
* @param {boolean} [hasTrailer] Optional filter by items with trailers.
|
|
462
|
-
* @param {string} [adjacentTo] Optional. Return items that are siblings of a supplied item.
|
|
463
|
-
* @param {number} [parentIndexNumber] Optional filter by parent index number.
|
|
464
|
-
* @param {boolean} [hasParentalRating] Optional filter by items that have or do not have a parental rating.
|
|
465
|
-
* @param {boolean} [isHd] Optional filter by items that are HD or not.
|
|
466
|
-
* @param {boolean} [is4K] Optional filter by items that are 4K or not.
|
|
467
|
-
* @param {Array<LocationType>} [locationTypes] Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.
|
|
468
|
-
* @param {Array<LocationType>} [excludeLocationTypes] Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.
|
|
469
|
-
* @param {boolean} [isMissing] Optional filter by items that are missing episodes or not.
|
|
470
|
-
* @param {boolean} [isUnaired] Optional filter by items that are unaired episodes or not.
|
|
471
|
-
* @param {number} [minCommunityRating] Optional filter by minimum community rating.
|
|
472
|
-
* @param {number} [minCriticRating] Optional filter by minimum critic rating.
|
|
473
|
-
* @param {string} [minPremiereDate] Optional. The minimum premiere date. Format = ISO.
|
|
474
|
-
* @param {string} [minDateLastSaved] Optional. The minimum last saved date. Format = ISO.
|
|
475
|
-
* @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO.
|
|
476
|
-
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO.
|
|
477
|
-
* @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
|
|
478
|
-
* @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
|
|
479
|
-
* @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
|
|
480
|
-
* @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
|
|
481
|
-
* @param {boolean} [isMovie] Optional filter for live tv movies.
|
|
482
|
-
* @param {boolean} [isSeries] Optional filter for live tv series.
|
|
483
|
-
* @param {boolean} [isNews] Optional filter for live tv news.
|
|
484
|
-
* @param {boolean} [isKids] Optional filter for live tv kids.
|
|
485
|
-
* @param {boolean} [isSports] Optional filter for live tv sports.
|
|
486
|
-
* @param {Array<string>} [excludeItemIds] Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.
|
|
487
|
-
* @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
|
|
488
|
-
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
489
|
-
* @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
490
|
-
* @param {string} [searchTerm] Optional. Filter based on a search term.
|
|
491
|
-
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
492
|
-
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
493
|
-
* @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.
|
|
494
|
-
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
495
|
-
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
|
|
496
|
-
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
|
|
497
|
-
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
498
|
-
* @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
499
|
-
* @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
|
|
500
|
-
* @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
|
|
501
|
-
* @param {boolean} [isPlayed] Optional filter by items that are played, or not.
|
|
502
|
-
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
503
|
-
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
504
|
-
* @param {Array<string>} [tags] Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
|
|
505
|
-
* @param {Array<number>} [years] Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
|
|
506
|
-
* @param {boolean} [enableUserData] Optional, include user data.
|
|
507
|
-
* @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type.
|
|
508
|
-
* @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
|
|
509
|
-
* @param {string} [person] Optional. If specified, results will be filtered to include only those containing the specified person.
|
|
510
|
-
* @param {Array<string>} [personIds] Optional. If specified, results will be filtered to include only those containing the specified person id.
|
|
511
|
-
* @param {Array<string>} [personTypes] Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.
|
|
512
|
-
* @param {Array<string>} [studios] Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
|
|
513
|
-
* @param {Array<string>} [artists] Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.
|
|
514
|
-
* @param {Array<string>} [excludeArtistIds] Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.
|
|
515
|
-
* @param {Array<string>} [artistIds] Optional. If specified, results will be filtered to include only those containing the specified artist id.
|
|
516
|
-
* @param {Array<string>} [albumArtistIds] Optional. If specified, results will be filtered to include only those containing the specified album artist id.
|
|
517
|
-
* @param {Array<string>} [contributingArtistIds] Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.
|
|
518
|
-
* @param {Array<string>} [albums] Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.
|
|
519
|
-
* @param {Array<string>} [albumIds] Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.
|
|
520
|
-
* @param {Array<string>} [ids] Optional. If specific items are needed, specify a list of item id\'s to retrieve. This allows multiple, comma delimited.
|
|
521
|
-
* @param {Array<VideoType>} [videoTypes] Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.
|
|
522
|
-
* @param {string} [minOfficialRating] Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).
|
|
523
|
-
* @param {boolean} [isLocked] Optional filter by items that are locked.
|
|
524
|
-
* @param {boolean} [isPlaceHolder] Optional filter by items that are placeholders.
|
|
525
|
-
* @param {boolean} [hasOfficialRating] Optional filter by items that have official ratings.
|
|
526
|
-
* @param {boolean} [collapseBoxSetItems] Whether or not to hide items behind their boxsets.
|
|
527
|
-
* @param {number} [minWidth] Optional. Filter by the minimum width of the item.
|
|
528
|
-
* @param {number} [minHeight] Optional. Filter by the minimum height of the item.
|
|
529
|
-
* @param {number} [maxWidth] Optional. Filter by the maximum width of the item.
|
|
530
|
-
* @param {number} [maxHeight] Optional. Filter by the maximum height of the item.
|
|
531
|
-
* @param {boolean} [is3D] Optional filter by items that are 3D, or not.
|
|
532
|
-
* @param {Array<SeriesStatus>} [seriesStatus] Optional filter by Series Status. Allows multiple, comma delimited.
|
|
533
|
-
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
534
|
-
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
535
|
-
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
536
|
-
* @param {Array<string>} [studioIds] Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
|
|
537
|
-
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
538
|
-
* @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count.
|
|
539
|
-
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
296
|
+
* @summary Update Item User Data.
|
|
297
|
+
* @param {string} itemId The item id.
|
|
298
|
+
* @param {UpdateUserItemDataDto} updateUserItemDataDto New user data object.
|
|
299
|
+
* @param {string} [userId] The user id.
|
|
540
300
|
* @param {*} [options] Override http request option.
|
|
541
301
|
* @throws {RequiredError}
|
|
542
302
|
*/
|
|
543
|
-
|
|
544
|
-
/**
|
|
545
|
-
*
|
|
546
|
-
* @summary Gets items based on a query.
|
|
547
|
-
* @param {string} userId The user id supplied as query parameter.
|
|
548
|
-
* @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
|
|
549
|
-
* @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
|
|
550
|
-
* @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
|
|
551
|
-
* @param {boolean} [hasSubtitles] Optional filter by items with subtitles.
|
|
552
|
-
* @param {boolean} [hasSpecialFeature] Optional filter by items with special features.
|
|
553
|
-
* @param {boolean} [hasTrailer] Optional filter by items with trailers.
|
|
554
|
-
* @param {string} [adjacentTo] Optional. Return items that are siblings of a supplied item.
|
|
555
|
-
* @param {number} [parentIndexNumber] Optional filter by parent index number.
|
|
556
|
-
* @param {boolean} [hasParentalRating] Optional filter by items that have or do not have a parental rating.
|
|
557
|
-
* @param {boolean} [isHd] Optional filter by items that are HD or not.
|
|
558
|
-
* @param {boolean} [is4K] Optional filter by items that are 4K or not.
|
|
559
|
-
* @param {Array<LocationType>} [locationTypes] Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.
|
|
560
|
-
* @param {Array<LocationType>} [excludeLocationTypes] Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.
|
|
561
|
-
* @param {boolean} [isMissing] Optional filter by items that are missing episodes or not.
|
|
562
|
-
* @param {boolean} [isUnaired] Optional filter by items that are unaired episodes or not.
|
|
563
|
-
* @param {number} [minCommunityRating] Optional filter by minimum community rating.
|
|
564
|
-
* @param {number} [minCriticRating] Optional filter by minimum critic rating.
|
|
565
|
-
* @param {string} [minPremiereDate] Optional. The minimum premiere date. Format = ISO.
|
|
566
|
-
* @param {string} [minDateLastSaved] Optional. The minimum last saved date. Format = ISO.
|
|
567
|
-
* @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO.
|
|
568
|
-
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO.
|
|
569
|
-
* @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
|
|
570
|
-
* @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not.
|
|
571
|
-
* @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not.
|
|
572
|
-
* @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not.
|
|
573
|
-
* @param {boolean} [isMovie] Optional filter for live tv movies.
|
|
574
|
-
* @param {boolean} [isSeries] Optional filter for live tv series.
|
|
575
|
-
* @param {boolean} [isNews] Optional filter for live tv news.
|
|
576
|
-
* @param {boolean} [isKids] Optional filter for live tv kids.
|
|
577
|
-
* @param {boolean} [isSports] Optional filter for live tv sports.
|
|
578
|
-
* @param {Array<string>} [excludeItemIds] Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.
|
|
579
|
-
* @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
|
|
580
|
-
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
581
|
-
* @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
582
|
-
* @param {string} [searchTerm] Optional. Filter based on a search term.
|
|
583
|
-
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
|
|
584
|
-
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
585
|
-
* @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.
|
|
586
|
-
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
587
|
-
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
|
|
588
|
-
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
|
|
589
|
-
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
590
|
-
* @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
591
|
-
* @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
|
|
592
|
-
* @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
|
|
593
|
-
* @param {boolean} [isPlayed] Optional filter by items that are played, or not.
|
|
594
|
-
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
595
|
-
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
596
|
-
* @param {Array<string>} [tags] Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
|
|
597
|
-
* @param {Array<number>} [years] Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
|
|
598
|
-
* @param {boolean} [enableUserData] Optional, include user data.
|
|
599
|
-
* @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type.
|
|
600
|
-
* @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
|
|
601
|
-
* @param {string} [person] Optional. If specified, results will be filtered to include only those containing the specified person.
|
|
602
|
-
* @param {Array<string>} [personIds] Optional. If specified, results will be filtered to include only those containing the specified person id.
|
|
603
|
-
* @param {Array<string>} [personTypes] Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.
|
|
604
|
-
* @param {Array<string>} [studios] Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
|
|
605
|
-
* @param {Array<string>} [artists] Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.
|
|
606
|
-
* @param {Array<string>} [excludeArtistIds] Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.
|
|
607
|
-
* @param {Array<string>} [artistIds] Optional. If specified, results will be filtered to include only those containing the specified artist id.
|
|
608
|
-
* @param {Array<string>} [albumArtistIds] Optional. If specified, results will be filtered to include only those containing the specified album artist id.
|
|
609
|
-
* @param {Array<string>} [contributingArtistIds] Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.
|
|
610
|
-
* @param {Array<string>} [albums] Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.
|
|
611
|
-
* @param {Array<string>} [albumIds] Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.
|
|
612
|
-
* @param {Array<string>} [ids] Optional. If specific items are needed, specify a list of item id\'s to retrieve. This allows multiple, comma delimited.
|
|
613
|
-
* @param {Array<VideoType>} [videoTypes] Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.
|
|
614
|
-
* @param {string} [minOfficialRating] Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).
|
|
615
|
-
* @param {boolean} [isLocked] Optional filter by items that are locked.
|
|
616
|
-
* @param {boolean} [isPlaceHolder] Optional filter by items that are placeholders.
|
|
617
|
-
* @param {boolean} [hasOfficialRating] Optional filter by items that have official ratings.
|
|
618
|
-
* @param {boolean} [collapseBoxSetItems] Whether or not to hide items behind their boxsets.
|
|
619
|
-
* @param {number} [minWidth] Optional. Filter by the minimum width of the item.
|
|
620
|
-
* @param {number} [minHeight] Optional. Filter by the minimum height of the item.
|
|
621
|
-
* @param {number} [maxWidth] Optional. Filter by the maximum width of the item.
|
|
622
|
-
* @param {number} [maxHeight] Optional. Filter by the maximum height of the item.
|
|
623
|
-
* @param {boolean} [is3D] Optional filter by items that are 3D, or not.
|
|
624
|
-
* @param {Array<SeriesStatus>} [seriesStatus] Optional filter by Series Status. Allows multiple, comma delimited.
|
|
625
|
-
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
626
|
-
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
627
|
-
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
628
|
-
* @param {Array<string>} [studioIds] Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
|
|
629
|
-
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
630
|
-
* @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count.
|
|
631
|
-
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
632
|
-
* @param {*} [options] Override http request option.
|
|
633
|
-
* @throws {RequiredError}
|
|
634
|
-
*/
|
|
635
|
-
getItemsByUserId(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>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<string>, imageTypes?: Array<ImageType>, sortBy?: Array<string>, 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>;
|
|
636
|
-
/**
|
|
637
|
-
*
|
|
638
|
-
* @summary Gets items based on a query.
|
|
639
|
-
* @param {string} userId The user id.
|
|
640
|
-
* @param {number} [startIndex] The start index.
|
|
641
|
-
* @param {number} [limit] The item limit.
|
|
642
|
-
* @param {string} [searchTerm] The search term.
|
|
643
|
-
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
644
|
-
* @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.
|
|
645
|
-
* @param {Array<string>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
|
|
646
|
-
* @param {boolean} [enableUserData] Optional. Include user data.
|
|
647
|
-
* @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type.
|
|
648
|
-
* @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
|
|
649
|
-
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
650
|
-
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
|
|
651
|
-
* @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count.
|
|
652
|
-
* @param {boolean} [enableImages] Optional. Include image information in output.
|
|
653
|
-
* @param {boolean} [excludeActiveSessions] Optional. Whether to exclude the currently active sessions.
|
|
654
|
-
* @param {*} [options] Override http request option.
|
|
655
|
-
* @throws {RequiredError}
|
|
656
|
-
*/
|
|
657
|
-
getResumeItems(userId: string, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, mediaTypes?: Array<string>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, enableTotalRecordCount?: boolean, enableImages?: boolean, excludeActiveSessions?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>;
|
|
303
|
+
updateItemUserData(itemId: string, updateUserItemDataDto: UpdateUserItemDataDto, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>;
|
|
658
304
|
};
|
|
659
305
|
/**
|
|
660
|
-
*
|
|
661
|
-
* @export
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
export interface ItemsApiGetItemsRequest {
|
|
665
|
-
/**
|
|
666
|
-
* The user id supplied as query parameter.
|
|
667
|
-
* @type {string}
|
|
668
|
-
* @memberof ItemsApiGetItems
|
|
669
|
-
*/
|
|
670
|
-
readonly userId?: string;
|
|
671
|
-
/**
|
|
672
|
-
* Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
|
|
673
|
-
* @type {string}
|
|
674
|
-
* @memberof ItemsApiGetItems
|
|
675
|
-
*/
|
|
676
|
-
readonly maxOfficialRating?: string;
|
|
677
|
-
/**
|
|
678
|
-
* Optional filter by items with theme songs.
|
|
679
|
-
* @type {boolean}
|
|
680
|
-
* @memberof ItemsApiGetItems
|
|
681
|
-
*/
|
|
682
|
-
readonly hasThemeSong?: boolean;
|
|
683
|
-
/**
|
|
684
|
-
* Optional filter by items with theme videos.
|
|
685
|
-
* @type {boolean}
|
|
686
|
-
* @memberof ItemsApiGetItems
|
|
687
|
-
*/
|
|
688
|
-
readonly hasThemeVideo?: boolean;
|
|
689
|
-
/**
|
|
690
|
-
* Optional filter by items with subtitles.
|
|
691
|
-
* @type {boolean}
|
|
692
|
-
* @memberof ItemsApiGetItems
|
|
693
|
-
*/
|
|
694
|
-
readonly hasSubtitles?: boolean;
|
|
695
|
-
/**
|
|
696
|
-
* Optional filter by items with special features.
|
|
697
|
-
* @type {boolean}
|
|
698
|
-
* @memberof ItemsApiGetItems
|
|
699
|
-
*/
|
|
700
|
-
readonly hasSpecialFeature?: boolean;
|
|
701
|
-
/**
|
|
702
|
-
* Optional filter by items with trailers.
|
|
703
|
-
* @type {boolean}
|
|
704
|
-
* @memberof ItemsApiGetItems
|
|
705
|
-
*/
|
|
706
|
-
readonly hasTrailer?: boolean;
|
|
707
|
-
/**
|
|
708
|
-
* Optional. Return items that are siblings of a supplied item.
|
|
709
|
-
* @type {string}
|
|
710
|
-
* @memberof ItemsApiGetItems
|
|
711
|
-
*/
|
|
712
|
-
readonly adjacentTo?: string;
|
|
713
|
-
/**
|
|
714
|
-
* Optional filter by parent index number.
|
|
715
|
-
* @type {number}
|
|
716
|
-
* @memberof ItemsApiGetItems
|
|
717
|
-
*/
|
|
718
|
-
readonly parentIndexNumber?: number;
|
|
719
|
-
/**
|
|
720
|
-
* Optional filter by items that have or do not have a parental rating.
|
|
721
|
-
* @type {boolean}
|
|
722
|
-
* @memberof ItemsApiGetItems
|
|
723
|
-
*/
|
|
724
|
-
readonly hasParentalRating?: boolean;
|
|
725
|
-
/**
|
|
726
|
-
* Optional filter by items that are HD or not.
|
|
727
|
-
* @type {boolean}
|
|
728
|
-
* @memberof ItemsApiGetItems
|
|
729
|
-
*/
|
|
730
|
-
readonly isHd?: boolean;
|
|
731
|
-
/**
|
|
732
|
-
* Optional filter by items that are 4K or not.
|
|
733
|
-
* @type {boolean}
|
|
734
|
-
* @memberof ItemsApiGetItems
|
|
735
|
-
*/
|
|
736
|
-
readonly is4K?: boolean;
|
|
737
|
-
/**
|
|
738
|
-
* Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.
|
|
739
|
-
* @type {Array<LocationType>}
|
|
740
|
-
* @memberof ItemsApiGetItems
|
|
741
|
-
*/
|
|
742
|
-
readonly locationTypes?: Array<LocationType>;
|
|
743
|
-
/**
|
|
744
|
-
* Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.
|
|
745
|
-
* @type {Array<LocationType>}
|
|
746
|
-
* @memberof ItemsApiGetItems
|
|
747
|
-
*/
|
|
748
|
-
readonly excludeLocationTypes?: Array<LocationType>;
|
|
749
|
-
/**
|
|
750
|
-
* Optional filter by items that are missing episodes or not.
|
|
751
|
-
* @type {boolean}
|
|
752
|
-
* @memberof ItemsApiGetItems
|
|
753
|
-
*/
|
|
754
|
-
readonly isMissing?: boolean;
|
|
755
|
-
/**
|
|
756
|
-
* Optional filter by items that are unaired episodes or not.
|
|
757
|
-
* @type {boolean}
|
|
758
|
-
* @memberof ItemsApiGetItems
|
|
759
|
-
*/
|
|
760
|
-
readonly isUnaired?: boolean;
|
|
761
|
-
/**
|
|
762
|
-
* Optional filter by minimum community rating.
|
|
763
|
-
* @type {number}
|
|
764
|
-
* @memberof ItemsApiGetItems
|
|
765
|
-
*/
|
|
766
|
-
readonly minCommunityRating?: number;
|
|
767
|
-
/**
|
|
768
|
-
* Optional filter by minimum critic rating.
|
|
769
|
-
* @type {number}
|
|
770
|
-
* @memberof ItemsApiGetItems
|
|
771
|
-
*/
|
|
772
|
-
readonly minCriticRating?: number;
|
|
773
|
-
/**
|
|
774
|
-
* Optional. The minimum premiere date. Format = ISO.
|
|
775
|
-
* @type {string}
|
|
776
|
-
* @memberof ItemsApiGetItems
|
|
777
|
-
*/
|
|
778
|
-
readonly minPremiereDate?: string;
|
|
779
|
-
/**
|
|
780
|
-
* Optional. The minimum last saved date. Format = ISO.
|
|
781
|
-
* @type {string}
|
|
782
|
-
* @memberof ItemsApiGetItems
|
|
783
|
-
*/
|
|
784
|
-
readonly minDateLastSaved?: string;
|
|
785
|
-
/**
|
|
786
|
-
* Optional. The minimum last saved date for the current user. Format = ISO.
|
|
787
|
-
* @type {string}
|
|
788
|
-
* @memberof ItemsApiGetItems
|
|
789
|
-
*/
|
|
790
|
-
readonly minDateLastSavedForUser?: string;
|
|
791
|
-
/**
|
|
792
|
-
* Optional. The maximum premiere date. Format = ISO.
|
|
793
|
-
* @type {string}
|
|
794
|
-
* @memberof ItemsApiGetItems
|
|
795
|
-
*/
|
|
796
|
-
readonly maxPremiereDate?: string;
|
|
797
|
-
/**
|
|
798
|
-
* Optional filter by items that have an overview or not.
|
|
799
|
-
* @type {boolean}
|
|
800
|
-
* @memberof ItemsApiGetItems
|
|
801
|
-
*/
|
|
802
|
-
readonly hasOverview?: boolean;
|
|
803
|
-
/**
|
|
804
|
-
* Optional filter by items that have an imdb id or not.
|
|
805
|
-
* @type {boolean}
|
|
806
|
-
* @memberof ItemsApiGetItems
|
|
807
|
-
*/
|
|
808
|
-
readonly hasImdbId?: boolean;
|
|
809
|
-
/**
|
|
810
|
-
* Optional filter by items that have a tmdb id or not.
|
|
811
|
-
* @type {boolean}
|
|
812
|
-
* @memberof ItemsApiGetItems
|
|
813
|
-
*/
|
|
814
|
-
readonly hasTmdbId?: boolean;
|
|
815
|
-
/**
|
|
816
|
-
* Optional filter by items that have a tvdb id or not.
|
|
817
|
-
* @type {boolean}
|
|
818
|
-
* @memberof ItemsApiGetItems
|
|
819
|
-
*/
|
|
820
|
-
readonly hasTvdbId?: boolean;
|
|
821
|
-
/**
|
|
822
|
-
* Optional filter for live tv movies.
|
|
823
|
-
* @type {boolean}
|
|
824
|
-
* @memberof ItemsApiGetItems
|
|
825
|
-
*/
|
|
826
|
-
readonly isMovie?: boolean;
|
|
827
|
-
/**
|
|
828
|
-
* Optional filter for live tv series.
|
|
829
|
-
* @type {boolean}
|
|
830
|
-
* @memberof ItemsApiGetItems
|
|
831
|
-
*/
|
|
832
|
-
readonly isSeries?: boolean;
|
|
833
|
-
/**
|
|
834
|
-
* Optional filter for live tv news.
|
|
835
|
-
* @type {boolean}
|
|
836
|
-
* @memberof ItemsApiGetItems
|
|
837
|
-
*/
|
|
838
|
-
readonly isNews?: boolean;
|
|
839
|
-
/**
|
|
840
|
-
* Optional filter for live tv kids.
|
|
841
|
-
* @type {boolean}
|
|
842
|
-
* @memberof ItemsApiGetItems
|
|
843
|
-
*/
|
|
844
|
-
readonly isKids?: boolean;
|
|
845
|
-
/**
|
|
846
|
-
* Optional filter for live tv sports.
|
|
847
|
-
* @type {boolean}
|
|
848
|
-
* @memberof ItemsApiGetItems
|
|
849
|
-
*/
|
|
850
|
-
readonly isSports?: boolean;
|
|
851
|
-
/**
|
|
852
|
-
* Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.
|
|
853
|
-
* @type {Array<string>}
|
|
854
|
-
* @memberof ItemsApiGetItems
|
|
855
|
-
*/
|
|
856
|
-
readonly excludeItemIds?: Array<string>;
|
|
857
|
-
/**
|
|
858
|
-
* Optional. The record index to start at. All items with a lower index will be dropped from the results.
|
|
859
|
-
* @type {number}
|
|
860
|
-
* @memberof ItemsApiGetItems
|
|
861
|
-
*/
|
|
862
|
-
readonly startIndex?: number;
|
|
863
|
-
/**
|
|
864
|
-
* Optional. The maximum number of records to return.
|
|
865
|
-
* @type {number}
|
|
866
|
-
* @memberof ItemsApiGetItems
|
|
867
|
-
*/
|
|
868
|
-
readonly limit?: number;
|
|
869
|
-
/**
|
|
870
|
-
* When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
871
|
-
* @type {boolean}
|
|
872
|
-
* @memberof ItemsApiGetItems
|
|
873
|
-
*/
|
|
874
|
-
readonly recursive?: boolean;
|
|
875
|
-
/**
|
|
876
|
-
* Optional. Filter based on a search term.
|
|
877
|
-
* @type {string}
|
|
878
|
-
* @memberof ItemsApiGetItems
|
|
879
|
-
*/
|
|
880
|
-
readonly searchTerm?: string;
|
|
881
|
-
/**
|
|
882
|
-
* Sort Order - Ascending,Descending.
|
|
883
|
-
* @type {Array<SortOrder>}
|
|
884
|
-
* @memberof ItemsApiGetItems
|
|
885
|
-
*/
|
|
886
|
-
readonly sortOrder?: Array<SortOrder>;
|
|
887
|
-
/**
|
|
888
|
-
* Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
889
|
-
* @type {string}
|
|
890
|
-
* @memberof ItemsApiGetItems
|
|
891
|
-
*/
|
|
892
|
-
readonly parentId?: string;
|
|
893
|
-
/**
|
|
894
|
-
* 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.
|
|
895
|
-
* @type {Array<ItemFields>}
|
|
896
|
-
* @memberof ItemsApiGetItems
|
|
897
|
-
*/
|
|
898
|
-
readonly fields?: Array<ItemFields>;
|
|
899
|
-
/**
|
|
900
|
-
* Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
901
|
-
* @type {Array<BaseItemKind>}
|
|
902
|
-
* @memberof ItemsApiGetItems
|
|
903
|
-
*/
|
|
904
|
-
readonly excludeItemTypes?: Array<BaseItemKind>;
|
|
905
|
-
/**
|
|
906
|
-
* Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
|
|
907
|
-
* @type {Array<BaseItemKind>}
|
|
908
|
-
* @memberof ItemsApiGetItems
|
|
909
|
-
*/
|
|
910
|
-
readonly includeItemTypes?: Array<BaseItemKind>;
|
|
911
|
-
/**
|
|
912
|
-
* Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
|
|
913
|
-
* @type {Array<ItemFilter>}
|
|
914
|
-
* @memberof ItemsApiGetItems
|
|
915
|
-
*/
|
|
916
|
-
readonly filters?: Array<ItemFilter>;
|
|
917
|
-
/**
|
|
918
|
-
* Optional filter by items that are marked as favorite, or not.
|
|
919
|
-
* @type {boolean}
|
|
920
|
-
* @memberof ItemsApiGetItems
|
|
921
|
-
*/
|
|
922
|
-
readonly isFavorite?: boolean;
|
|
923
|
-
/**
|
|
924
|
-
* Optional filter by MediaType. Allows multiple, comma delimited.
|
|
925
|
-
* @type {Array<string>}
|
|
926
|
-
* @memberof ItemsApiGetItems
|
|
927
|
-
*/
|
|
928
|
-
readonly mediaTypes?: Array<string>;
|
|
929
|
-
/**
|
|
930
|
-
* Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
|
|
931
|
-
* @type {Array<ImageType>}
|
|
932
|
-
* @memberof ItemsApiGetItems
|
|
933
|
-
*/
|
|
934
|
-
readonly imageTypes?: Array<ImageType>;
|
|
935
|
-
/**
|
|
936
|
-
* 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.
|
|
937
|
-
* @type {Array<string>}
|
|
938
|
-
* @memberof ItemsApiGetItems
|
|
939
|
-
*/
|
|
940
|
-
readonly sortBy?: Array<string>;
|
|
941
|
-
/**
|
|
942
|
-
* Optional filter by items that are played, or not.
|
|
943
|
-
* @type {boolean}
|
|
944
|
-
* @memberof ItemsApiGetItems
|
|
945
|
-
*/
|
|
946
|
-
readonly isPlayed?: boolean;
|
|
947
|
-
/**
|
|
948
|
-
* Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
949
|
-
* @type {Array<string>}
|
|
950
|
-
* @memberof ItemsApiGetItems
|
|
951
|
-
*/
|
|
952
|
-
readonly genres?: Array<string>;
|
|
953
|
-
/**
|
|
954
|
-
* Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
955
|
-
* @type {Array<string>}
|
|
956
|
-
* @memberof ItemsApiGetItems
|
|
957
|
-
*/
|
|
958
|
-
readonly officialRatings?: Array<string>;
|
|
959
|
-
/**
|
|
960
|
-
* Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
|
|
961
|
-
* @type {Array<string>}
|
|
962
|
-
* @memberof ItemsApiGetItems
|
|
963
|
-
*/
|
|
964
|
-
readonly tags?: Array<string>;
|
|
965
|
-
/**
|
|
966
|
-
* Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
|
|
967
|
-
* @type {Array<number>}
|
|
968
|
-
* @memberof ItemsApiGetItems
|
|
969
|
-
*/
|
|
970
|
-
readonly years?: Array<number>;
|
|
971
|
-
/**
|
|
972
|
-
* Optional, include user data.
|
|
973
|
-
* @type {boolean}
|
|
974
|
-
* @memberof ItemsApiGetItems
|
|
975
|
-
*/
|
|
976
|
-
readonly enableUserData?: boolean;
|
|
977
|
-
/**
|
|
978
|
-
* Optional, the max number of images to return, per image type.
|
|
979
|
-
* @type {number}
|
|
980
|
-
* @memberof ItemsApiGetItems
|
|
981
|
-
*/
|
|
982
|
-
readonly imageTypeLimit?: number;
|
|
983
|
-
/**
|
|
984
|
-
* Optional. The image types to include in the output.
|
|
985
|
-
* @type {Array<ImageType>}
|
|
986
|
-
* @memberof ItemsApiGetItems
|
|
987
|
-
*/
|
|
988
|
-
readonly enableImageTypes?: Array<ImageType>;
|
|
989
|
-
/**
|
|
990
|
-
* Optional. If specified, results will be filtered to include only those containing the specified person.
|
|
991
|
-
* @type {string}
|
|
992
|
-
* @memberof ItemsApiGetItems
|
|
993
|
-
*/
|
|
994
|
-
readonly person?: string;
|
|
995
|
-
/**
|
|
996
|
-
* Optional. If specified, results will be filtered to include only those containing the specified person id.
|
|
997
|
-
* @type {Array<string>}
|
|
998
|
-
* @memberof ItemsApiGetItems
|
|
999
|
-
*/
|
|
1000
|
-
readonly personIds?: Array<string>;
|
|
1001
|
-
/**
|
|
1002
|
-
* Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.
|
|
1003
|
-
* @type {Array<string>}
|
|
1004
|
-
* @memberof ItemsApiGetItems
|
|
1005
|
-
*/
|
|
1006
|
-
readonly personTypes?: Array<string>;
|
|
1007
|
-
/**
|
|
1008
|
-
* Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
|
|
1009
|
-
* @type {Array<string>}
|
|
1010
|
-
* @memberof ItemsApiGetItems
|
|
1011
|
-
*/
|
|
1012
|
-
readonly studios?: Array<string>;
|
|
1013
|
-
/**
|
|
1014
|
-
* Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.
|
|
1015
|
-
* @type {Array<string>}
|
|
1016
|
-
* @memberof ItemsApiGetItems
|
|
1017
|
-
*/
|
|
1018
|
-
readonly artists?: Array<string>;
|
|
1019
|
-
/**
|
|
1020
|
-
* Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.
|
|
1021
|
-
* @type {Array<string>}
|
|
1022
|
-
* @memberof ItemsApiGetItems
|
|
1023
|
-
*/
|
|
1024
|
-
readonly excludeArtistIds?: Array<string>;
|
|
1025
|
-
/**
|
|
1026
|
-
* Optional. If specified, results will be filtered to include only those containing the specified artist id.
|
|
1027
|
-
* @type {Array<string>}
|
|
1028
|
-
* @memberof ItemsApiGetItems
|
|
1029
|
-
*/
|
|
1030
|
-
readonly artistIds?: Array<string>;
|
|
1031
|
-
/**
|
|
1032
|
-
* Optional. If specified, results will be filtered to include only those containing the specified album artist id.
|
|
1033
|
-
* @type {Array<string>}
|
|
1034
|
-
* @memberof ItemsApiGetItems
|
|
1035
|
-
*/
|
|
1036
|
-
readonly albumArtistIds?: Array<string>;
|
|
1037
|
-
/**
|
|
1038
|
-
* Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.
|
|
1039
|
-
* @type {Array<string>}
|
|
1040
|
-
* @memberof ItemsApiGetItems
|
|
1041
|
-
*/
|
|
1042
|
-
readonly contributingArtistIds?: Array<string>;
|
|
1043
|
-
/**
|
|
1044
|
-
* Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.
|
|
1045
|
-
* @type {Array<string>}
|
|
1046
|
-
* @memberof ItemsApiGetItems
|
|
1047
|
-
*/
|
|
1048
|
-
readonly albums?: Array<string>;
|
|
1049
|
-
/**
|
|
1050
|
-
* Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.
|
|
1051
|
-
* @type {Array<string>}
|
|
1052
|
-
* @memberof ItemsApiGetItems
|
|
1053
|
-
*/
|
|
1054
|
-
readonly albumIds?: Array<string>;
|
|
1055
|
-
/**
|
|
1056
|
-
* Optional. If specific items are needed, specify a list of item id\'s to retrieve. This allows multiple, comma delimited.
|
|
1057
|
-
* @type {Array<string>}
|
|
1058
|
-
* @memberof ItemsApiGetItems
|
|
1059
|
-
*/
|
|
1060
|
-
readonly ids?: Array<string>;
|
|
1061
|
-
/**
|
|
1062
|
-
* Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.
|
|
1063
|
-
* @type {Array<VideoType>}
|
|
1064
|
-
* @memberof ItemsApiGetItems
|
|
1065
|
-
*/
|
|
1066
|
-
readonly videoTypes?: Array<VideoType>;
|
|
1067
|
-
/**
|
|
1068
|
-
* Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).
|
|
1069
|
-
* @type {string}
|
|
1070
|
-
* @memberof ItemsApiGetItems
|
|
1071
|
-
*/
|
|
1072
|
-
readonly minOfficialRating?: string;
|
|
1073
|
-
/**
|
|
1074
|
-
* Optional filter by items that are locked.
|
|
1075
|
-
* @type {boolean}
|
|
1076
|
-
* @memberof ItemsApiGetItems
|
|
1077
|
-
*/
|
|
1078
|
-
readonly isLocked?: boolean;
|
|
1079
|
-
/**
|
|
1080
|
-
* Optional filter by items that are placeholders.
|
|
1081
|
-
* @type {boolean}
|
|
1082
|
-
* @memberof ItemsApiGetItems
|
|
1083
|
-
*/
|
|
1084
|
-
readonly isPlaceHolder?: boolean;
|
|
1085
|
-
/**
|
|
1086
|
-
* Optional filter by items that have official ratings.
|
|
1087
|
-
* @type {boolean}
|
|
1088
|
-
* @memberof ItemsApiGetItems
|
|
1089
|
-
*/
|
|
1090
|
-
readonly hasOfficialRating?: boolean;
|
|
1091
|
-
/**
|
|
1092
|
-
* Whether or not to hide items behind their boxsets.
|
|
1093
|
-
* @type {boolean}
|
|
1094
|
-
* @memberof ItemsApiGetItems
|
|
1095
|
-
*/
|
|
1096
|
-
readonly collapseBoxSetItems?: boolean;
|
|
1097
|
-
/**
|
|
1098
|
-
* Optional. Filter by the minimum width of the item.
|
|
1099
|
-
* @type {number}
|
|
1100
|
-
* @memberof ItemsApiGetItems
|
|
1101
|
-
*/
|
|
1102
|
-
readonly minWidth?: number;
|
|
1103
|
-
/**
|
|
1104
|
-
* Optional. Filter by the minimum height of the item.
|
|
1105
|
-
* @type {number}
|
|
1106
|
-
* @memberof ItemsApiGetItems
|
|
1107
|
-
*/
|
|
1108
|
-
readonly minHeight?: number;
|
|
1109
|
-
/**
|
|
1110
|
-
* Optional. Filter by the maximum width of the item.
|
|
1111
|
-
* @type {number}
|
|
1112
|
-
* @memberof ItemsApiGetItems
|
|
1113
|
-
*/
|
|
1114
|
-
readonly maxWidth?: number;
|
|
1115
|
-
/**
|
|
1116
|
-
* Optional. Filter by the maximum height of the item.
|
|
1117
|
-
* @type {number}
|
|
1118
|
-
* @memberof ItemsApiGetItems
|
|
1119
|
-
*/
|
|
1120
|
-
readonly maxHeight?: number;
|
|
1121
|
-
/**
|
|
1122
|
-
* Optional filter by items that are 3D, or not.
|
|
1123
|
-
* @type {boolean}
|
|
1124
|
-
* @memberof ItemsApiGetItems
|
|
1125
|
-
*/
|
|
1126
|
-
readonly is3D?: boolean;
|
|
1127
|
-
/**
|
|
1128
|
-
* Optional filter by Series Status. Allows multiple, comma delimited.
|
|
1129
|
-
* @type {Array<SeriesStatus>}
|
|
1130
|
-
* @memberof ItemsApiGetItems
|
|
1131
|
-
*/
|
|
1132
|
-
readonly seriesStatus?: Array<SeriesStatus>;
|
|
1133
|
-
/**
|
|
1134
|
-
* Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
1135
|
-
* @type {string}
|
|
1136
|
-
* @memberof ItemsApiGetItems
|
|
1137
|
-
*/
|
|
1138
|
-
readonly nameStartsWithOrGreater?: string;
|
|
306
|
+
* ItemsApi - factory interface
|
|
307
|
+
* @export
|
|
308
|
+
*/
|
|
309
|
+
export declare const ItemsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1139
310
|
/**
|
|
1140
|
-
*
|
|
1141
|
-
* @
|
|
1142
|
-
* @
|
|
311
|
+
*
|
|
312
|
+
* @summary Get Item User Data.
|
|
313
|
+
* @param {string} itemId The item id.
|
|
314
|
+
* @param {string} [userId] The user id.
|
|
315
|
+
* @param {*} [options] Override http request option.
|
|
316
|
+
* @throws {RequiredError}
|
|
1143
317
|
*/
|
|
1144
|
-
|
|
318
|
+
getItemUserData(itemId: string, userId?: string, options?: any): AxiosPromise<UserItemDataDto>;
|
|
1145
319
|
/**
|
|
1146
|
-
*
|
|
1147
|
-
* @
|
|
1148
|
-
* @
|
|
320
|
+
*
|
|
321
|
+
* @summary Gets items based on a query.
|
|
322
|
+
* @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key.
|
|
323
|
+
* @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
|
|
324
|
+
* @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
|
|
325
|
+
* @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
|
|
326
|
+
* @param {boolean} [hasSubtitles] Optional filter by items with subtitles.
|
|
327
|
+
* @param {boolean} [hasSpecialFeature] Optional filter by items with special features.
|
|
328
|
+
* @param {boolean} [hasTrailer] Optional filter by items with trailers.
|
|
329
|
+
* @param {string} [adjacentTo] Optional. Return items that are siblings of a supplied item.
|
|
330
|
+
* @param {number} [parentIndexNumber] Optional filter by parent index number.
|
|
331
|
+
* @param {boolean} [hasParentalRating] Optional filter by items that have or do not have a parental rating.
|
|
332
|
+
* @param {boolean} [isHd] Optional filter by items that are HD or not.
|
|
333
|
+
* @param {boolean} [is4K] Optional filter by items that are 4K or not.
|
|
334
|
+
* @param {Array<LocationType>} [locationTypes] Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.
|
|
335
|
+
* @param {Array<LocationType>} [excludeLocationTypes] Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.
|
|
336
|
+
* @param {boolean} [isMissing] Optional filter by items that are missing episodes or not.
|
|
337
|
+
* @param {boolean} [isUnaired] Optional filter by items that are unaired episodes or not.
|
|
338
|
+
* @param {number} [minCommunityRating] Optional filter by minimum community rating.
|
|
339
|
+
* @param {number} [minCriticRating] Optional filter by minimum critic rating.
|
|
340
|
+
* @param {string} [minPremiereDate] Optional. The minimum premiere date. Format = ISO.
|
|
341
|
+
* @param {string} [minDateLastSaved] Optional. The minimum last saved date. Format = ISO.
|
|
342
|
+
* @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO.
|
|
343
|
+
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO.
|
|
344
|
+
* @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
|
|
345
|
+
* @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not.
|
|
346
|
+
* @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not.
|
|
347
|
+
* @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not.
|
|
348
|
+
* @param {boolean} [isMovie] Optional filter for live tv movies.
|
|
349
|
+
* @param {boolean} [isSeries] Optional filter for live tv series.
|
|
350
|
+
* @param {boolean} [isNews] Optional filter for live tv news.
|
|
351
|
+
* @param {boolean} [isKids] Optional filter for live tv kids.
|
|
352
|
+
* @param {boolean} [isSports] Optional filter for live tv sports.
|
|
353
|
+
* @param {Array<string>} [excludeItemIds] Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.
|
|
354
|
+
* @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
|
|
355
|
+
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
356
|
+
* @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
357
|
+
* @param {string} [searchTerm] Optional. Filter based on a search term.
|
|
358
|
+
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending, Descending.
|
|
359
|
+
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
360
|
+
* @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.
|
|
361
|
+
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
362
|
+
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
|
|
363
|
+
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
|
|
364
|
+
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
365
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
366
|
+
* @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
|
|
367
|
+
* @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.
|
|
368
|
+
* @param {boolean} [isPlayed] Optional filter by items that are played, or not.
|
|
369
|
+
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
370
|
+
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
371
|
+
* @param {Array<string>} [tags] Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
|
|
372
|
+
* @param {Array<number>} [years] Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
|
|
373
|
+
* @param {boolean} [enableUserData] Optional, include user data.
|
|
374
|
+
* @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type.
|
|
375
|
+
* @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
|
|
376
|
+
* @param {string} [person] Optional. If specified, results will be filtered to include only those containing the specified person.
|
|
377
|
+
* @param {Array<string>} [personIds] Optional. If specified, results will be filtered to include only those containing the specified person id.
|
|
378
|
+
* @param {Array<string>} [personTypes] Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.
|
|
379
|
+
* @param {Array<string>} [studios] Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
|
|
380
|
+
* @param {Array<string>} [artists] Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.
|
|
381
|
+
* @param {Array<string>} [excludeArtistIds] Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.
|
|
382
|
+
* @param {Array<string>} [artistIds] Optional. If specified, results will be filtered to include only those containing the specified artist id.
|
|
383
|
+
* @param {Array<string>} [albumArtistIds] Optional. If specified, results will be filtered to include only those containing the specified album artist id.
|
|
384
|
+
* @param {Array<string>} [contributingArtistIds] Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.
|
|
385
|
+
* @param {Array<string>} [albums] Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.
|
|
386
|
+
* @param {Array<string>} [albumIds] Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.
|
|
387
|
+
* @param {Array<string>} [ids] Optional. If specific items are needed, specify a list of item id\'s to retrieve. This allows multiple, comma delimited.
|
|
388
|
+
* @param {Array<VideoType>} [videoTypes] Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.
|
|
389
|
+
* @param {string} [minOfficialRating] Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).
|
|
390
|
+
* @param {boolean} [isLocked] Optional filter by items that are locked.
|
|
391
|
+
* @param {boolean} [isPlaceHolder] Optional filter by items that are placeholders.
|
|
392
|
+
* @param {boolean} [hasOfficialRating] Optional filter by items that have official ratings.
|
|
393
|
+
* @param {boolean} [collapseBoxSetItems] Whether or not to hide items behind their boxsets.
|
|
394
|
+
* @param {number} [minWidth] Optional. Filter by the minimum width of the item.
|
|
395
|
+
* @param {number} [minHeight] Optional. Filter by the minimum height of the item.
|
|
396
|
+
* @param {number} [maxWidth] Optional. Filter by the maximum width of the item.
|
|
397
|
+
* @param {number} [maxHeight] Optional. Filter by the maximum height of the item.
|
|
398
|
+
* @param {boolean} [is3D] Optional filter by items that are 3D, or not.
|
|
399
|
+
* @param {Array<SeriesStatus>} [seriesStatus] Optional filter by Series Status. Allows multiple, comma delimited.
|
|
400
|
+
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
401
|
+
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
402
|
+
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
403
|
+
* @param {Array<string>} [studioIds] Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
|
|
404
|
+
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
405
|
+
* @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count.
|
|
406
|
+
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
407
|
+
* @param {*} [options] Override http request option.
|
|
408
|
+
* @throws {RequiredError}
|
|
1149
409
|
*/
|
|
1150
|
-
|
|
410
|
+
getItems(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>, includeItemTypes?: 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>;
|
|
1151
411
|
/**
|
|
1152
|
-
*
|
|
1153
|
-
* @
|
|
1154
|
-
* @
|
|
412
|
+
*
|
|
413
|
+
* @summary Gets items based on a query.
|
|
414
|
+
* @param {string} [userId] The user id.
|
|
415
|
+
* @param {number} [startIndex] The start index.
|
|
416
|
+
* @param {number} [limit] The item limit.
|
|
417
|
+
* @param {string} [searchTerm] The search term.
|
|
418
|
+
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
419
|
+
* @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.
|
|
420
|
+
* @param {Array<MediaType>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
|
|
421
|
+
* @param {boolean} [enableUserData] Optional. Include user data.
|
|
422
|
+
* @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type.
|
|
423
|
+
* @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
|
|
424
|
+
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
425
|
+
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
|
|
426
|
+
* @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count.
|
|
427
|
+
* @param {boolean} [enableImages] Optional. Include image information in output.
|
|
428
|
+
* @param {boolean} [excludeActiveSessions] Optional. Whether to exclude the currently active sessions.
|
|
429
|
+
* @param {*} [options] Override http request option.
|
|
430
|
+
* @throws {RequiredError}
|
|
1155
431
|
*/
|
|
1156
|
-
|
|
432
|
+
getResumeItems(userId?: string, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, mediaTypes?: Array<MediaType>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, enableTotalRecordCount?: boolean, enableImages?: boolean, excludeActiveSessions?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>;
|
|
1157
433
|
/**
|
|
1158
|
-
*
|
|
1159
|
-
* @
|
|
1160
|
-
* @
|
|
434
|
+
*
|
|
435
|
+
* @summary Update Item User Data.
|
|
436
|
+
* @param {string} itemId The item id.
|
|
437
|
+
* @param {UpdateUserItemDataDto} updateUserItemDataDto New user data object.
|
|
438
|
+
* @param {string} [userId] The user id.
|
|
439
|
+
* @param {*} [options] Override http request option.
|
|
440
|
+
* @throws {RequiredError}
|
|
1161
441
|
*/
|
|
1162
|
-
|
|
442
|
+
updateItemUserData(itemId: string, updateUserItemDataDto: UpdateUserItemDataDto, userId?: string, options?: any): AxiosPromise<UserItemDataDto>;
|
|
443
|
+
};
|
|
444
|
+
/**
|
|
445
|
+
* Request parameters for getItemUserData operation in ItemsApi.
|
|
446
|
+
* @export
|
|
447
|
+
* @interface ItemsApiGetItemUserDataRequest
|
|
448
|
+
*/
|
|
449
|
+
export interface ItemsApiGetItemUserDataRequest {
|
|
1163
450
|
/**
|
|
1164
|
-
*
|
|
1165
|
-
* @type {
|
|
1166
|
-
* @memberof
|
|
451
|
+
* The item id.
|
|
452
|
+
* @type {string}
|
|
453
|
+
* @memberof ItemsApiGetItemUserData
|
|
1167
454
|
*/
|
|
1168
|
-
readonly
|
|
455
|
+
readonly itemId: string;
|
|
1169
456
|
/**
|
|
1170
|
-
*
|
|
1171
|
-
* @type {
|
|
1172
|
-
* @memberof
|
|
457
|
+
* The user id.
|
|
458
|
+
* @type {string}
|
|
459
|
+
* @memberof ItemsApiGetItemUserData
|
|
1173
460
|
*/
|
|
1174
|
-
readonly
|
|
461
|
+
readonly userId?: string;
|
|
1175
462
|
}
|
|
1176
463
|
/**
|
|
1177
|
-
* Request parameters for
|
|
464
|
+
* Request parameters for getItems operation in ItemsApi.
|
|
1178
465
|
* @export
|
|
1179
|
-
* @interface
|
|
466
|
+
* @interface ItemsApiGetItemsRequest
|
|
1180
467
|
*/
|
|
1181
|
-
export interface
|
|
468
|
+
export interface ItemsApiGetItemsRequest {
|
|
1182
469
|
/**
|
|
1183
|
-
* The user id supplied as query parameter.
|
|
470
|
+
* The user id supplied as query parameter; this is required when not using an API key.
|
|
1184
471
|
* @type {string}
|
|
1185
|
-
* @memberof
|
|
472
|
+
* @memberof ItemsApiGetItems
|
|
1186
473
|
*/
|
|
1187
|
-
readonly userId
|
|
474
|
+
readonly userId?: string;
|
|
1188
475
|
/**
|
|
1189
476
|
* Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
|
|
1190
477
|
* @type {string}
|
|
1191
|
-
* @memberof
|
|
478
|
+
* @memberof ItemsApiGetItems
|
|
1192
479
|
*/
|
|
1193
480
|
readonly maxOfficialRating?: string;
|
|
1194
481
|
/**
|
|
1195
482
|
* Optional filter by items with theme songs.
|
|
1196
483
|
* @type {boolean}
|
|
1197
|
-
* @memberof
|
|
484
|
+
* @memberof ItemsApiGetItems
|
|
1198
485
|
*/
|
|
1199
486
|
readonly hasThemeSong?: boolean;
|
|
1200
487
|
/**
|
|
1201
488
|
* Optional filter by items with theme videos.
|
|
1202
489
|
* @type {boolean}
|
|
1203
|
-
* @memberof
|
|
490
|
+
* @memberof ItemsApiGetItems
|
|
1204
491
|
*/
|
|
1205
492
|
readonly hasThemeVideo?: boolean;
|
|
1206
493
|
/**
|
|
1207
494
|
* Optional filter by items with subtitles.
|
|
1208
495
|
* @type {boolean}
|
|
1209
|
-
* @memberof
|
|
496
|
+
* @memberof ItemsApiGetItems
|
|
1210
497
|
*/
|
|
1211
498
|
readonly hasSubtitles?: boolean;
|
|
1212
499
|
/**
|
|
1213
500
|
* Optional filter by items with special features.
|
|
1214
501
|
* @type {boolean}
|
|
1215
|
-
* @memberof
|
|
502
|
+
* @memberof ItemsApiGetItems
|
|
1216
503
|
*/
|
|
1217
504
|
readonly hasSpecialFeature?: boolean;
|
|
1218
505
|
/**
|
|
1219
506
|
* Optional filter by items with trailers.
|
|
1220
507
|
* @type {boolean}
|
|
1221
|
-
* @memberof
|
|
508
|
+
* @memberof ItemsApiGetItems
|
|
1222
509
|
*/
|
|
1223
510
|
readonly hasTrailer?: boolean;
|
|
1224
511
|
/**
|
|
1225
512
|
* Optional. Return items that are siblings of a supplied item.
|
|
1226
513
|
* @type {string}
|
|
1227
|
-
* @memberof
|
|
514
|
+
* @memberof ItemsApiGetItems
|
|
1228
515
|
*/
|
|
1229
516
|
readonly adjacentTo?: string;
|
|
1230
517
|
/**
|
|
1231
518
|
* Optional filter by parent index number.
|
|
1232
519
|
* @type {number}
|
|
1233
|
-
* @memberof
|
|
520
|
+
* @memberof ItemsApiGetItems
|
|
1234
521
|
*/
|
|
1235
522
|
readonly parentIndexNumber?: number;
|
|
1236
523
|
/**
|
|
1237
524
|
* Optional filter by items that have or do not have a parental rating.
|
|
1238
525
|
* @type {boolean}
|
|
1239
|
-
* @memberof
|
|
526
|
+
* @memberof ItemsApiGetItems
|
|
1240
527
|
*/
|
|
1241
528
|
readonly hasParentalRating?: boolean;
|
|
1242
529
|
/**
|
|
1243
530
|
* Optional filter by items that are HD or not.
|
|
1244
531
|
* @type {boolean}
|
|
1245
|
-
* @memberof
|
|
532
|
+
* @memberof ItemsApiGetItems
|
|
1246
533
|
*/
|
|
1247
534
|
readonly isHd?: boolean;
|
|
1248
535
|
/**
|
|
1249
536
|
* Optional filter by items that are 4K or not.
|
|
1250
537
|
* @type {boolean}
|
|
1251
|
-
* @memberof
|
|
538
|
+
* @memberof ItemsApiGetItems
|
|
1252
539
|
*/
|
|
1253
540
|
readonly is4K?: boolean;
|
|
1254
541
|
/**
|
|
1255
542
|
* Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.
|
|
1256
543
|
* @type {Array<LocationType>}
|
|
1257
|
-
* @memberof
|
|
544
|
+
* @memberof ItemsApiGetItems
|
|
1258
545
|
*/
|
|
1259
546
|
readonly locationTypes?: Array<LocationType>;
|
|
1260
547
|
/**
|
|
1261
548
|
* Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.
|
|
1262
549
|
* @type {Array<LocationType>}
|
|
1263
|
-
* @memberof
|
|
550
|
+
* @memberof ItemsApiGetItems
|
|
1264
551
|
*/
|
|
1265
552
|
readonly excludeLocationTypes?: Array<LocationType>;
|
|
1266
553
|
/**
|
|
1267
554
|
* Optional filter by items that are missing episodes or not.
|
|
1268
555
|
* @type {boolean}
|
|
1269
|
-
* @memberof
|
|
556
|
+
* @memberof ItemsApiGetItems
|
|
1270
557
|
*/
|
|
1271
558
|
readonly isMissing?: boolean;
|
|
1272
559
|
/**
|
|
1273
560
|
* Optional filter by items that are unaired episodes or not.
|
|
1274
561
|
* @type {boolean}
|
|
1275
|
-
* @memberof
|
|
562
|
+
* @memberof ItemsApiGetItems
|
|
1276
563
|
*/
|
|
1277
564
|
readonly isUnaired?: boolean;
|
|
1278
565
|
/**
|
|
1279
566
|
* Optional filter by minimum community rating.
|
|
1280
567
|
* @type {number}
|
|
1281
|
-
* @memberof
|
|
568
|
+
* @memberof ItemsApiGetItems
|
|
1282
569
|
*/
|
|
1283
570
|
readonly minCommunityRating?: number;
|
|
1284
571
|
/**
|
|
1285
572
|
* Optional filter by minimum critic rating.
|
|
1286
573
|
* @type {number}
|
|
1287
|
-
* @memberof
|
|
574
|
+
* @memberof ItemsApiGetItems
|
|
1288
575
|
*/
|
|
1289
576
|
readonly minCriticRating?: number;
|
|
1290
577
|
/**
|
|
1291
578
|
* Optional. The minimum premiere date. Format = ISO.
|
|
1292
579
|
* @type {string}
|
|
1293
|
-
* @memberof
|
|
580
|
+
* @memberof ItemsApiGetItems
|
|
1294
581
|
*/
|
|
1295
582
|
readonly minPremiereDate?: string;
|
|
1296
583
|
/**
|
|
1297
584
|
* Optional. The minimum last saved date. Format = ISO.
|
|
1298
585
|
* @type {string}
|
|
1299
|
-
* @memberof
|
|
586
|
+
* @memberof ItemsApiGetItems
|
|
1300
587
|
*/
|
|
1301
588
|
readonly minDateLastSaved?: string;
|
|
1302
589
|
/**
|
|
1303
590
|
* Optional. The minimum last saved date for the current user. Format = ISO.
|
|
1304
591
|
* @type {string}
|
|
1305
|
-
* @memberof
|
|
592
|
+
* @memberof ItemsApiGetItems
|
|
1306
593
|
*/
|
|
1307
594
|
readonly minDateLastSavedForUser?: string;
|
|
1308
595
|
/**
|
|
1309
596
|
* Optional. The maximum premiere date. Format = ISO.
|
|
1310
597
|
* @type {string}
|
|
1311
|
-
* @memberof
|
|
598
|
+
* @memberof ItemsApiGetItems
|
|
1312
599
|
*/
|
|
1313
600
|
readonly maxPremiereDate?: string;
|
|
1314
601
|
/**
|
|
1315
602
|
* Optional filter by items that have an overview or not.
|
|
1316
603
|
* @type {boolean}
|
|
1317
|
-
* @memberof
|
|
604
|
+
* @memberof ItemsApiGetItems
|
|
1318
605
|
*/
|
|
1319
606
|
readonly hasOverview?: boolean;
|
|
1320
607
|
/**
|
|
1321
|
-
* Optional filter by items that have an
|
|
608
|
+
* Optional filter by items that have an IMDb id or not.
|
|
1322
609
|
* @type {boolean}
|
|
1323
|
-
* @memberof
|
|
610
|
+
* @memberof ItemsApiGetItems
|
|
1324
611
|
*/
|
|
1325
612
|
readonly hasImdbId?: boolean;
|
|
1326
613
|
/**
|
|
1327
|
-
* Optional filter by items that have a
|
|
614
|
+
* Optional filter by items that have a TMDb id or not.
|
|
1328
615
|
* @type {boolean}
|
|
1329
|
-
* @memberof
|
|
616
|
+
* @memberof ItemsApiGetItems
|
|
1330
617
|
*/
|
|
1331
618
|
readonly hasTmdbId?: boolean;
|
|
1332
619
|
/**
|
|
1333
|
-
* Optional filter by items that have a
|
|
620
|
+
* Optional filter by items that have a TVDb id or not.
|
|
1334
621
|
* @type {boolean}
|
|
1335
|
-
* @memberof
|
|
622
|
+
* @memberof ItemsApiGetItems
|
|
1336
623
|
*/
|
|
1337
624
|
readonly hasTvdbId?: boolean;
|
|
1338
625
|
/**
|
|
1339
626
|
* Optional filter for live tv movies.
|
|
1340
627
|
* @type {boolean}
|
|
1341
|
-
* @memberof
|
|
628
|
+
* @memberof ItemsApiGetItems
|
|
1342
629
|
*/
|
|
1343
630
|
readonly isMovie?: boolean;
|
|
1344
631
|
/**
|
|
1345
632
|
* Optional filter for live tv series.
|
|
1346
633
|
* @type {boolean}
|
|
1347
|
-
* @memberof
|
|
634
|
+
* @memberof ItemsApiGetItems
|
|
1348
635
|
*/
|
|
1349
636
|
readonly isSeries?: boolean;
|
|
1350
637
|
/**
|
|
1351
638
|
* Optional filter for live tv news.
|
|
1352
639
|
* @type {boolean}
|
|
1353
|
-
* @memberof
|
|
640
|
+
* @memberof ItemsApiGetItems
|
|
1354
641
|
*/
|
|
1355
642
|
readonly isNews?: boolean;
|
|
1356
643
|
/**
|
|
1357
644
|
* Optional filter for live tv kids.
|
|
1358
645
|
* @type {boolean}
|
|
1359
|
-
* @memberof
|
|
646
|
+
* @memberof ItemsApiGetItems
|
|
1360
647
|
*/
|
|
1361
648
|
readonly isKids?: boolean;
|
|
1362
649
|
/**
|
|
1363
650
|
* Optional filter for live tv sports.
|
|
1364
651
|
* @type {boolean}
|
|
1365
|
-
* @memberof
|
|
652
|
+
* @memberof ItemsApiGetItems
|
|
1366
653
|
*/
|
|
1367
654
|
readonly isSports?: boolean;
|
|
1368
655
|
/**
|
|
1369
656
|
* Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.
|
|
1370
657
|
* @type {Array<string>}
|
|
1371
|
-
* @memberof
|
|
658
|
+
* @memberof ItemsApiGetItems
|
|
1372
659
|
*/
|
|
1373
660
|
readonly excludeItemIds?: Array<string>;
|
|
1374
661
|
/**
|
|
1375
662
|
* Optional. The record index to start at. All items with a lower index will be dropped from the results.
|
|
1376
663
|
* @type {number}
|
|
1377
|
-
* @memberof
|
|
664
|
+
* @memberof ItemsApiGetItems
|
|
1378
665
|
*/
|
|
1379
666
|
readonly startIndex?: number;
|
|
1380
667
|
/**
|
|
1381
668
|
* Optional. The maximum number of records to return.
|
|
1382
669
|
* @type {number}
|
|
1383
|
-
* @memberof
|
|
670
|
+
* @memberof ItemsApiGetItems
|
|
1384
671
|
*/
|
|
1385
672
|
readonly limit?: number;
|
|
1386
673
|
/**
|
|
1387
674
|
* When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
1388
675
|
* @type {boolean}
|
|
1389
|
-
* @memberof
|
|
676
|
+
* @memberof ItemsApiGetItems
|
|
1390
677
|
*/
|
|
1391
678
|
readonly recursive?: boolean;
|
|
1392
679
|
/**
|
|
1393
680
|
* Optional. Filter based on a search term.
|
|
1394
681
|
* @type {string}
|
|
1395
|
-
* @memberof
|
|
682
|
+
* @memberof ItemsApiGetItems
|
|
1396
683
|
*/
|
|
1397
684
|
readonly searchTerm?: string;
|
|
1398
685
|
/**
|
|
1399
|
-
* Sort Order - Ascending,Descending.
|
|
686
|
+
* Sort Order - Ascending, Descending.
|
|
1400
687
|
* @type {Array<SortOrder>}
|
|
1401
|
-
* @memberof
|
|
688
|
+
* @memberof ItemsApiGetItems
|
|
1402
689
|
*/
|
|
1403
690
|
readonly sortOrder?: Array<SortOrder>;
|
|
1404
691
|
/**
|
|
1405
692
|
* Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
1406
693
|
* @type {string}
|
|
1407
|
-
* @memberof
|
|
694
|
+
* @memberof ItemsApiGetItems
|
|
1408
695
|
*/
|
|
1409
696
|
readonly parentId?: string;
|
|
1410
697
|
/**
|
|
1411
698
|
* 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.
|
|
1412
699
|
* @type {Array<ItemFields>}
|
|
1413
|
-
* @memberof
|
|
700
|
+
* @memberof ItemsApiGetItems
|
|
1414
701
|
*/
|
|
1415
702
|
readonly fields?: Array<ItemFields>;
|
|
1416
703
|
/**
|
|
1417
704
|
* Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
1418
705
|
* @type {Array<BaseItemKind>}
|
|
1419
|
-
* @memberof
|
|
706
|
+
* @memberof ItemsApiGetItems
|
|
1420
707
|
*/
|
|
1421
708
|
readonly excludeItemTypes?: Array<BaseItemKind>;
|
|
1422
709
|
/**
|
|
1423
710
|
* Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
|
|
1424
711
|
* @type {Array<BaseItemKind>}
|
|
1425
|
-
* @memberof
|
|
712
|
+
* @memberof ItemsApiGetItems
|
|
1426
713
|
*/
|
|
1427
714
|
readonly includeItemTypes?: Array<BaseItemKind>;
|
|
1428
715
|
/**
|
|
1429
716
|
* Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
|
|
1430
717
|
* @type {Array<ItemFilter>}
|
|
1431
|
-
* @memberof
|
|
718
|
+
* @memberof ItemsApiGetItems
|
|
1432
719
|
*/
|
|
1433
720
|
readonly filters?: Array<ItemFilter>;
|
|
1434
721
|
/**
|
|
1435
722
|
* Optional filter by items that are marked as favorite, or not.
|
|
1436
723
|
* @type {boolean}
|
|
1437
|
-
* @memberof
|
|
724
|
+
* @memberof ItemsApiGetItems
|
|
1438
725
|
*/
|
|
1439
726
|
readonly isFavorite?: boolean;
|
|
1440
727
|
/**
|
|
1441
728
|
* Optional filter by MediaType. Allows multiple, comma delimited.
|
|
1442
|
-
* @type {Array<
|
|
1443
|
-
* @memberof
|
|
729
|
+
* @type {Array<MediaType>}
|
|
730
|
+
* @memberof ItemsApiGetItems
|
|
1444
731
|
*/
|
|
1445
|
-
readonly mediaTypes?: Array<
|
|
732
|
+
readonly mediaTypes?: Array<MediaType>;
|
|
1446
733
|
/**
|
|
1447
734
|
* Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
|
|
1448
735
|
* @type {Array<ImageType>}
|
|
1449
|
-
* @memberof
|
|
736
|
+
* @memberof ItemsApiGetItems
|
|
1450
737
|
*/
|
|
1451
738
|
readonly imageTypes?: Array<ImageType>;
|
|
1452
739
|
/**
|
|
1453
740
|
* 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.
|
|
1454
|
-
* @type {Array<
|
|
1455
|
-
* @memberof
|
|
741
|
+
* @type {Array<ItemSortBy>}
|
|
742
|
+
* @memberof ItemsApiGetItems
|
|
1456
743
|
*/
|
|
1457
|
-
readonly sortBy?: Array<
|
|
744
|
+
readonly sortBy?: Array<ItemSortBy>;
|
|
1458
745
|
/**
|
|
1459
746
|
* Optional filter by items that are played, or not.
|
|
1460
747
|
* @type {boolean}
|
|
1461
|
-
* @memberof
|
|
748
|
+
* @memberof ItemsApiGetItems
|
|
1462
749
|
*/
|
|
1463
750
|
readonly isPlayed?: boolean;
|
|
1464
751
|
/**
|
|
1465
752
|
* Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
1466
753
|
* @type {Array<string>}
|
|
1467
|
-
* @memberof
|
|
754
|
+
* @memberof ItemsApiGetItems
|
|
1468
755
|
*/
|
|
1469
756
|
readonly genres?: Array<string>;
|
|
1470
757
|
/**
|
|
1471
758
|
* Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
1472
759
|
* @type {Array<string>}
|
|
1473
|
-
* @memberof
|
|
760
|
+
* @memberof ItemsApiGetItems
|
|
1474
761
|
*/
|
|
1475
762
|
readonly officialRatings?: Array<string>;
|
|
1476
763
|
/**
|
|
1477
764
|
* Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
|
|
1478
765
|
* @type {Array<string>}
|
|
1479
|
-
* @memberof
|
|
766
|
+
* @memberof ItemsApiGetItems
|
|
1480
767
|
*/
|
|
1481
768
|
readonly tags?: Array<string>;
|
|
1482
769
|
/**
|
|
1483
770
|
* Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
|
|
1484
771
|
* @type {Array<number>}
|
|
1485
|
-
* @memberof
|
|
772
|
+
* @memberof ItemsApiGetItems
|
|
1486
773
|
*/
|
|
1487
774
|
readonly years?: Array<number>;
|
|
1488
775
|
/**
|
|
1489
776
|
* Optional, include user data.
|
|
1490
777
|
* @type {boolean}
|
|
1491
|
-
* @memberof
|
|
778
|
+
* @memberof ItemsApiGetItems
|
|
1492
779
|
*/
|
|
1493
780
|
readonly enableUserData?: boolean;
|
|
1494
781
|
/**
|
|
1495
782
|
* Optional, the max number of images to return, per image type.
|
|
1496
783
|
* @type {number}
|
|
1497
|
-
* @memberof
|
|
784
|
+
* @memberof ItemsApiGetItems
|
|
1498
785
|
*/
|
|
1499
786
|
readonly imageTypeLimit?: number;
|
|
1500
787
|
/**
|
|
1501
788
|
* Optional. The image types to include in the output.
|
|
1502
789
|
* @type {Array<ImageType>}
|
|
1503
|
-
* @memberof
|
|
790
|
+
* @memberof ItemsApiGetItems
|
|
1504
791
|
*/
|
|
1505
792
|
readonly enableImageTypes?: Array<ImageType>;
|
|
1506
793
|
/**
|
|
1507
794
|
* Optional. If specified, results will be filtered to include only those containing the specified person.
|
|
1508
795
|
* @type {string}
|
|
1509
|
-
* @memberof
|
|
796
|
+
* @memberof ItemsApiGetItems
|
|
1510
797
|
*/
|
|
1511
798
|
readonly person?: string;
|
|
1512
799
|
/**
|
|
1513
800
|
* Optional. If specified, results will be filtered to include only those containing the specified person id.
|
|
1514
801
|
* @type {Array<string>}
|
|
1515
|
-
* @memberof
|
|
802
|
+
* @memberof ItemsApiGetItems
|
|
1516
803
|
*/
|
|
1517
804
|
readonly personIds?: Array<string>;
|
|
1518
805
|
/**
|
|
1519
806
|
* Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.
|
|
1520
807
|
* @type {Array<string>}
|
|
1521
|
-
* @memberof
|
|
808
|
+
* @memberof ItemsApiGetItems
|
|
1522
809
|
*/
|
|
1523
810
|
readonly personTypes?: Array<string>;
|
|
1524
811
|
/**
|
|
1525
812
|
* Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
|
|
1526
813
|
* @type {Array<string>}
|
|
1527
|
-
* @memberof
|
|
814
|
+
* @memberof ItemsApiGetItems
|
|
1528
815
|
*/
|
|
1529
816
|
readonly studios?: Array<string>;
|
|
1530
817
|
/**
|
|
1531
818
|
* Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.
|
|
1532
819
|
* @type {Array<string>}
|
|
1533
|
-
* @memberof
|
|
820
|
+
* @memberof ItemsApiGetItems
|
|
1534
821
|
*/
|
|
1535
822
|
readonly artists?: Array<string>;
|
|
1536
823
|
/**
|
|
1537
824
|
* Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.
|
|
1538
825
|
* @type {Array<string>}
|
|
1539
|
-
* @memberof
|
|
826
|
+
* @memberof ItemsApiGetItems
|
|
1540
827
|
*/
|
|
1541
828
|
readonly excludeArtistIds?: Array<string>;
|
|
1542
829
|
/**
|
|
1543
830
|
* Optional. If specified, results will be filtered to include only those containing the specified artist id.
|
|
1544
831
|
* @type {Array<string>}
|
|
1545
|
-
* @memberof
|
|
832
|
+
* @memberof ItemsApiGetItems
|
|
1546
833
|
*/
|
|
1547
834
|
readonly artistIds?: Array<string>;
|
|
1548
835
|
/**
|
|
1549
836
|
* Optional. If specified, results will be filtered to include only those containing the specified album artist id.
|
|
1550
837
|
* @type {Array<string>}
|
|
1551
|
-
* @memberof
|
|
838
|
+
* @memberof ItemsApiGetItems
|
|
1552
839
|
*/
|
|
1553
840
|
readonly albumArtistIds?: Array<string>;
|
|
1554
841
|
/**
|
|
1555
842
|
* Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.
|
|
1556
843
|
* @type {Array<string>}
|
|
1557
|
-
* @memberof
|
|
844
|
+
* @memberof ItemsApiGetItems
|
|
1558
845
|
*/
|
|
1559
846
|
readonly contributingArtistIds?: Array<string>;
|
|
1560
847
|
/**
|
|
1561
848
|
* Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.
|
|
1562
849
|
* @type {Array<string>}
|
|
1563
|
-
* @memberof
|
|
850
|
+
* @memberof ItemsApiGetItems
|
|
1564
851
|
*/
|
|
1565
852
|
readonly albums?: Array<string>;
|
|
1566
853
|
/**
|
|
1567
854
|
* Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.
|
|
1568
855
|
* @type {Array<string>}
|
|
1569
|
-
* @memberof
|
|
856
|
+
* @memberof ItemsApiGetItems
|
|
1570
857
|
*/
|
|
1571
858
|
readonly albumIds?: Array<string>;
|
|
1572
859
|
/**
|
|
1573
860
|
* Optional. If specific items are needed, specify a list of item id\'s to retrieve. This allows multiple, comma delimited.
|
|
1574
861
|
* @type {Array<string>}
|
|
1575
|
-
* @memberof
|
|
862
|
+
* @memberof ItemsApiGetItems
|
|
1576
863
|
*/
|
|
1577
864
|
readonly ids?: Array<string>;
|
|
1578
865
|
/**
|
|
1579
866
|
* Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.
|
|
1580
867
|
* @type {Array<VideoType>}
|
|
1581
|
-
* @memberof
|
|
868
|
+
* @memberof ItemsApiGetItems
|
|
1582
869
|
*/
|
|
1583
870
|
readonly videoTypes?: Array<VideoType>;
|
|
1584
871
|
/**
|
|
1585
872
|
* Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).
|
|
1586
873
|
* @type {string}
|
|
1587
|
-
* @memberof
|
|
874
|
+
* @memberof ItemsApiGetItems
|
|
1588
875
|
*/
|
|
1589
876
|
readonly minOfficialRating?: string;
|
|
1590
877
|
/**
|
|
1591
878
|
* Optional filter by items that are locked.
|
|
1592
879
|
* @type {boolean}
|
|
1593
|
-
* @memberof
|
|
880
|
+
* @memberof ItemsApiGetItems
|
|
1594
881
|
*/
|
|
1595
882
|
readonly isLocked?: boolean;
|
|
1596
883
|
/**
|
|
1597
884
|
* Optional filter by items that are placeholders.
|
|
1598
885
|
* @type {boolean}
|
|
1599
|
-
* @memberof
|
|
886
|
+
* @memberof ItemsApiGetItems
|
|
1600
887
|
*/
|
|
1601
888
|
readonly isPlaceHolder?: boolean;
|
|
1602
889
|
/**
|
|
1603
890
|
* Optional filter by items that have official ratings.
|
|
1604
891
|
* @type {boolean}
|
|
1605
|
-
* @memberof
|
|
892
|
+
* @memberof ItemsApiGetItems
|
|
1606
893
|
*/
|
|
1607
894
|
readonly hasOfficialRating?: boolean;
|
|
1608
895
|
/**
|
|
1609
896
|
* Whether or not to hide items behind their boxsets.
|
|
1610
897
|
* @type {boolean}
|
|
1611
|
-
* @memberof
|
|
898
|
+
* @memberof ItemsApiGetItems
|
|
1612
899
|
*/
|
|
1613
900
|
readonly collapseBoxSetItems?: boolean;
|
|
1614
901
|
/**
|
|
1615
902
|
* Optional. Filter by the minimum width of the item.
|
|
1616
903
|
* @type {number}
|
|
1617
|
-
* @memberof
|
|
904
|
+
* @memberof ItemsApiGetItems
|
|
1618
905
|
*/
|
|
1619
906
|
readonly minWidth?: number;
|
|
1620
907
|
/**
|
|
1621
908
|
* Optional. Filter by the minimum height of the item.
|
|
1622
909
|
* @type {number}
|
|
1623
|
-
* @memberof
|
|
910
|
+
* @memberof ItemsApiGetItems
|
|
1624
911
|
*/
|
|
1625
912
|
readonly minHeight?: number;
|
|
1626
913
|
/**
|
|
1627
914
|
* Optional. Filter by the maximum width of the item.
|
|
1628
915
|
* @type {number}
|
|
1629
|
-
* @memberof
|
|
916
|
+
* @memberof ItemsApiGetItems
|
|
1630
917
|
*/
|
|
1631
918
|
readonly maxWidth?: number;
|
|
1632
919
|
/**
|
|
1633
920
|
* Optional. Filter by the maximum height of the item.
|
|
1634
921
|
* @type {number}
|
|
1635
|
-
* @memberof
|
|
922
|
+
* @memberof ItemsApiGetItems
|
|
1636
923
|
*/
|
|
1637
924
|
readonly maxHeight?: number;
|
|
1638
925
|
/**
|
|
1639
926
|
* Optional filter by items that are 3D, or not.
|
|
1640
927
|
* @type {boolean}
|
|
1641
|
-
* @memberof
|
|
928
|
+
* @memberof ItemsApiGetItems
|
|
1642
929
|
*/
|
|
1643
930
|
readonly is3D?: boolean;
|
|
1644
931
|
/**
|
|
1645
932
|
* Optional filter by Series Status. Allows multiple, comma delimited.
|
|
1646
933
|
* @type {Array<SeriesStatus>}
|
|
1647
|
-
* @memberof
|
|
934
|
+
* @memberof ItemsApiGetItems
|
|
1648
935
|
*/
|
|
1649
936
|
readonly seriesStatus?: Array<SeriesStatus>;
|
|
1650
937
|
/**
|
|
1651
938
|
* Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
1652
939
|
* @type {string}
|
|
1653
|
-
* @memberof
|
|
940
|
+
* @memberof ItemsApiGetItems
|
|
1654
941
|
*/
|
|
1655
942
|
readonly nameStartsWithOrGreater?: string;
|
|
1656
943
|
/**
|
|
1657
944
|
* Optional filter by items whose name is sorted equally than a given input string.
|
|
1658
945
|
* @type {string}
|
|
1659
|
-
* @memberof
|
|
946
|
+
* @memberof ItemsApiGetItems
|
|
1660
947
|
*/
|
|
1661
948
|
readonly nameStartsWith?: string;
|
|
1662
949
|
/**
|
|
1663
950
|
* Optional filter by items whose name is equally or lesser than a given input string.
|
|
1664
951
|
* @type {string}
|
|
1665
|
-
* @memberof
|
|
952
|
+
* @memberof ItemsApiGetItems
|
|
1666
953
|
*/
|
|
1667
954
|
readonly nameLessThan?: string;
|
|
1668
955
|
/**
|
|
1669
956
|
* Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
|
|
1670
957
|
* @type {Array<string>}
|
|
1671
|
-
* @memberof
|
|
958
|
+
* @memberof ItemsApiGetItems
|
|
1672
959
|
*/
|
|
1673
960
|
readonly studioIds?: Array<string>;
|
|
1674
961
|
/**
|
|
1675
962
|
* Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
1676
963
|
* @type {Array<string>}
|
|
1677
|
-
* @memberof
|
|
964
|
+
* @memberof ItemsApiGetItems
|
|
1678
965
|
*/
|
|
1679
966
|
readonly genreIds?: Array<string>;
|
|
1680
967
|
/**
|
|
1681
968
|
* Optional. Enable the total record count.
|
|
1682
969
|
* @type {boolean}
|
|
1683
|
-
* @memberof
|
|
970
|
+
* @memberof ItemsApiGetItems
|
|
1684
971
|
*/
|
|
1685
972
|
readonly enableTotalRecordCount?: boolean;
|
|
1686
973
|
/**
|
|
1687
974
|
* Optional, include image information in output.
|
|
1688
975
|
* @type {boolean}
|
|
1689
|
-
* @memberof
|
|
976
|
+
* @memberof ItemsApiGetItems
|
|
1690
977
|
*/
|
|
1691
978
|
readonly enableImages?: boolean;
|
|
1692
979
|
}
|
|
@@ -1701,7 +988,7 @@ export interface ItemsApiGetResumeItemsRequest {
|
|
|
1701
988
|
* @type {string}
|
|
1702
989
|
* @memberof ItemsApiGetResumeItems
|
|
1703
990
|
*/
|
|
1704
|
-
readonly userId
|
|
991
|
+
readonly userId?: string;
|
|
1705
992
|
/**
|
|
1706
993
|
* The start index.
|
|
1707
994
|
* @type {number}
|
|
@@ -1734,10 +1021,10 @@ export interface ItemsApiGetResumeItemsRequest {
|
|
|
1734
1021
|
readonly fields?: Array<ItemFields>;
|
|
1735
1022
|
/**
|
|
1736
1023
|
* Optional. Filter by MediaType. Allows multiple, comma delimited.
|
|
1737
|
-
* @type {Array<
|
|
1024
|
+
* @type {Array<MediaType>}
|
|
1738
1025
|
* @memberof ItemsApiGetResumeItems
|
|
1739
1026
|
*/
|
|
1740
|
-
readonly mediaTypes?: Array<
|
|
1027
|
+
readonly mediaTypes?: Array<MediaType>;
|
|
1741
1028
|
/**
|
|
1742
1029
|
* Optional. Include user data.
|
|
1743
1030
|
* @type {boolean}
|
|
@@ -1787,6 +1074,31 @@ export interface ItemsApiGetResumeItemsRequest {
|
|
|
1787
1074
|
*/
|
|
1788
1075
|
readonly excludeActiveSessions?: boolean;
|
|
1789
1076
|
}
|
|
1077
|
+
/**
|
|
1078
|
+
* Request parameters for updateItemUserData operation in ItemsApi.
|
|
1079
|
+
* @export
|
|
1080
|
+
* @interface ItemsApiUpdateItemUserDataRequest
|
|
1081
|
+
*/
|
|
1082
|
+
export interface ItemsApiUpdateItemUserDataRequest {
|
|
1083
|
+
/**
|
|
1084
|
+
* The item id.
|
|
1085
|
+
* @type {string}
|
|
1086
|
+
* @memberof ItemsApiUpdateItemUserData
|
|
1087
|
+
*/
|
|
1088
|
+
readonly itemId: string;
|
|
1089
|
+
/**
|
|
1090
|
+
* New user data object.
|
|
1091
|
+
* @type {UpdateUserItemDataDto}
|
|
1092
|
+
* @memberof ItemsApiUpdateItemUserData
|
|
1093
|
+
*/
|
|
1094
|
+
readonly updateUserItemDataDto: UpdateUserItemDataDto;
|
|
1095
|
+
/**
|
|
1096
|
+
* The user id.
|
|
1097
|
+
* @type {string}
|
|
1098
|
+
* @memberof ItemsApiUpdateItemUserData
|
|
1099
|
+
*/
|
|
1100
|
+
readonly userId?: string;
|
|
1101
|
+
}
|
|
1790
1102
|
/**
|
|
1791
1103
|
* ItemsApi - object-oriented interface
|
|
1792
1104
|
* @export
|
|
@@ -1794,6 +1106,15 @@ export interface ItemsApiGetResumeItemsRequest {
|
|
|
1794
1106
|
* @extends {BaseAPI}
|
|
1795
1107
|
*/
|
|
1796
1108
|
export declare class ItemsApi extends BaseAPI {
|
|
1109
|
+
/**
|
|
1110
|
+
*
|
|
1111
|
+
* @summary Get Item User Data.
|
|
1112
|
+
* @param {ItemsApiGetItemUserDataRequest} requestParameters Request parameters.
|
|
1113
|
+
* @param {*} [options] Override http request option.
|
|
1114
|
+
* @throws {RequiredError}
|
|
1115
|
+
* @memberof ItemsApi
|
|
1116
|
+
*/
|
|
1117
|
+
getItemUserData(requestParameters: ItemsApiGetItemUserDataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserItemDataDto, any>>;
|
|
1797
1118
|
/**
|
|
1798
1119
|
*
|
|
1799
1120
|
* @summary Gets items based on a query.
|
|
@@ -1806,19 +1127,19 @@ export declare class ItemsApi extends BaseAPI {
|
|
|
1806
1127
|
/**
|
|
1807
1128
|
*
|
|
1808
1129
|
* @summary Gets items based on a query.
|
|
1809
|
-
* @param {
|
|
1130
|
+
* @param {ItemsApiGetResumeItemsRequest} requestParameters Request parameters.
|
|
1810
1131
|
* @param {*} [options] Override http request option.
|
|
1811
1132
|
* @throws {RequiredError}
|
|
1812
1133
|
* @memberof ItemsApi
|
|
1813
1134
|
*/
|
|
1814
|
-
|
|
1135
|
+
getResumeItems(requestParameters?: ItemsApiGetResumeItemsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any>>;
|
|
1815
1136
|
/**
|
|
1816
1137
|
*
|
|
1817
|
-
* @summary
|
|
1818
|
-
* @param {
|
|
1138
|
+
* @summary Update Item User Data.
|
|
1139
|
+
* @param {ItemsApiUpdateItemUserDataRequest} requestParameters Request parameters.
|
|
1819
1140
|
* @param {*} [options] Override http request option.
|
|
1820
1141
|
* @throws {RequiredError}
|
|
1821
1142
|
* @memberof ItemsApi
|
|
1822
1143
|
*/
|
|
1823
|
-
|
|
1144
|
+
updateItemUserData(requestParameters: ItemsApiUpdateItemUserDataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserItemDataDto, any>>;
|
|
1824
1145
|
}
|