@jellyfin/sdk 0.12.0 → 1.0.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/.nvmrc +1 -0
- package/.openapi-generator-ignore +2 -0
- package/CHANGELOG.md +40 -3
- package/README.md +55 -32
- package/eslint.config.mjs +118 -0
- package/lib/api.d.ts +33 -9
- package/lib/api.js +88 -26
- package/lib/constants.d.ts +11 -0
- package/lib/constants.js +13 -0
- package/lib/generated-client/api/{artists-api.d.ts → artist-api.d.ts} +38 -173
- package/lib/generated-client/api/{artists-api.js → artist-api.js} +39 -33
- package/lib/generated-client/api/audio-api.d.ts +295 -450
- package/lib/generated-client/api/audio-api.js +332 -64
- package/lib/generated-client/api/authentication-api.d.ts +517 -0
- package/lib/generated-client/api/authentication-api.js +870 -0
- package/lib/generated-client/api/backup-api.d.ts +0 -22
- package/lib/generated-client/api/backup-api.js +5 -11
- package/lib/generated-client/api/branding-api.d.ts +0 -9
- package/lib/generated-client/api/branding-api.js +4 -10
- package/lib/generated-client/api/{channels-api.d.ts → channel-api.d.ts} +32 -95
- package/lib/generated-client/api/{channels-api.js → channel-api.js} +35 -41
- package/lib/generated-client/api/collection-api.d.ts +0 -31
- package/lib/generated-client/api/collection-api.js +4 -10
- package/lib/generated-client/api/{devices-api.d.ts → device-api.d.ts} +48 -81
- package/lib/generated-client/api/{devices-api.js → device-api.js} +46 -54
- package/lib/generated-client/api/{display-preferences-api.d.ts → display-preference-api.d.ts} +20 -46
- package/lib/generated-client/api/{display-preferences-api.js → display-preference-api.js} +22 -28
- package/lib/generated-client/api/environment-api.d.ts +0 -60
- package/lib/generated-client/api/environment-api.js +6 -75
- package/lib/generated-client/api/filter-api.d.ts +0 -40
- package/lib/generated-client/api/filter-api.js +3 -9
- package/lib/generated-client/api/{genres-api.d.ts → genre-api.d.ts} +20 -72
- package/lib/generated-client/api/{genres-api.js → genre-api.js} +22 -28
- package/lib/generated-client/api/image-api.d.ts +4 -1007
- package/lib/generated-client/api/image-api.js +42 -48
- package/lib/generated-client/api/instant-mix-api.d.ts +8 -245
- package/lib/generated-client/api/instant-mix-api.js +16 -121
- package/lib/generated-client/api/item-lookup-api.d.ts +0 -65
- package/lib/generated-client/api/item-lookup-api.js +12 -18
- package/lib/generated-client/api/item-update-api.d.ts +0 -25
- package/lib/generated-client/api/item-update-api.js +4 -10
- package/lib/generated-client/api/library-api.d.ts +1239 -327
- package/lib/generated-client/api/library-api.js +1307 -95
- package/lib/generated-client/api/library-structure-api.d.ts +0 -62
- package/lib/generated-client/api/library-structure-api.js +9 -15
- package/lib/generated-client/api/live-tv-api.d.ts +0 -622
- package/lib/generated-client/api/live-tv-api.js +39 -320
- package/lib/generated-client/api/localization-api.d.ts +0 -10
- package/lib/generated-client/api/localization-api.js +5 -11
- package/lib/generated-client/api/{lyrics-api.d.ts → lyric-api.d.ts} +44 -89
- package/lib/generated-client/api/{lyrics-api.js → lyric-api.js} +42 -48
- package/lib/generated-client/api/media-info-api.d.ts +4 -91
- package/lib/generated-client/api/media-info-api.js +10 -16
- package/lib/generated-client/api/{media-segments-api.d.ts → media-segment-api.d.ts} +14 -27
- package/lib/generated-client/api/{media-segments-api.js → media-segment-api.js} +17 -23
- package/lib/generated-client/api/{movies-api.d.ts → movie-api.d.ts} +14 -33
- package/lib/generated-client/api/{movies-api.js → movie-api.js} +17 -23
- package/lib/generated-client/api/music-genre-api.d.ts +85 -0
- package/lib/generated-client/api/music-genre-api.js +121 -0
- package/lib/generated-client/api/{persons-api.d.ts → person-api.d.ts} +52 -64
- package/lib/generated-client/api/{persons-api.js → person-api.js} +51 -32
- package/lib/generated-client/api/{playlists-api.d.ts → playlist-api.d.ts} +86 -185
- package/lib/generated-client/api/{playlists-api.js → playlist-api.js} +80 -81
- package/lib/generated-client/api/plugin-api.d.ts +743 -0
- package/lib/generated-client/api/plugin-api.js +1186 -0
- package/lib/generated-client/api/remote-image-api.d.ts +0 -35
- package/lib/generated-client/api/remote-image-api.js +4 -10
- package/lib/generated-client/api/{scheduled-tasks-api.d.ts → scheduled-task-api.d.ts} +38 -73
- package/lib/generated-client/api/{scheduled-tasks-api.js → scheduled-task-api.js} +37 -43
- package/lib/generated-client/api/search-api.d.ts +0 -45
- package/lib/generated-client/api/search-api.js +2 -8
- package/lib/generated-client/api/session-api.d.ts +163 -181
- package/lib/generated-client/api/session-api.js +262 -123
- package/lib/generated-client/api/{tv-shows-api.d.ts → show-api.d.ts} +34 -156
- package/lib/generated-client/api/{tv-shows-api.js → show-api.js} +36 -47
- package/lib/generated-client/api/startup-api.d.ts +20 -25
- package/lib/generated-client/api/startup-api.js +28 -14
- package/lib/generated-client/api/{studios-api.d.ts → studio-api.d.ts} +20 -70
- package/lib/generated-client/api/{studios-api.js → studio-api.js} +22 -28
- package/lib/generated-client/api/subtitle-api.d.ts +0 -114
- package/lib/generated-client/api/subtitle-api.js +11 -17
- package/lib/generated-client/api/{suggestions-api.d.ts → suggestion-api.d.ts} +14 -35
- package/lib/generated-client/api/{suggestions-api.js → suggestion-api.js} +17 -23
- package/lib/generated-client/api/sync-play-api.d.ts +0 -96
- package/lib/generated-client/api/sync-play-api.js +23 -29
- package/lib/generated-client/api/system-api.d.ts +420 -20
- package/lib/generated-client/api/system-api.js +659 -18
- package/lib/generated-client/api/{trailers-api.d.ts → trailer-api.d.ts} +32 -193
- package/lib/generated-client/api/{trailers-api.js → trailer-api.js} +35 -27
- package/lib/generated-client/api/{trickplay-api.d.ts → trick-play-api.d.ts} +20 -46
- package/lib/generated-client/api/{trickplay-api.js → trick-play-api.js} +22 -28
- package/lib/generated-client/api/user-api.d.ts +0 -249
- package/lib/generated-client/api/user-api.js +11 -277
- package/lib/generated-client/api/user-data-api.d.ts +429 -0
- package/lib/generated-client/api/{user-library-api.js → user-data-api.js} +149 -324
- package/lib/generated-client/api/{user-views-api.d.ts → user-view-api.d.ts} +20 -42
- package/lib/generated-client/api/{user-views-api.js → user-view-api.js} +22 -28
- package/lib/generated-client/api/{videos-api.d.ts → video-api.d.ts} +111 -533
- package/lib/generated-client/api/{videos-api.js → video-api.js} +141 -101
- package/lib/generated-client/api/{years-api.d.ts → year-api.d.ts} +20 -66
- package/lib/generated-client/api/{years-api.js → year-api.js} +22 -28
- package/lib/generated-client/api.d.ts +23 -38
- package/lib/generated-client/base.d.ts +0 -24
- package/lib/generated-client/base.js +0 -15
- package/lib/generated-client/common.d.ts +4 -35
- package/lib/generated-client/common.js +15 -26
- package/lib/generated-client/configuration.d.ts +24 -17
- package/lib/generated-client/configuration.js +8 -2
- package/lib/generated-client/index.js +25 -39
- package/lib/generated-client/models/access-schedule.d.ts +0 -15
- package/lib/generated-client/models/activity-log-entry-message.d.ts +0 -11
- package/lib/generated-client/models/activity-log-entry-query-result.d.ts +0 -8
- package/lib/generated-client/models/activity-log-entry-start-message.d.ts +1 -10
- package/lib/generated-client/models/activity-log-entry-stop-message.d.ts +0 -7
- package/lib/generated-client/models/activity-log-entry.d.ts +0 -25
- package/lib/generated-client/models/activity-log-sort-by.d.ts +23 -0
- package/lib/generated-client/models/{architecture.d.ts → activity-log-sort-by.js} +13 -11
- package/lib/generated-client/models/add-virtual-folder-dto.d.ts +0 -7
- package/lib/generated-client/models/album-info-remote-search-query.d.ts +0 -19
- package/lib/generated-client/models/album-info.d.ts +1 -49
- package/lib/generated-client/models/all-theme-media-result.d.ts +0 -20
- package/lib/generated-client/models/artist-info-remote-search-query.d.ts +0 -19
- package/lib/generated-client/models/artist-info.d.ts +0 -44
- package/lib/generated-client/models/audio-spatial-format.d.ts +0 -2
- package/lib/generated-client/models/audio-spatial-format.js +0 -2
- package/lib/generated-client/models/authenticate-user-by-name.d.ts +0 -6
- package/lib/generated-client/models/authentication-info-query-result.d.ts +0 -8
- package/lib/generated-client/models/authentication-info.d.ts +0 -35
- package/lib/generated-client/models/authentication-result.d.ts +0 -16
- package/lib/generated-client/models/backup-manifest-dto.d.ts +5 -20
- package/lib/generated-client/models/backup-options-dto.d.ts +0 -10
- package/lib/generated-client/models/backup-restore-request-dto.d.ts +1 -5
- package/lib/generated-client/models/base-item-dto-image-blur-hashes.d.ts +14 -81
- package/lib/generated-client/models/base-item-dto-query-result.d.ts +0 -8
- package/lib/generated-client/models/base-item-dto.d.ts +6 -456
- package/lib/generated-client/models/base-item-kind.d.ts +0 -2
- package/lib/generated-client/models/base-item-kind.js +0 -2
- package/lib/generated-client/models/base-item-person-image-blur-hashes.d.ts +13 -80
- package/lib/generated-client/models/base-item-person.d.ts +0 -20
- package/lib/generated-client/models/book-info-remote-search-query.d.ts +0 -19
- package/lib/generated-client/models/book-info.d.ts +2 -40
- package/lib/generated-client/models/box-set-info-remote-search-query.d.ts +0 -19
- package/lib/generated-client/models/box-set-info.d.ts +1 -37
- package/lib/generated-client/models/branding-options-dto.d.ts +1 -9
- package/lib/generated-client/models/buffer-request-dto.d.ts +0 -10
- package/lib/generated-client/models/cast-receiver-application.d.ts +2 -8
- package/lib/generated-client/models/channel-features.d.ts +0 -29
- package/lib/generated-client/models/channel-item-sort-field.d.ts +0 -5
- package/lib/generated-client/models/channel-item-sort-field.js +0 -5
- package/lib/generated-client/models/channel-mapping-options-dto.d.ts +2 -12
- package/lib/generated-client/models/channel-media-content-type.d.ts +0 -5
- package/lib/generated-client/models/channel-media-content-type.js +0 -5
- package/lib/generated-client/models/channel-media-type.d.ts +0 -5
- package/lib/generated-client/models/channel-media-type.js +0 -5
- package/lib/generated-client/models/channel-type.d.ts +0 -2
- package/lib/generated-client/models/channel-type.js +0 -2
- package/lib/generated-client/models/chapter-info.d.ts +0 -18
- package/lib/generated-client/models/client-capabilities-dto.d.ts +0 -19
- package/lib/generated-client/models/client-log-document-response-dto.d.ts +0 -4
- package/lib/generated-client/models/codec-profile.d.ts +0 -17
- package/lib/generated-client/models/codec-type.d.ts +1 -3
- package/lib/generated-client/models/codec-type.js +1 -3
- package/lib/generated-client/models/collection-creation-result.d.ts +0 -10
- package/lib/generated-client/models/collection-type-options.d.ts +0 -2
- package/lib/generated-client/models/collection-type-options.js +0 -2
- package/lib/generated-client/models/collection-type.d.ts +0 -2
- package/lib/generated-client/models/collection-type.js +0 -2
- package/lib/generated-client/models/configuration-page-info.d.ts +0 -14
- package/lib/generated-client/models/container-profile.d.ts +0 -13
- package/lib/generated-client/models/country-info.d.ts +0 -10
- package/lib/generated-client/models/create-playlist-dto.d.ts +1 -18
- package/lib/generated-client/models/create-user-by-name.d.ts +0 -6
- package/lib/generated-client/models/culture-dto.d.ts +0 -15
- package/lib/generated-client/models/custom-database-option.d.ts +2 -8
- package/lib/generated-client/models/custom-database-options.d.ts +3 -13
- package/lib/generated-client/models/database-configuration-options.d.ts +1 -15
- package/lib/generated-client/models/database-locking-behavior-types.d.ts +0 -2
- package/lib/generated-client/models/database-locking-behavior-types.js +0 -2
- package/lib/generated-client/models/day-of-week.d.ts +0 -5
- package/lib/generated-client/models/day-of-week.js +0 -5
- package/lib/generated-client/models/day-pattern.d.ts +1 -3
- package/lib/generated-client/models/day-pattern.js +1 -3
- package/lib/generated-client/models/default-directory-browser-info-dto.d.ts +0 -4
- package/lib/generated-client/models/deinterlace-method.d.ts +0 -2
- package/lib/generated-client/models/deinterlace-method.js +0 -2
- package/lib/generated-client/models/device-info-dto-query-result.d.ts +0 -8
- package/lib/generated-client/models/device-info-dto.d.ts +0 -27
- package/lib/generated-client/models/device-options-dto.d.ts +0 -8
- package/lib/generated-client/models/device-profile.d.ts +1 -25
- package/lib/generated-client/models/direct-play-profile.d.ts +0 -13
- package/lib/generated-client/models/display-preferences-dto.d.ts +0 -36
- package/lib/generated-client/models/dlna-profile-type.d.ts +0 -5
- package/lib/generated-client/models/dlna-profile-type.js +0 -5
- package/lib/generated-client/models/down-mix-stereo-algorithms.d.ts +0 -2
- package/lib/generated-client/models/down-mix-stereo-algorithms.js +0 -2
- package/lib/generated-client/models/dynamic-day-of-week.d.ts +0 -2
- package/lib/generated-client/models/dynamic-day-of-week.js +0 -2
- package/lib/generated-client/models/embedded-subtitle-options.d.ts +0 -2
- package/lib/generated-client/models/embedded-subtitle-options.js +0 -2
- package/lib/generated-client/models/encoder-preset.d.ts +0 -2
- package/lib/generated-client/models/encoder-preset.js +0 -2
- package/lib/generated-client/models/encoding-context.d.ts +1 -3
- package/lib/generated-client/models/encoding-context.js +1 -3
- package/lib/generated-client/models/encoding-options.d.ts +6 -117
- package/lib/generated-client/models/end-point-info.d.ts +0 -15
- package/lib/generated-client/models/external-id-info.d.ts +0 -11
- package/lib/generated-client/models/external-id-media-type.d.ts +0 -2
- package/lib/generated-client/models/external-id-media-type.js +0 -2
- package/lib/generated-client/models/external-url.d.ts +0 -9
- package/lib/generated-client/models/extra-type.d.ts +0 -5
- package/lib/generated-client/models/extra-type.js +0 -5
- package/lib/generated-client/models/file-system-entry-info.d.ts +0 -11
- package/lib/generated-client/models/file-system-entry-type.d.ts +0 -2
- package/lib/generated-client/models/file-system-entry-type.js +0 -2
- package/lib/generated-client/models/folder-storage-dto.d.ts +1 -13
- package/lib/generated-client/models/font-file.d.ts +0 -10
- package/lib/generated-client/models/force-keep-alive-message.d.ts +0 -11
- package/lib/generated-client/models/forgot-password-action.d.ts +0 -5
- package/lib/generated-client/models/forgot-password-action.js +0 -5
- package/lib/generated-client/models/forgot-password-dto.d.ts +0 -4
- package/lib/generated-client/models/forgot-password-pin-dto.d.ts +0 -4
- package/lib/generated-client/models/forgot-password-result.d.ts +0 -14
- package/lib/generated-client/models/general-command-message.d.ts +0 -14
- package/lib/generated-client/models/general-command-type.d.ts +0 -2
- package/lib/generated-client/models/general-command-type.js +0 -2
- package/lib/generated-client/models/general-command.d.ts +1 -21
- package/lib/generated-client/models/get-programs-dto.d.ts +0 -56
- package/lib/generated-client/models/group-info-dto.d.ts +0 -15
- package/lib/generated-client/models/group-queue-mode.d.ts +0 -2
- package/lib/generated-client/models/group-queue-mode.js +0 -2
- package/lib/generated-client/models/group-repeat-mode.d.ts +0 -2
- package/lib/generated-client/models/group-repeat-mode.js +0 -2
- package/lib/generated-client/models/group-shuffle-mode.d.ts +0 -2
- package/lib/generated-client/models/group-shuffle-mode.js +0 -2
- package/lib/generated-client/models/group-state-type.d.ts +0 -2
- package/lib/generated-client/models/group-state-type.js +0 -2
- package/lib/generated-client/models/group-state-update.d.ts +0 -12
- package/lib/generated-client/models/group-update-type.d.ts +0 -2
- package/lib/generated-client/models/group-update-type.js +0 -2
- package/lib/generated-client/models/group-update.d.ts +0 -1
- package/lib/generated-client/models/guide-info.d.ts +0 -9
- package/lib/generated-client/models/hardware-acceleration-type.d.ts +0 -2
- package/lib/generated-client/models/hardware-acceleration-type.js +0 -2
- package/lib/generated-client/models/{notification-level.d.ts → hls-audio-seek-strategy.d.ts} +5 -8
- package/lib/generated-client/models/{transcoding-info.js → hls-audio-seek-strategy.js} +8 -2
- package/lib/generated-client/models/ignore-wait-request-dto.d.ts +0 -4
- package/lib/generated-client/models/image-format.d.ts +0 -2
- package/lib/generated-client/models/image-format.js +0 -2
- package/lib/generated-client/models/image-info.d.ts +0 -21
- package/lib/generated-client/models/image-option.d.ts +0 -14
- package/lib/generated-client/models/image-orientation.d.ts +0 -5
- package/lib/generated-client/models/image-orientation.js +0 -5
- package/lib/generated-client/models/image-provider-info.d.ts +0 -6
- package/lib/generated-client/models/image-resolution.d.ts +0 -2
- package/lib/generated-client/models/image-resolution.js +0 -2
- package/lib/generated-client/models/image-saving-convention.d.ts +1 -3
- package/lib/generated-client/models/image-saving-convention.js +1 -3
- package/lib/generated-client/models/image-type.d.ts +0 -2
- package/lib/generated-client/models/image-type.js +0 -2
- package/lib/generated-client/models/inbound-keep-alive-message.d.ts +0 -7
- package/lib/generated-client/models/inbound-web-socket-message.d.ts +0 -1
- package/lib/generated-client/models/index.d.ts +2 -2
- package/lib/generated-client/models/index.js +2 -1
- package/lib/generated-client/models/installation-info.d.ts +0 -19
- package/lib/generated-client/models/iplugin.d.ts +0 -16
- package/lib/generated-client/models/iso-type.d.ts +0 -2
- package/lib/generated-client/models/iso-type.js +0 -2
- package/lib/generated-client/models/item-counts.d.ts +0 -26
- package/lib/generated-client/models/item-fields.d.ts +0 -2
- package/lib/generated-client/models/item-fields.js +0 -2
- package/lib/generated-client/models/item-filter.d.ts +0 -2
- package/lib/generated-client/models/item-filter.js +0 -2
- package/lib/generated-client/models/item-sort-by.d.ts +0 -2
- package/lib/generated-client/models/item-sort-by.js +0 -2
- package/lib/generated-client/models/join-group-request-dto.d.ts +0 -4
- package/lib/generated-client/models/keep-until.d.ts +0 -5
- package/lib/generated-client/models/keep-until.js +0 -5
- package/lib/generated-client/models/library-changed-message.d.ts +0 -14
- package/lib/generated-client/models/library-option-info-dto.d.ts +0 -6
- package/lib/generated-client/models/library-options-result-dto.d.ts +0 -14
- package/lib/generated-client/models/library-options.d.ts +0 -207
- package/lib/generated-client/models/library-storage-dto.d.ts +3 -11
- package/lib/generated-client/models/library-type-options-dto.d.ts +4 -12
- package/lib/generated-client/models/library-update-info.d.ts +0 -22
- package/lib/generated-client/models/listings-provider-info.d.ts +0 -95
- package/lib/generated-client/models/live-stream-response.d.ts +0 -10
- package/lib/generated-client/models/live-tv-info.d.ts +0 -11
- package/lib/generated-client/models/live-tv-options.d.ts +0 -80
- package/lib/generated-client/models/live-tv-service-info.d.ts +0 -24
- package/lib/generated-client/models/live-tv-service-status.d.ts +1 -3
- package/lib/generated-client/models/live-tv-service-status.js +1 -3
- package/lib/generated-client/models/localization-option.d.ts +0 -15
- package/lib/generated-client/models/location-type.d.ts +0 -2
- package/lib/generated-client/models/location-type.js +0 -2
- package/lib/generated-client/models/log-file.d.ts +1 -14
- package/lib/generated-client/models/log-level.d.ts +0 -5
- package/lib/generated-client/models/log-level.js +0 -5
- package/lib/generated-client/models/lyric-dto.d.ts +0 -9
- package/lib/generated-client/models/lyric-line-cue.d.ts +0 -10
- package/lib/generated-client/models/lyric-line.d.ts +0 -8
- package/lib/generated-client/models/lyric-metadata.d.ts +0 -22
- package/lib/generated-client/models/media-attachment.d.ts +0 -16
- package/lib/generated-client/models/media-path-dto.d.ts +0 -11
- package/lib/generated-client/models/media-path-info.d.ts +0 -10
- package/lib/generated-client/models/media-protocol.d.ts +0 -5
- package/lib/generated-client/models/media-protocol.js +0 -5
- package/lib/generated-client/models/media-segment-dto-query-result.d.ts +0 -8
- package/lib/generated-client/models/media-segment-dto.d.ts +0 -15
- package/lib/generated-client/models/media-segment-type.d.ts +0 -2
- package/lib/generated-client/models/media-segment-type.js +0 -2
- package/lib/generated-client/models/media-source-info.d.ts +1 -228
- package/lib/generated-client/models/media-source-type.d.ts +1 -3
- package/lib/generated-client/models/media-source-type.js +1 -3
- package/lib/generated-client/models/media-stream-protocol.d.ts +1 -3
- package/lib/generated-client/models/media-stream-protocol.js +1 -3
- package/lib/generated-client/models/media-stream-type.d.ts +0 -2
- package/lib/generated-client/models/media-stream-type.js +0 -2
- package/lib/generated-client/models/media-stream.d.ts +7 -176
- package/lib/generated-client/models/media-type.d.ts +0 -2
- package/lib/generated-client/models/media-type.js +0 -2
- package/lib/generated-client/models/media-update-info-dto.d.ts +0 -4
- package/lib/generated-client/models/media-update-info-path-dto.d.ts +1 -7
- package/lib/generated-client/models/media-url.d.ts +0 -15
- package/lib/generated-client/models/message-command.d.ts +4 -12
- package/lib/generated-client/models/metadata-configuration.d.ts +0 -10
- package/lib/generated-client/models/metadata-editor-info.d.ts +0 -17
- package/lib/generated-client/models/metadata-field.d.ts +0 -2
- package/lib/generated-client/models/metadata-field.js +0 -2
- package/lib/generated-client/models/metadata-options.d.ts +0 -37
- package/lib/generated-client/models/metadata-refresh-mode.d.ts +0 -5
- package/lib/generated-client/models/metadata-refresh-mode.js +0 -5
- package/lib/generated-client/models/move-playlist-item-request-dto.d.ts +0 -6
- package/lib/generated-client/models/movie-info-remote-search-query.d.ts +0 -19
- package/lib/generated-client/models/movie-info.d.ts +1 -37
- package/lib/generated-client/models/music-video-info-remote-search-query.d.ts +0 -19
- package/lib/generated-client/models/music-video-info.d.ts +0 -44
- package/lib/generated-client/models/name-guid-pair.d.ts +0 -15
- package/lib/generated-client/models/name-id-pair.d.ts +0 -9
- package/lib/generated-client/models/name-value-pair.d.ts +0 -9
- package/lib/generated-client/models/network-configuration.d.ts +1 -49
- package/lib/generated-client/models/new-group-request-dto.d.ts +0 -4
- package/lib/generated-client/models/next-item-request-dto.d.ts +0 -4
- package/lib/generated-client/models/open-live-stream-dto.d.ts +0 -33
- package/lib/generated-client/models/outbound-keep-alive-message.d.ts +0 -9
- package/lib/generated-client/models/outbound-web-socket-message.d.ts +0 -1
- package/lib/generated-client/models/package-info.d.ts +1 -19
- package/lib/generated-client/models/parental-rating-score.d.ts +0 -6
- package/lib/generated-client/models/parental-rating.d.ts +0 -11
- package/lib/generated-client/models/path-substitution.d.ts +0 -6
- package/lib/generated-client/models/person-kind.d.ts +1 -2
- package/lib/generated-client/models/person-kind.js +2 -3
- package/lib/generated-client/models/person-lookup-info-remote-search-query.d.ts +0 -19
- package/lib/generated-client/models/person-lookup-info.d.ts +1 -37
- package/lib/generated-client/models/pin-redeem-result.d.ts +0 -9
- package/lib/generated-client/models/ping-request-dto.d.ts +0 -4
- package/lib/generated-client/models/play-access.d.ts +1 -3
- package/lib/generated-client/models/play-access.js +1 -3
- package/lib/generated-client/models/play-command.d.ts +0 -2
- package/lib/generated-client/models/play-command.js +0 -2
- package/lib/generated-client/models/play-message.d.ts +0 -14
- package/lib/generated-client/models/play-method.d.ts +1 -3
- package/lib/generated-client/models/play-method.js +1 -3
- package/lib/generated-client/models/play-queue-update-reason.d.ts +0 -2
- package/lib/generated-client/models/play-queue-update-reason.js +0 -2
- package/lib/generated-client/models/play-queue-update.d.ts +0 -27
- package/lib/generated-client/models/play-request-dto.d.ts +0 -8
- package/lib/generated-client/models/play-request.d.ts +0 -33
- package/lib/generated-client/models/playback-error-code.d.ts +1 -3
- package/lib/generated-client/models/playback-error-code.js +1 -3
- package/lib/generated-client/models/playback-info-dto.d.ts +0 -37
- package/lib/generated-client/models/playback-info-response.d.ts +0 -11
- package/lib/generated-client/models/playback-order.d.ts +0 -2
- package/lib/generated-client/models/playback-order.js +0 -2
- package/lib/generated-client/models/playback-progress-info.d.ts +0 -71
- package/lib/generated-client/models/playback-request-type.d.ts +0 -2
- package/lib/generated-client/models/playback-request-type.js +0 -2
- package/lib/generated-client/models/playback-start-info.d.ts +0 -71
- package/lib/generated-client/models/playback-stop-info.d.ts +0 -36
- package/lib/generated-client/models/player-state-info.d.ts +0 -38
- package/lib/generated-client/models/playlist-creation-result.d.ts +0 -10
- package/lib/generated-client/models/playlist-dto.d.ts +2 -10
- package/lib/generated-client/models/playlist-user-permissions.d.ts +0 -6
- package/lib/generated-client/models/playstate-command.d.ts +0 -2
- package/lib/generated-client/models/playstate-command.js +0 -2
- package/lib/generated-client/models/playstate-message.d.ts +0 -14
- package/lib/generated-client/models/playstate-request.d.ts +2 -13
- package/lib/generated-client/models/plugin-info.d.ts +0 -21
- package/lib/generated-client/models/plugin-installation-cancelled-message.d.ts +0 -14
- package/lib/generated-client/models/plugin-installation-completed-message.d.ts +0 -14
- package/lib/generated-client/models/plugin-installation-failed-message.d.ts +0 -14
- package/lib/generated-client/models/plugin-installing-message.d.ts +0 -14
- package/lib/generated-client/models/plugin-status.d.ts +0 -2
- package/lib/generated-client/models/plugin-status.js +0 -2
- package/lib/generated-client/models/plugin-uninstalled-message.d.ts +0 -14
- package/lib/generated-client/models/previous-item-request-dto.d.ts +0 -4
- package/lib/generated-client/models/problem-details.d.ts +0 -30
- package/lib/generated-client/models/process-priority-class.d.ts +0 -5
- package/lib/generated-client/models/process-priority-class.js +0 -5
- package/lib/generated-client/models/profile-condition-type.d.ts +0 -5
- package/lib/generated-client/models/profile-condition-type.js +0 -5
- package/lib/generated-client/models/profile-condition-value.d.ts +1 -5
- package/lib/generated-client/models/profile-condition-value.js +2 -6
- package/lib/generated-client/models/profile-condition.d.ts +0 -25
- package/lib/generated-client/models/program-audio.d.ts +0 -5
- package/lib/generated-client/models/program-audio.js +0 -5
- package/lib/generated-client/models/public-system-info.d.ts +0 -19
- package/lib/generated-client/models/query-filters-legacy.d.ts +0 -25
- package/lib/generated-client/models/query-filters.d.ts +3 -15
- package/lib/generated-client/models/queue-item.d.ts +3 -9
- package/lib/generated-client/models/queue-request-dto.d.ts +0 -9
- package/lib/generated-client/models/quick-connect-dto.d.ts +0 -4
- package/lib/generated-client/models/quick-connect-result.d.ts +0 -18
- package/lib/generated-client/models/rating-type.d.ts +1 -3
- package/lib/generated-client/models/rating-type.js +1 -3
- package/lib/generated-client/models/ready-request-dto.d.ts +0 -10
- package/lib/generated-client/models/recommendation-dto.d.ts +0 -25
- package/lib/generated-client/models/recommendation-type.d.ts +0 -5
- package/lib/generated-client/models/recommendation-type.js +0 -5
- package/lib/generated-client/models/recording-status.d.ts +0 -5
- package/lib/generated-client/models/recording-status.js +0 -5
- package/lib/generated-client/models/refresh-progress-message.d.ts +0 -11
- package/lib/generated-client/models/remote-image-info.d.ts +0 -28
- package/lib/generated-client/models/remote-image-result.d.ts +0 -8
- package/lib/generated-client/models/remote-lyric-info-dto.d.ts +3 -14
- package/lib/generated-client/models/remote-search-result.d.ts +3 -59
- package/lib/generated-client/models/remote-subtitle-info.d.ts +0 -85
- package/lib/generated-client/models/remove-from-playlist-request-dto.d.ts +0 -8
- package/lib/generated-client/models/repeat-mode.d.ts +1 -3
- package/lib/generated-client/models/repeat-mode.js +1 -3
- package/lib/generated-client/models/repository-info.d.ts +0 -8
- package/lib/generated-client/models/restart-required-message.d.ts +0 -9
- package/lib/generated-client/models/scheduled-task-ended-message.d.ts +0 -14
- package/lib/generated-client/models/scheduled-tasks-info-message.d.ts +0 -11
- package/lib/generated-client/models/scheduled-tasks-info-start-message.d.ts +1 -10
- package/lib/generated-client/models/scheduled-tasks-info-stop-message.d.ts +0 -7
- package/lib/generated-client/models/scroll-direction.d.ts +0 -2
- package/lib/generated-client/models/scroll-direction.js +0 -2
- package/lib/generated-client/models/search-hint-result.d.ts +0 -6
- package/lib/generated-client/models/search-hint.d.ts +0 -66
- package/lib/generated-client/models/seek-request-dto.d.ts +0 -4
- package/lib/generated-client/models/send-command-type.d.ts +0 -2
- package/lib/generated-client/models/send-command-type.js +0 -2
- package/lib/generated-client/models/send-command.d.ts +0 -17
- package/lib/generated-client/models/series-info-remote-search-query.d.ts +0 -19
- package/lib/generated-client/models/series-info.d.ts +1 -37
- package/lib/generated-client/models/series-status.d.ts +0 -2
- package/lib/generated-client/models/series-status.js +0 -2
- package/lib/generated-client/models/series-timer-cancelled-message.d.ts +0 -14
- package/lib/generated-client/models/series-timer-created-message.d.ts +0 -14
- package/lib/generated-client/models/series-timer-info-dto-query-result.d.ts +0 -8
- package/lib/generated-client/models/series-timer-info-dto.d.ts +1 -91
- package/lib/generated-client/models/server-configuration.d.ts +3 -180
- package/lib/generated-client/models/server-discovery-info.d.ts +0 -10
- package/lib/generated-client/models/server-restarting-message.d.ts +0 -9
- package/lib/generated-client/models/server-shutting-down-message.d.ts +0 -9
- package/lib/generated-client/models/session-info-dto.d.ts +1 -80
- package/lib/generated-client/models/session-message-type.d.ts +0 -2
- package/lib/generated-client/models/session-message-type.js +0 -2
- package/lib/generated-client/models/session-user-info.d.ts +0 -6
- package/lib/generated-client/models/sessions-message.d.ts +0 -11
- package/lib/generated-client/models/sessions-start-message.d.ts +1 -10
- package/lib/generated-client/models/sessions-stop-message.d.ts +0 -7
- package/lib/generated-client/models/set-channel-mapping-dto.d.ts +0 -8
- package/lib/generated-client/models/set-playlist-item-request-dto.d.ts +0 -4
- package/lib/generated-client/models/set-repeat-mode-request-dto.d.ts +0 -7
- package/lib/generated-client/models/set-shuffle-mode-request-dto.d.ts +0 -7
- package/lib/generated-client/models/song-info.d.ts +0 -54
- package/lib/generated-client/models/sort-order.d.ts +0 -2
- package/lib/generated-client/models/sort-order.js +0 -2
- package/lib/generated-client/models/special-view-option-dto.d.ts +0 -6
- package/lib/generated-client/models/startup-configuration-dto.d.ts +0 -10
- package/lib/generated-client/models/startup-remote-access-dto.d.ts +0 -11
- package/lib/generated-client/models/startup-user-dto.d.ts +0 -6
- package/lib/generated-client/models/subtitle-delivery-method.d.ts +0 -2
- package/lib/generated-client/models/subtitle-delivery-method.js +0 -2
- package/lib/generated-client/models/subtitle-playback-mode.d.ts +0 -2
- package/lib/generated-client/models/subtitle-playback-mode.js +0 -2
- package/lib/generated-client/models/subtitle-profile.d.ts +0 -15
- package/lib/generated-client/models/sync-play-command-message.d.ts +0 -14
- package/lib/generated-client/models/sync-play-group-does-not-exist-update.d.ts +0 -14
- package/lib/generated-client/models/sync-play-group-joined-update.d.ts +0 -17
- package/lib/generated-client/models/sync-play-group-left-update.d.ts +0 -14
- package/lib/generated-client/models/sync-play-group-update-message.d.ts +0 -14
- package/lib/generated-client/models/sync-play-library-access-denied-update.d.ts +0 -14
- package/lib/generated-client/models/sync-play-not-in-group-update.d.ts +0 -14
- package/lib/generated-client/models/sync-play-play-queue-update.d.ts +0 -17
- package/lib/generated-client/models/sync-play-queue-item.d.ts +0 -6
- package/lib/generated-client/models/sync-play-state-update.d.ts +0 -17
- package/lib/generated-client/models/sync-play-user-access-type.d.ts +0 -2
- package/lib/generated-client/models/sync-play-user-access-type.js +0 -2
- package/lib/generated-client/models/sync-play-user-joined-update.d.ts +0 -14
- package/lib/generated-client/models/sync-play-user-left-update.d.ts +0 -14
- package/lib/generated-client/models/system-info.d.ts +0 -62
- package/lib/generated-client/models/system-storage-dto.d.ts +8 -47
- package/lib/generated-client/models/task-completion-status.d.ts +0 -2
- package/lib/generated-client/models/task-completion-status.js +0 -2
- package/lib/generated-client/models/task-info.d.ts +0 -28
- package/lib/generated-client/models/task-result.d.ts +0 -21
- package/lib/generated-client/models/task-state.d.ts +0 -2
- package/lib/generated-client/models/task-state.js +0 -2
- package/lib/generated-client/models/task-trigger-info-type.d.ts +0 -2
- package/lib/generated-client/models/task-trigger-info-type.js +0 -2
- package/lib/generated-client/models/task-trigger-info.d.ts +0 -18
- package/lib/generated-client/models/theme-media-result.d.ts +0 -10
- package/lib/generated-client/models/timer-cancelled-message.d.ts +0 -14
- package/lib/generated-client/models/timer-created-message.d.ts +0 -14
- package/lib/generated-client/models/timer-event-info.d.ts +0 -15
- package/lib/generated-client/models/timer-info-dto-query-result.d.ts +0 -8
- package/lib/generated-client/models/timer-info-dto.d.ts +0 -76
- package/lib/generated-client/models/tonemapping-algorithm.d.ts +0 -2
- package/lib/generated-client/models/tonemapping-algorithm.js +0 -2
- package/lib/generated-client/models/tonemapping-mode.d.ts +0 -2
- package/lib/generated-client/models/tonemapping-mode.js +0 -2
- package/lib/generated-client/models/tonemapping-range.d.ts +0 -2
- package/lib/generated-client/models/tonemapping-range.js +0 -2
- package/lib/generated-client/models/trailer-info-remote-search-query.d.ts +0 -19
- package/lib/generated-client/models/trailer-info.d.ts +1 -37
- package/lib/generated-client/models/transcode-reason.d.ts +1 -5
- package/lib/generated-client/models/transcode-reason.js +2 -6
- package/lib/generated-client/models/transcode-seek-info.d.ts +1 -3
- package/lib/generated-client/models/transcode-seek-info.js +1 -3
- package/lib/generated-client/models/transcoding-info.d.ts +2 -34
- package/lib/generated-client/models/transcoding-profile.d.ts +3 -50
- package/lib/generated-client/models/transport-stream-timestamp.d.ts +1 -3
- package/lib/generated-client/models/transport-stream-timestamp.js +1 -3
- package/lib/generated-client/models/trickplay-info-dto.d.ts +0 -16
- package/lib/generated-client/models/trickplay-options.d.ts +1 -33
- package/lib/generated-client/models/trickplay-scan-behavior.d.ts +0 -2
- package/lib/generated-client/models/trickplay-scan-behavior.js +0 -2
- package/lib/generated-client/models/tuner-channel-mapping.d.ts +0 -25
- package/lib/generated-client/models/tuner-host-info.d.ts +0 -85
- package/lib/generated-client/models/type-options.d.ts +2 -35
- package/lib/generated-client/models/unrated-item.d.ts +0 -2
- package/lib/generated-client/models/unrated-item.js +0 -2
- package/lib/generated-client/models/update-library-options-dto.d.ts +0 -9
- package/lib/generated-client/models/update-media-path-request-dto.d.ts +0 -9
- package/lib/generated-client/models/update-playlist-dto.d.ts +0 -10
- package/lib/generated-client/models/update-playlist-user-dto.d.ts +0 -4
- package/lib/generated-client/models/update-user-item-data-dto.d.ts +0 -24
- package/lib/generated-client/models/update-user-password.d.ts +0 -10
- package/lib/generated-client/models/upload-subtitle-dto.d.ts +0 -12
- package/lib/generated-client/models/user-configuration.d.ts +0 -70
- package/lib/generated-client/models/user-data-change-info.d.ts +1 -7
- package/lib/generated-client/models/user-data-changed-message.d.ts +0 -14
- package/lib/generated-client/models/user-deleted-message.d.ts +0 -11
- package/lib/generated-client/models/user-dto.d.ts +6 -40
- package/lib/generated-client/models/user-item-data-dto.d.ts +1 -25
- package/lib/generated-client/models/user-policy.d.ts +0 -201
- package/lib/generated-client/models/user-updated-message.d.ts +0 -14
- package/lib/generated-client/models/utc-time-response.d.ts +0 -6
- package/lib/generated-client/models/validate-path-dto.d.ts +0 -8
- package/lib/generated-client/models/version-info.d.ts +0 -20
- package/lib/generated-client/models/video-range-type.d.ts +0 -2
- package/lib/generated-client/models/video-range-type.js +0 -2
- package/lib/generated-client/models/video-range.d.ts +0 -2
- package/lib/generated-client/models/video-range.js +0 -2
- package/lib/generated-client/models/video-type.d.ts +0 -2
- package/lib/generated-client/models/video-type.js +0 -2
- package/lib/generated-client/models/video3-dformat.d.ts +0 -5
- package/lib/generated-client/models/video3-dformat.js +0 -5
- package/lib/generated-client/models/virtual-folder-info.d.ts +0 -30
- package/lib/generated-client/models/web-socket-message.d.ts +0 -1
- package/lib/generated-client/models/xbmc-metadata-options.d.ts +0 -30
- package/lib/index.js +1 -1
- package/lib/models/api/image-request-parameters.d.ts +1 -1
- package/lib/models/device-info.d.ts +1 -0
- package/lib/utils/api/{videos-api.d.ts → artist-api.d.ts} +2 -2
- package/lib/utils/api/{movies-api.js → artist-api.js} +4 -4
- package/lib/utils/api/authentication-api.d.ts +8 -0
- package/lib/utils/api/authentication-api.js +35 -0
- package/lib/utils/api/{tmdb-api.d.ts → backup-api.d.ts} +2 -2
- package/lib/utils/api/backup-api.js +13 -0
- package/lib/utils/api/{artists-api.d.ts → channel-api.d.ts} +2 -2
- package/lib/utils/api/{artists-api.js → channel-api.js} +4 -4
- package/lib/utils/api/{movies-api.d.ts → device-api.d.ts} +2 -2
- package/lib/utils/api/{lyrics-api.js → device-api.js} +4 -4
- package/lib/utils/api/display-preference-api.d.ts +8 -0
- package/lib/utils/api/display-preference-api.js +12 -0
- package/lib/utils/api/{items-api.d.ts → genre-api.d.ts} +2 -2
- package/lib/utils/api/{items-api.js → genre-api.js} +4 -4
- package/lib/utils/api/index.d.ts +24 -38
- package/lib/utils/api/index.js +24 -38
- package/lib/utils/api/library-api.d.ts +14 -2
- package/lib/utils/api/library-api.js +17 -1
- package/lib/utils/api/{years-api.d.ts → lyric-api.d.ts} +2 -2
- package/lib/utils/api/{years-api.js → lyric-api.js} +4 -4
- package/lib/utils/api/{activity-log-api.d.ts → media-segment-api.d.ts} +2 -2
- package/lib/utils/api/{quick-connect-api.js → media-segment-api.js} +4 -4
- package/lib/utils/api/movie-api.d.ts +8 -0
- package/lib/utils/api/movie-api.js +12 -0
- package/lib/utils/api/{dynamic-hls-api.d.ts → music-genre-api.d.ts} +2 -2
- package/lib/utils/api/{dynamic-hls-api.js → music-genre-api.js} +4 -4
- package/lib/utils/api/{genres-api.d.ts → person-api.d.ts} +2 -2
- package/lib/utils/api/{genres-api.js → person-api.js} +4 -4
- package/lib/utils/api/{trailers-api.d.ts → playlist-api.d.ts} +2 -2
- package/lib/utils/api/{channels-api.js → playlist-api.js} +4 -4
- package/lib/utils/api/{lyrics-api.d.ts → plugin-api.d.ts} +2 -2
- package/lib/utils/api/{videos-api.js → plugin-api.js} +4 -4
- package/lib/utils/api/scheduled-task-api.d.ts +8 -0
- package/lib/utils/api/{configuration-api.js → scheduled-task-api.js} +4 -4
- package/lib/utils/api/session-api.js +18 -1
- package/lib/utils/api/show-api.d.ts +8 -0
- package/lib/utils/api/{tmdb-api.js → show-api.js} +4 -4
- package/lib/utils/api/studio-api.d.ts +8 -0
- package/lib/utils/api/studio-api.js +12 -0
- package/lib/utils/api/{hls-segment-api.d.ts → suggestion-api.d.ts} +2 -2
- package/lib/utils/api/{hls-segment-api.js → suggestion-api.js} +4 -4
- package/lib/utils/api/{package-api.d.ts → trailer-api.d.ts} +2 -2
- package/lib/utils/api/{devices-api.js → trailer-api.js} +4 -4
- package/lib/utils/api/{dashboard-api.d.ts → trick-play-api.d.ts} +2 -2
- package/lib/utils/api/{dashboard-api.js → trick-play-api.js} +4 -4
- package/lib/utils/api/{api-key-api.d.ts → user-data-api.d.ts} +2 -2
- package/lib/utils/api/{time-sync-api.js → user-data-api.js} +4 -4
- package/lib/utils/api/{channels-api.d.ts → user-view-api.d.ts} +2 -2
- package/lib/utils/api/{trailers-api.js → user-view-api.js} +4 -4
- package/lib/utils/api/video-api.d.ts +8 -0
- package/lib/utils/api/video-api.js +12 -0
- package/lib/utils/api/year-api.d.ts +8 -0
- package/lib/utils/api/year-api.js +12 -0
- package/lib/utils/index.js +2 -2
- package/lib/utils/url/index.d.ts +1 -0
- package/lib/utils/url/index.js +4 -1
- package/lib/utils/versioning.d.ts +12 -1
- package/lib/utils/versioning.js +44 -13
- package/lib/versions.d.ts +1 -1
- package/lib/versions.js +1 -1
- package/lib/websocket/constants.d.ts +24 -0
- package/lib/websocket/constants.js +42 -0
- package/lib/websocket/index.d.ts +8 -0
- package/lib/websocket/index.js +3 -0
- package/lib/{utils/api/client-log-api.d.ts → websocket/models.d.ts} +6 -3
- package/lib/websocket/models.js +16 -0
- package/lib/websocket/types.d.ts +37 -0
- package/lib/websocket/types.js +42 -0
- package/lib/websocket/websocket-service.d.ts +142 -0
- package/lib/websocket/websocket-service.js +296 -0
- package/package.json +20 -16
- package/lib/generated-client/api/activity-log-api.d.ts +0 -110
- package/lib/generated-client/api/activity-log-api.js +0 -135
- package/lib/generated-client/api/api-key-api.d.ts +0 -161
- package/lib/generated-client/api/api-key-api.js +0 -245
- package/lib/generated-client/api/client-log-api.d.ts +0 -86
- package/lib/generated-client/api/client-log-api.js +0 -117
- package/lib/generated-client/api/configuration-api.d.ts +0 -292
- package/lib/generated-client/api/configuration-api.js +0 -442
- package/lib/generated-client/api/dashboard-api.d.ts +0 -132
- package/lib/generated-client/api/dashboard-api.js +0 -182
- package/lib/generated-client/api/dlna-api.d.ts +0 -292
- package/lib/generated-client/api/dlna-server-api.d.ts +0 -784
- package/lib/generated-client/api/dynamic-hls-api.d.ts +0 -4261
- package/lib/generated-client/api/dynamic-hls-api.js +0 -3025
- package/lib/generated-client/api/hls-segment-api.d.ts +0 -325
- package/lib/generated-client/api/hls-segment-api.js +0 -415
- package/lib/generated-client/api/image-by-name-api.d.ts +0 -292
- package/lib/generated-client/api/item-refresh-api.d.ts +0 -126
- package/lib/generated-client/api/item-refresh-api.js +0 -143
- package/lib/generated-client/api/items-api.d.ts +0 -1052
- package/lib/generated-client/api/items-api.js +0 -835
- package/lib/generated-client/api/music-genres-api.d.ts +0 -286
- package/lib/generated-client/api/music-genres-api.js +0 -278
- package/lib/generated-client/api/notifications-api.d.ts +0 -332
- package/lib/generated-client/api/package-api.d.ts +0 -315
- package/lib/generated-client/api/package-api.js +0 -455
- package/lib/generated-client/api/playstate-api.d.ts +0 -679
- package/lib/generated-client/api/playstate-api.js +0 -789
- package/lib/generated-client/api/plugins-api.d.ts +0 -473
- package/lib/generated-client/api/plugins-api.js +0 -663
- package/lib/generated-client/api/quick-connect-api.d.ts +0 -198
- package/lib/generated-client/api/quick-connect-api.js +0 -305
- package/lib/generated-client/api/time-sync-api.d.ts +0 -69
- package/lib/generated-client/api/time-sync-api.js +0 -109
- package/lib/generated-client/api/tmdb-api.d.ts +0 -69
- package/lib/generated-client/api/tmdb-api.js +0 -111
- package/lib/generated-client/api/universal-audio-api.d.ts +0 -420
- package/lib/generated-client/api/universal-audio-api.js +0 -364
- package/lib/generated-client/api/user-library-api.d.ts +0 -657
- package/lib/generated-client/api/video-attachments-api.d.ts +0 -101
- package/lib/generated-client/api/video-attachments-api.js +0 -126
- package/lib/generated-client/models/admin-notification-dto.d.ts +0 -42
- package/lib/generated-client/models/base-item.d.ts +0 -84
- package/lib/generated-client/models/branding-options.d.ts +0 -35
- package/lib/generated-client/models/client-capabilities.d.ts +0 -76
- package/lib/generated-client/models/config-image-types.d.ts +0 -59
- package/lib/generated-client/models/control-response.d.ts +0 -37
- package/lib/generated-client/models/device-identification.d.ts +0 -72
- package/lib/generated-client/models/device-info-query-result.d.ts +0 -36
- package/lib/generated-client/models/device-info.d.ts +0 -84
- package/lib/generated-client/models/device-options.d.ts +0 -35
- package/lib/generated-client/models/device-profile-info.d.ts +0 -36
- package/lib/generated-client/models/device-profile-type.d.ts +0 -20
- package/lib/generated-client/models/dlna-options.d.ts +0 -83
- package/lib/generated-client/models/ffmpeg-location.d.ts +0 -22
- package/lib/generated-client/models/group-info-dto-group-update.d.ts +0 -37
- package/lib/generated-client/models/group-state-update-group-update.d.ts +0 -37
- package/lib/generated-client/models/hardware-encoding-type.d.ts +0 -25
- package/lib/generated-client/models/header-match-type.d.ts +0 -21
- package/lib/generated-client/models/http-header-info.d.ts +0 -36
- package/lib/generated-client/models/image-by-name-info.d.ts +0 -47
- package/lib/generated-client/models/media-encoder-path-dto.d.ts +0 -29
- package/lib/generated-client/models/notification-dto.d.ts +0 -66
- package/lib/generated-client/models/notification-option.d.ts +0 -54
- package/lib/generated-client/models/notification-options.d.ts +0 -24
- package/lib/generated-client/models/notification-result-dto.d.ts +0 -30
- package/lib/generated-client/models/notification-type-info.d.ts +0 -47
- package/lib/generated-client/models/notifications-summary-dto.d.ts +0 -30
- package/lib/generated-client/models/object-group-update.d.ts +0 -36
- package/lib/generated-client/models/play-queue-update-group-update.d.ts +0 -37
- package/lib/generated-client/models/response-profile.d.ts +0 -61
- package/lib/generated-client/models/send-to-user-type.d.ts +0 -21
- package/lib/generated-client/models/session-info.d.ts +0 -199
- package/lib/generated-client/models/string-group-update.d.ts +0 -36
- package/lib/generated-client/models/subtitle-options.d.ts +0 -71
- package/lib/generated-client/models/sync-play-group-update-command-message.d.ts +0 -37
- package/lib/generated-client/models/trickplay-info.d.ts +0 -65
- package/lib/generated-client/models/update-user-easy-password.d.ts +0 -35
- package/lib/generated-client/models/wake-on-lan-info.d.ts +0 -29
- package/lib/generated-client/models/xml-attribute.d.ts +0 -29
- package/lib/utils/api/activity-log-api.js +0 -12
- package/lib/utils/api/api-key-api.js +0 -12
- package/lib/utils/api/client-log-api.js +0 -12
- package/lib/utils/api/configuration-api.d.ts +0 -8
- package/lib/utils/api/devices-api.d.ts +0 -8
- package/lib/utils/api/display-preferences-api.d.ts +0 -8
- package/lib/utils/api/display-preferences-api.js +0 -12
- package/lib/utils/api/item-refresh-api.d.ts +0 -8
- package/lib/utils/api/item-refresh-api.js +0 -12
- package/lib/utils/api/media-segments-api.d.ts +0 -8
- package/lib/utils/api/media-segments-api.js +0 -12
- package/lib/utils/api/music-genres-api.d.ts +0 -8
- package/lib/utils/api/music-genres-api.js +0 -12
- package/lib/utils/api/package-api.js +0 -12
- package/lib/utils/api/persons-api.d.ts +0 -8
- package/lib/utils/api/persons-api.js +0 -12
- package/lib/utils/api/playlists-api.d.ts +0 -8
- package/lib/utils/api/playlists-api.js +0 -12
- package/lib/utils/api/playstate-api.d.ts +0 -8
- package/lib/utils/api/playstate-api.js +0 -12
- package/lib/utils/api/plugins-api.d.ts +0 -8
- package/lib/utils/api/plugins-api.js +0 -12
- package/lib/utils/api/quick-connect-api.d.ts +0 -8
- package/lib/utils/api/scheduled-tasks-api.d.ts +0 -8
- package/lib/utils/api/scheduled-tasks-api.js +0 -12
- package/lib/utils/api/studios-api.d.ts +0 -8
- package/lib/utils/api/studios-api.js +0 -12
- package/lib/utils/api/suggestions-api.d.ts +0 -8
- package/lib/utils/api/suggestions-api.js +0 -12
- package/lib/utils/api/time-sync-api.d.ts +0 -8
- package/lib/utils/api/trickplay-api.d.ts +0 -8
- package/lib/utils/api/trickplay-api.js +0 -12
- package/lib/utils/api/tv-shows-api.d.ts +0 -8
- package/lib/utils/api/tv-shows-api.js +0 -12
- package/lib/utils/api/universal-audio-api.d.ts +0 -8
- package/lib/utils/api/universal-audio-api.js +0 -12
- package/lib/utils/api/user-library-api.d.ts +0 -8
- package/lib/utils/api/user-library-api.js +0 -12
- package/lib/utils/api/user-views-api.d.ts +0 -8
- package/lib/utils/api/user-views-api.js +0 -12
- package/lib/utils/api/video-attachments-api.d.ts +0 -8
- package/lib/utils/api/video-attachments-api.js +0 -12
|
@@ -14,17 +14,24 @@ import { type RequestArgs, BaseAPI } from '../base';
|
|
|
14
14
|
import type { AllThemeMediaResult } from '../models';
|
|
15
15
|
import type { BaseItemDto } from '../models';
|
|
16
16
|
import type { BaseItemDtoQueryResult } from '../models';
|
|
17
|
+
import type { BaseItemKind } from '../models';
|
|
17
18
|
import type { CollectionType } from '../models';
|
|
19
|
+
import type { ImageType } from '../models';
|
|
18
20
|
import type { ItemCounts } from '../models';
|
|
19
21
|
import type { ItemFields } from '../models';
|
|
22
|
+
import type { ItemFilter } from '../models';
|
|
20
23
|
import type { ItemSortBy } from '../models';
|
|
21
24
|
import type { LibraryOptionsResultDto } from '../models';
|
|
25
|
+
import type { LocationType } from '../models';
|
|
26
|
+
import type { MediaType } from '../models';
|
|
22
27
|
import type { MediaUpdateInfoDto } from '../models';
|
|
28
|
+
import type { MetadataRefreshMode } from '../models';
|
|
29
|
+
import type { SeriesStatus } from '../models';
|
|
23
30
|
import type { SortOrder } from '../models';
|
|
24
31
|
import type { ThemeMediaResult } from '../models';
|
|
32
|
+
import type { VideoType } from '../models';
|
|
25
33
|
/**
|
|
26
34
|
* LibraryApi - axios parameter creator
|
|
27
|
-
* @export
|
|
28
35
|
*/
|
|
29
36
|
export declare const LibraryApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
30
37
|
/**
|
|
@@ -54,29 +61,50 @@ export declare const LibraryApiAxiosParamCreator: (configuration?: Configuration
|
|
|
54
61
|
getAncestors: (itemId: string, userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
55
62
|
/**
|
|
56
63
|
*
|
|
57
|
-
* @summary
|
|
58
|
-
* @param {string} itemId
|
|
64
|
+
* @summary Downloads item media.
|
|
65
|
+
* @param {string} itemId The item id.
|
|
59
66
|
* @param {*} [options] Override http request option.
|
|
60
|
-
* @deprecated
|
|
61
67
|
* @throws {RequiredError}
|
|
62
68
|
*/
|
|
63
|
-
|
|
69
|
+
getDownload: (itemId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
70
|
/**
|
|
65
71
|
*
|
|
66
|
-
* @summary
|
|
72
|
+
* @summary Get the original file of an item.
|
|
67
73
|
* @param {string} itemId The item id.
|
|
68
74
|
* @param {*} [options] Override http request option.
|
|
69
75
|
* @throws {RequiredError}
|
|
70
76
|
*/
|
|
71
|
-
|
|
77
|
+
getFile: (itemId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
72
78
|
/**
|
|
73
79
|
*
|
|
74
|
-
* @summary
|
|
80
|
+
* @summary Gets intros to play before the main media item plays.
|
|
81
|
+
* @param {string} itemId Item id.
|
|
82
|
+
* @param {string} [userId] User id.
|
|
83
|
+
* @param {*} [options] Override http request option.
|
|
84
|
+
* @throws {RequiredError}
|
|
85
|
+
*/
|
|
86
|
+
getIntros: (itemId: string, userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
87
|
+
/**
|
|
88
|
+
*
|
|
89
|
+
* @summary Gets an item from a user\'s library.
|
|
90
|
+
* @param {string} itemId Item id.
|
|
91
|
+
* @param {string} [userId] User id.
|
|
92
|
+
* @param {*} [options] Override http request option.
|
|
93
|
+
* @throws {RequiredError}
|
|
94
|
+
*/
|
|
95
|
+
getItem: (itemId: string, userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
96
|
+
/**
|
|
97
|
+
*
|
|
98
|
+
* @summary Gets the collections that include the specified item.
|
|
75
99
|
* @param {string} itemId The item id.
|
|
100
|
+
* @param {string} [userId] Optional. Filter by user id, and attach user data.
|
|
101
|
+
* @param {number} [startIndex] Optional. The index of the first record in the output.
|
|
102
|
+
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
103
|
+
* @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output.
|
|
76
104
|
* @param {*} [options] Override http request option.
|
|
77
105
|
* @throws {RequiredError}
|
|
78
106
|
*/
|
|
79
|
-
|
|
107
|
+
getItemCollections: (itemId: string, userId?: string, startIndex?: number, limit?: number, fields?: Array<ItemFields>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
80
108
|
/**
|
|
81
109
|
*
|
|
82
110
|
* @summary Get item counts.
|
|
@@ -86,6 +114,119 @@ export declare const LibraryApiAxiosParamCreator: (configuration?: Configuration
|
|
|
86
114
|
* @throws {RequiredError}
|
|
87
115
|
*/
|
|
88
116
|
getItemCounts: (userId?: string, isFavorite?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
117
|
+
/**
|
|
118
|
+
*
|
|
119
|
+
* @summary Gets items based on a query.
|
|
120
|
+
* @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key.
|
|
121
|
+
* @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
|
|
122
|
+
* @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
|
|
123
|
+
* @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
|
|
124
|
+
* @param {boolean} [hasSubtitles] Optional filter by items with subtitles.
|
|
125
|
+
* @param {boolean} [hasSpecialFeature] Optional filter by items with special features.
|
|
126
|
+
* @param {boolean} [hasTrailer] Optional filter by items with trailers.
|
|
127
|
+
* @param {string} [adjacentTo] Optional. Return items that are siblings of a supplied item.
|
|
128
|
+
* @param {number} [indexNumber] Optional filter by index number.
|
|
129
|
+
* @param {number} [parentIndexNumber] Optional filter by parent index number.
|
|
130
|
+
* @param {boolean} [hasParentalRating] Optional filter by items that have or do not have a parental rating.
|
|
131
|
+
* @param {boolean} [isHd] Optional filter by items that are HD or not.
|
|
132
|
+
* @param {boolean} [is4K] Optional filter by items that are 4K or not.
|
|
133
|
+
* @param {Array<LocationType>} [locationTypes] Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.
|
|
134
|
+
* @param {Array<LocationType>} [excludeLocationTypes] Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.
|
|
135
|
+
* @param {boolean} [isMissing] Optional filter by items that are missing episodes or not.
|
|
136
|
+
* @param {boolean} [isUnaired] Optional filter by items that are unaired episodes or not.
|
|
137
|
+
* @param {number} [minCommunityRating] Optional filter by minimum community rating.
|
|
138
|
+
* @param {number} [minCriticRating] Optional filter by minimum critic rating.
|
|
139
|
+
* @param {string} [minPremiereDate] Optional. The minimum premiere date. Format = ISO.
|
|
140
|
+
* @param {string} [minDateLastSaved] Optional. The minimum last saved date. Format = ISO.
|
|
141
|
+
* @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO.
|
|
142
|
+
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO.
|
|
143
|
+
* @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
|
|
144
|
+
* @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not.
|
|
145
|
+
* @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not.
|
|
146
|
+
* @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not.
|
|
147
|
+
* @param {boolean} [isMovie] Optional filter for live tv movies.
|
|
148
|
+
* @param {boolean} [isSeries] Optional filter for live tv series.
|
|
149
|
+
* @param {boolean} [isNews] Optional filter for live tv news.
|
|
150
|
+
* @param {boolean} [isKids] Optional filter for live tv kids.
|
|
151
|
+
* @param {boolean} [isSports] Optional filter for live tv sports.
|
|
152
|
+
* @param {Array<string>} [excludeItemIds] Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.
|
|
153
|
+
* @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
|
|
154
|
+
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
155
|
+
* @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
156
|
+
* @param {string} [searchTerm] Optional. Filter based on a search term.
|
|
157
|
+
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending, Descending.
|
|
158
|
+
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
159
|
+
* @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.
|
|
160
|
+
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
161
|
+
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
|
|
162
|
+
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
|
|
163
|
+
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
164
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
165
|
+
* @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
|
|
166
|
+
* @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.
|
|
167
|
+
* @param {boolean} [isPlayed] Optional filter by items that are played, or not.
|
|
168
|
+
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
169
|
+
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
170
|
+
* @param {Array<string>} [tags] Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
|
|
171
|
+
* @param {Array<number>} [years] Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
|
|
172
|
+
* @param {boolean} [enableUserData] Optional, include user data.
|
|
173
|
+
* @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type.
|
|
174
|
+
* @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
|
|
175
|
+
* @param {string} [person] Optional. If specified, results will be filtered to include only those containing the specified person.
|
|
176
|
+
* @param {Array<string>} [personIds] Optional. If specified, results will be filtered to include only those containing the specified person id.
|
|
177
|
+
* @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.
|
|
178
|
+
* @param {Array<string>} [studios] Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
|
|
179
|
+
* @param {Array<string>} [artists] Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.
|
|
180
|
+
* @param {Array<string>} [excludeArtistIds] Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.
|
|
181
|
+
* @param {Array<string>} [artistIds] Optional. If specified, results will be filtered to include only those containing the specified artist id.
|
|
182
|
+
* @param {Array<string>} [albumArtistIds] Optional. If specified, results will be filtered to include only those containing the specified album artist id.
|
|
183
|
+
* @param {Array<string>} [contributingArtistIds] Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.
|
|
184
|
+
* @param {Array<string>} [albums] Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.
|
|
185
|
+
* @param {Array<string>} [albumIds] Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.
|
|
186
|
+
* @param {Array<string>} [ids] Optional. If specific items are needed, specify a list of item id\'s to retrieve. This allows multiple, comma delimited.
|
|
187
|
+
* @param {Array<VideoType>} [videoTypes] Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.
|
|
188
|
+
* @param {string} [minOfficialRating] Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).
|
|
189
|
+
* @param {boolean} [isLocked] Optional filter by items that are locked.
|
|
190
|
+
* @param {boolean} [isPlaceHolder] Optional filter by items that are placeholders.
|
|
191
|
+
* @param {boolean} [hasOfficialRating] Optional filter by items that have official ratings.
|
|
192
|
+
* @param {boolean} [collapseBoxSetItems] Whether or not to hide items behind their boxsets.
|
|
193
|
+
* @param {number} [minWidth] Optional. Filter by the minimum width of the item.
|
|
194
|
+
* @param {number} [minHeight] Optional. Filter by the minimum height of the item.
|
|
195
|
+
* @param {number} [maxWidth] Optional. Filter by the maximum width of the item.
|
|
196
|
+
* @param {number} [maxHeight] Optional. Filter by the maximum height of the item.
|
|
197
|
+
* @param {boolean} [is3D] Optional filter by items that are 3D, or not.
|
|
198
|
+
* @param {Array<SeriesStatus>} [seriesStatus] Optional filter by Series Status. Allows multiple, comma delimited.
|
|
199
|
+
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
200
|
+
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
201
|
+
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
202
|
+
* @param {Array<string>} [studioIds] Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
|
|
203
|
+
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
204
|
+
* @param {Array<string>} [audioLanguages] Optional. If specified, results will be filtered based on audio language. This allows multiple, comma delimited values.
|
|
205
|
+
* @param {Array<string>} [subtitleLanguages] Optional. If specified, results will be filtered based on subtitle language. This allows multiple, comma delimited values.
|
|
206
|
+
* @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count.
|
|
207
|
+
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
208
|
+
* @param {*} [options] Override http request option.
|
|
209
|
+
* @throws {RequiredError}
|
|
210
|
+
*/
|
|
211
|
+
getItems: (userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, indexNumber?: number, 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>, audioLanguages?: Array<string>, subtitleLanguages?: Array<string>, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
212
|
+
/**
|
|
213
|
+
*
|
|
214
|
+
* @summary Gets latest media.
|
|
215
|
+
* @param {string} [userId] User id.
|
|
216
|
+
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
217
|
+
* @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output.
|
|
218
|
+
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
219
|
+
* @param {boolean} [isPlayed] Filter by items that are played, or not.
|
|
220
|
+
* @param {boolean} [enableImages] Optional. include image information in output.
|
|
221
|
+
* @param {number} [imageTypeLimit] Optional. the max number of images to return, per image type.
|
|
222
|
+
* @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
|
|
223
|
+
* @param {boolean} [enableUserData] Optional. include user data.
|
|
224
|
+
* @param {number} [limit] Return item limit.
|
|
225
|
+
* @param {boolean} [groupItems] Whether or not to group items into a parent container.
|
|
226
|
+
* @param {*} [options] Override http request option.
|
|
227
|
+
* @throws {RequiredError}
|
|
228
|
+
*/
|
|
229
|
+
getLatestMedia: (userId?: string, parentId?: string, fields?: Array<ItemFields>, includeItemTypes?: Array<BaseItemKind>, isPlayed?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, limit?: number, groupItems?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
89
230
|
/**
|
|
90
231
|
*
|
|
91
232
|
* @summary Gets the library options info.
|
|
@@ -95,6 +236,15 @@ export declare const LibraryApiAxiosParamCreator: (configuration?: Configuration
|
|
|
95
236
|
* @throws {RequiredError}
|
|
96
237
|
*/
|
|
97
238
|
getLibraryOptionsInfo: (libraryContentType?: CollectionType, isNewLibrary?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
239
|
+
/**
|
|
240
|
+
*
|
|
241
|
+
* @summary Gets local trailers for an item.
|
|
242
|
+
* @param {string} itemId Item id.
|
|
243
|
+
* @param {string} [userId] User id.
|
|
244
|
+
* @param {*} [options] Override http request option.
|
|
245
|
+
* @throws {RequiredError}
|
|
246
|
+
*/
|
|
247
|
+
getLocalTrailers: (itemId: string, userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
98
248
|
/**
|
|
99
249
|
*
|
|
100
250
|
* @summary Gets all user media folders.
|
|
@@ -110,6 +260,36 @@ export declare const LibraryApiAxiosParamCreator: (configuration?: Configuration
|
|
|
110
260
|
* @throws {RequiredError}
|
|
111
261
|
*/
|
|
112
262
|
getPhysicalPaths: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
263
|
+
/**
|
|
264
|
+
*
|
|
265
|
+
* @summary Gets items based on a query.
|
|
266
|
+
* @param {string} [userId] The user id.
|
|
267
|
+
* @param {number} [startIndex] The start index.
|
|
268
|
+
* @param {number} [limit] The item limit.
|
|
269
|
+
* @param {string} [searchTerm] The search term.
|
|
270
|
+
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
271
|
+
* @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.
|
|
272
|
+
* @param {Array<MediaType>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
|
|
273
|
+
* @param {boolean} [enableUserData] Optional. Include user data.
|
|
274
|
+
* @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type.
|
|
275
|
+
* @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
|
|
276
|
+
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
277
|
+
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
|
|
278
|
+
* @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count.
|
|
279
|
+
* @param {boolean} [enableImages] Optional. Include image information in output.
|
|
280
|
+
* @param {boolean} [excludeActiveSessions] Optional. Whether to exclude the currently active sessions.
|
|
281
|
+
* @param {*} [options] Override http request option.
|
|
282
|
+
* @throws {RequiredError}
|
|
283
|
+
*/
|
|
284
|
+
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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
285
|
+
/**
|
|
286
|
+
*
|
|
287
|
+
* @summary Gets the root folder from a user\'s library.
|
|
288
|
+
* @param {string} [userId] User id.
|
|
289
|
+
* @param {*} [options] Override http request option.
|
|
290
|
+
* @throws {RequiredError}
|
|
291
|
+
*/
|
|
292
|
+
getRootFolder: (userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
113
293
|
/**
|
|
114
294
|
*
|
|
115
295
|
* @summary Gets similar items.
|
|
@@ -182,6 +362,15 @@ export declare const LibraryApiAxiosParamCreator: (configuration?: Configuration
|
|
|
182
362
|
* @throws {RequiredError}
|
|
183
363
|
*/
|
|
184
364
|
getSimilarTrailers: (itemId: string, excludeArtistIds?: Array<string>, userId?: string, limit?: number, fields?: Array<ItemFields>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
365
|
+
/**
|
|
366
|
+
*
|
|
367
|
+
* @summary Gets special features for an item.
|
|
368
|
+
* @param {string} itemId Item id.
|
|
369
|
+
* @param {string} [userId] User id.
|
|
370
|
+
* @param {*} [options] Override http request option.
|
|
371
|
+
* @throws {RequiredError}
|
|
372
|
+
*/
|
|
373
|
+
getSpecialFeatures: (itemId: string, userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
185
374
|
/**
|
|
186
375
|
*
|
|
187
376
|
* @summary Get theme songs and videos for an item.
|
|
@@ -260,6 +449,19 @@ export declare const LibraryApiAxiosParamCreator: (configuration?: Configuration
|
|
|
260
449
|
* @throws {RequiredError}
|
|
261
450
|
*/
|
|
262
451
|
postUpdatedSeries: (tvdbId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
452
|
+
/**
|
|
453
|
+
*
|
|
454
|
+
* @summary Refreshes metadata for an item.
|
|
455
|
+
* @param {string} itemId Item id.
|
|
456
|
+
* @param {MetadataRefreshMode} [metadataRefreshMode] (Optional) Specifies the metadata refresh mode.
|
|
457
|
+
* @param {MetadataRefreshMode} [imageRefreshMode] (Optional) Specifies the image refresh mode.
|
|
458
|
+
* @param {boolean} [replaceAllMetadata] (Optional) Determines if metadata should be replaced. Only applicable if mode is FullRefresh.
|
|
459
|
+
* @param {boolean} [replaceAllImages] (Optional) Determines if images should be replaced. Only applicable if mode is FullRefresh.
|
|
460
|
+
* @param {boolean} [regenerateTrickplay] (Optional) Determines if trickplay images should be replaced. Only applicable if mode is FullRefresh.
|
|
461
|
+
* @param {*} [options] Override http request option.
|
|
462
|
+
* @throws {RequiredError}
|
|
463
|
+
*/
|
|
464
|
+
refreshItem: (itemId: string, metadataRefreshMode?: MetadataRefreshMode, imageRefreshMode?: MetadataRefreshMode, replaceAllMetadata?: boolean, replaceAllImages?: boolean, regenerateTrickplay?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
263
465
|
/**
|
|
264
466
|
*
|
|
265
467
|
* @summary Starts a library scan.
|
|
@@ -270,7 +472,6 @@ export declare const LibraryApiAxiosParamCreator: (configuration?: Configuration
|
|
|
270
472
|
};
|
|
271
473
|
/**
|
|
272
474
|
* LibraryApi - functional programming interface
|
|
273
|
-
* @export
|
|
274
475
|
*/
|
|
275
476
|
export declare const LibraryApiFp: (configuration?: Configuration) => {
|
|
276
477
|
/**
|
|
@@ -300,29 +501,50 @@ export declare const LibraryApiFp: (configuration?: Configuration) => {
|
|
|
300
501
|
getAncestors(itemId: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BaseItemDto>>>;
|
|
301
502
|
/**
|
|
302
503
|
*
|
|
303
|
-
* @summary
|
|
304
|
-
* @param {string} itemId
|
|
504
|
+
* @summary Downloads item media.
|
|
505
|
+
* @param {string} itemId The item id.
|
|
305
506
|
* @param {*} [options] Override http request option.
|
|
306
|
-
* @deprecated
|
|
307
507
|
* @throws {RequiredError}
|
|
308
508
|
*/
|
|
309
|
-
|
|
509
|
+
getDownload(itemId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
310
510
|
/**
|
|
311
511
|
*
|
|
312
|
-
* @summary
|
|
512
|
+
* @summary Get the original file of an item.
|
|
313
513
|
* @param {string} itemId The item id.
|
|
314
514
|
* @param {*} [options] Override http request option.
|
|
315
515
|
* @throws {RequiredError}
|
|
316
516
|
*/
|
|
317
|
-
|
|
517
|
+
getFile(itemId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
318
518
|
/**
|
|
319
519
|
*
|
|
320
|
-
* @summary
|
|
520
|
+
* @summary Gets intros to play before the main media item plays.
|
|
521
|
+
* @param {string} itemId Item id.
|
|
522
|
+
* @param {string} [userId] User id.
|
|
523
|
+
* @param {*} [options] Override http request option.
|
|
524
|
+
* @throws {RequiredError}
|
|
525
|
+
*/
|
|
526
|
+
getIntros(itemId: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
|
|
527
|
+
/**
|
|
528
|
+
*
|
|
529
|
+
* @summary Gets an item from a user\'s library.
|
|
530
|
+
* @param {string} itemId Item id.
|
|
531
|
+
* @param {string} [userId] User id.
|
|
532
|
+
* @param {*} [options] Override http request option.
|
|
533
|
+
* @throws {RequiredError}
|
|
534
|
+
*/
|
|
535
|
+
getItem(itemId: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>;
|
|
536
|
+
/**
|
|
537
|
+
*
|
|
538
|
+
* @summary Gets the collections that include the specified item.
|
|
321
539
|
* @param {string} itemId The item id.
|
|
540
|
+
* @param {string} [userId] Optional. Filter by user id, and attach user data.
|
|
541
|
+
* @param {number} [startIndex] Optional. The index of the first record in the output.
|
|
542
|
+
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
543
|
+
* @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output.
|
|
322
544
|
* @param {*} [options] Override http request option.
|
|
323
545
|
* @throws {RequiredError}
|
|
324
546
|
*/
|
|
325
|
-
|
|
547
|
+
getItemCollections(itemId: string, userId?: string, startIndex?: number, limit?: number, fields?: Array<ItemFields>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
|
|
326
548
|
/**
|
|
327
549
|
*
|
|
328
550
|
* @summary Get item counts.
|
|
@@ -332,6 +554,119 @@ export declare const LibraryApiFp: (configuration?: Configuration) => {
|
|
|
332
554
|
* @throws {RequiredError}
|
|
333
555
|
*/
|
|
334
556
|
getItemCounts(userId?: string, isFavorite?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ItemCounts>>;
|
|
557
|
+
/**
|
|
558
|
+
*
|
|
559
|
+
* @summary Gets items based on a query.
|
|
560
|
+
* @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key.
|
|
561
|
+
* @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
|
|
562
|
+
* @param {boolean} [hasThemeSong] Optional filter by items with theme songs.
|
|
563
|
+
* @param {boolean} [hasThemeVideo] Optional filter by items with theme videos.
|
|
564
|
+
* @param {boolean} [hasSubtitles] Optional filter by items with subtitles.
|
|
565
|
+
* @param {boolean} [hasSpecialFeature] Optional filter by items with special features.
|
|
566
|
+
* @param {boolean} [hasTrailer] Optional filter by items with trailers.
|
|
567
|
+
* @param {string} [adjacentTo] Optional. Return items that are siblings of a supplied item.
|
|
568
|
+
* @param {number} [indexNumber] Optional filter by index number.
|
|
569
|
+
* @param {number} [parentIndexNumber] Optional filter by parent index number.
|
|
570
|
+
* @param {boolean} [hasParentalRating] Optional filter by items that have or do not have a parental rating.
|
|
571
|
+
* @param {boolean} [isHd] Optional filter by items that are HD or not.
|
|
572
|
+
* @param {boolean} [is4K] Optional filter by items that are 4K or not.
|
|
573
|
+
* @param {Array<LocationType>} [locationTypes] Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.
|
|
574
|
+
* @param {Array<LocationType>} [excludeLocationTypes] Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.
|
|
575
|
+
* @param {boolean} [isMissing] Optional filter by items that are missing episodes or not.
|
|
576
|
+
* @param {boolean} [isUnaired] Optional filter by items that are unaired episodes or not.
|
|
577
|
+
* @param {number} [minCommunityRating] Optional filter by minimum community rating.
|
|
578
|
+
* @param {number} [minCriticRating] Optional filter by minimum critic rating.
|
|
579
|
+
* @param {string} [minPremiereDate] Optional. The minimum premiere date. Format = ISO.
|
|
580
|
+
* @param {string} [minDateLastSaved] Optional. The minimum last saved date. Format = ISO.
|
|
581
|
+
* @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO.
|
|
582
|
+
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO.
|
|
583
|
+
* @param {boolean} [hasOverview] Optional filter by items that have an overview or not.
|
|
584
|
+
* @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not.
|
|
585
|
+
* @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not.
|
|
586
|
+
* @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not.
|
|
587
|
+
* @param {boolean} [isMovie] Optional filter for live tv movies.
|
|
588
|
+
* @param {boolean} [isSeries] Optional filter for live tv series.
|
|
589
|
+
* @param {boolean} [isNews] Optional filter for live tv news.
|
|
590
|
+
* @param {boolean} [isKids] Optional filter for live tv kids.
|
|
591
|
+
* @param {boolean} [isSports] Optional filter for live tv sports.
|
|
592
|
+
* @param {Array<string>} [excludeItemIds] Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.
|
|
593
|
+
* @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results.
|
|
594
|
+
* @param {number} [limit] Optional. The maximum number of records to return.
|
|
595
|
+
* @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
596
|
+
* @param {string} [searchTerm] Optional. Filter based on a search term.
|
|
597
|
+
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending, Descending.
|
|
598
|
+
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
599
|
+
* @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.
|
|
600
|
+
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
601
|
+
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
|
|
602
|
+
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
|
|
603
|
+
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
|
|
604
|
+
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
|
|
605
|
+
* @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
|
|
606
|
+
* @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.
|
|
607
|
+
* @param {boolean} [isPlayed] Optional filter by items that are played, or not.
|
|
608
|
+
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
609
|
+
* @param {Array<string>} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
610
|
+
* @param {Array<string>} [tags] Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
|
|
611
|
+
* @param {Array<number>} [years] Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
|
|
612
|
+
* @param {boolean} [enableUserData] Optional, include user data.
|
|
613
|
+
* @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type.
|
|
614
|
+
* @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
|
|
615
|
+
* @param {string} [person] Optional. If specified, results will be filtered to include only those containing the specified person.
|
|
616
|
+
* @param {Array<string>} [personIds] Optional. If specified, results will be filtered to include only those containing the specified person id.
|
|
617
|
+
* @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.
|
|
618
|
+
* @param {Array<string>} [studios] Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
|
|
619
|
+
* @param {Array<string>} [artists] Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.
|
|
620
|
+
* @param {Array<string>} [excludeArtistIds] Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.
|
|
621
|
+
* @param {Array<string>} [artistIds] Optional. If specified, results will be filtered to include only those containing the specified artist id.
|
|
622
|
+
* @param {Array<string>} [albumArtistIds] Optional. If specified, results will be filtered to include only those containing the specified album artist id.
|
|
623
|
+
* @param {Array<string>} [contributingArtistIds] Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.
|
|
624
|
+
* @param {Array<string>} [albums] Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.
|
|
625
|
+
* @param {Array<string>} [albumIds] Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.
|
|
626
|
+
* @param {Array<string>} [ids] Optional. If specific items are needed, specify a list of item id\'s to retrieve. This allows multiple, comma delimited.
|
|
627
|
+
* @param {Array<VideoType>} [videoTypes] Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.
|
|
628
|
+
* @param {string} [minOfficialRating] Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).
|
|
629
|
+
* @param {boolean} [isLocked] Optional filter by items that are locked.
|
|
630
|
+
* @param {boolean} [isPlaceHolder] Optional filter by items that are placeholders.
|
|
631
|
+
* @param {boolean} [hasOfficialRating] Optional filter by items that have official ratings.
|
|
632
|
+
* @param {boolean} [collapseBoxSetItems] Whether or not to hide items behind their boxsets.
|
|
633
|
+
* @param {number} [minWidth] Optional. Filter by the minimum width of the item.
|
|
634
|
+
* @param {number} [minHeight] Optional. Filter by the minimum height of the item.
|
|
635
|
+
* @param {number} [maxWidth] Optional. Filter by the maximum width of the item.
|
|
636
|
+
* @param {number} [maxHeight] Optional. Filter by the maximum height of the item.
|
|
637
|
+
* @param {boolean} [is3D] Optional filter by items that are 3D, or not.
|
|
638
|
+
* @param {Array<SeriesStatus>} [seriesStatus] Optional filter by Series Status. Allows multiple, comma delimited.
|
|
639
|
+
* @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
640
|
+
* @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string.
|
|
641
|
+
* @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string.
|
|
642
|
+
* @param {Array<string>} [studioIds] Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
|
|
643
|
+
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
644
|
+
* @param {Array<string>} [audioLanguages] Optional. If specified, results will be filtered based on audio language. This allows multiple, comma delimited values.
|
|
645
|
+
* @param {Array<string>} [subtitleLanguages] Optional. If specified, results will be filtered based on subtitle language. This allows multiple, comma delimited values.
|
|
646
|
+
* @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count.
|
|
647
|
+
* @param {boolean} [enableImages] Optional, include image information in output.
|
|
648
|
+
* @param {*} [options] Override http request option.
|
|
649
|
+
* @throws {RequiredError}
|
|
650
|
+
*/
|
|
651
|
+
getItems(userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, indexNumber?: number, 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>, audioLanguages?: Array<string>, subtitleLanguages?: Array<string>, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
|
|
652
|
+
/**
|
|
653
|
+
*
|
|
654
|
+
* @summary Gets latest media.
|
|
655
|
+
* @param {string} [userId] User id.
|
|
656
|
+
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
657
|
+
* @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output.
|
|
658
|
+
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
659
|
+
* @param {boolean} [isPlayed] Filter by items that are played, or not.
|
|
660
|
+
* @param {boolean} [enableImages] Optional. include image information in output.
|
|
661
|
+
* @param {number} [imageTypeLimit] Optional. the max number of images to return, per image type.
|
|
662
|
+
* @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
|
|
663
|
+
* @param {boolean} [enableUserData] Optional. include user data.
|
|
664
|
+
* @param {number} [limit] Return item limit.
|
|
665
|
+
* @param {boolean} [groupItems] Whether or not to group items into a parent container.
|
|
666
|
+
* @param {*} [options] Override http request option.
|
|
667
|
+
* @throws {RequiredError}
|
|
668
|
+
*/
|
|
669
|
+
getLatestMedia(userId?: string, parentId?: string, fields?: Array<ItemFields>, includeItemTypes?: Array<BaseItemKind>, isPlayed?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, limit?: number, groupItems?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BaseItemDto>>>;
|
|
335
670
|
/**
|
|
336
671
|
*
|
|
337
672
|
* @summary Gets the library options info.
|
|
@@ -341,6 +676,15 @@ export declare const LibraryApiFp: (configuration?: Configuration) => {
|
|
|
341
676
|
* @throws {RequiredError}
|
|
342
677
|
*/
|
|
343
678
|
getLibraryOptionsInfo(libraryContentType?: CollectionType, isNewLibrary?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LibraryOptionsResultDto>>;
|
|
679
|
+
/**
|
|
680
|
+
*
|
|
681
|
+
* @summary Gets local trailers for an item.
|
|
682
|
+
* @param {string} itemId Item id.
|
|
683
|
+
* @param {string} [userId] User id.
|
|
684
|
+
* @param {*} [options] Override http request option.
|
|
685
|
+
* @throws {RequiredError}
|
|
686
|
+
*/
|
|
687
|
+
getLocalTrailers(itemId: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BaseItemDto>>>;
|
|
344
688
|
/**
|
|
345
689
|
*
|
|
346
690
|
* @summary Gets all user media folders.
|
|
@@ -356,6 +700,36 @@ export declare const LibraryApiFp: (configuration?: Configuration) => {
|
|
|
356
700
|
* @throws {RequiredError}
|
|
357
701
|
*/
|
|
358
702
|
getPhysicalPaths(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
703
|
+
/**
|
|
704
|
+
*
|
|
705
|
+
* @summary Gets items based on a query.
|
|
706
|
+
* @param {string} [userId] The user id.
|
|
707
|
+
* @param {number} [startIndex] The start index.
|
|
708
|
+
* @param {number} [limit] The item limit.
|
|
709
|
+
* @param {string} [searchTerm] The search term.
|
|
710
|
+
* @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
711
|
+
* @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.
|
|
712
|
+
* @param {Array<MediaType>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
|
|
713
|
+
* @param {boolean} [enableUserData] Optional. Include user data.
|
|
714
|
+
* @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type.
|
|
715
|
+
* @param {Array<ImageType>} [enableImageTypes] Optional. The image types to include in the output.
|
|
716
|
+
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
717
|
+
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
|
|
718
|
+
* @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count.
|
|
719
|
+
* @param {boolean} [enableImages] Optional. Include image information in output.
|
|
720
|
+
* @param {boolean} [excludeActiveSessions] Optional. Whether to exclude the currently active sessions.
|
|
721
|
+
* @param {*} [options] Override http request option.
|
|
722
|
+
* @throws {RequiredError}
|
|
723
|
+
*/
|
|
724
|
+
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?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
|
|
725
|
+
/**
|
|
726
|
+
*
|
|
727
|
+
* @summary Gets the root folder from a user\'s library.
|
|
728
|
+
* @param {string} [userId] User id.
|
|
729
|
+
* @param {*} [options] Override http request option.
|
|
730
|
+
* @throws {RequiredError}
|
|
731
|
+
*/
|
|
732
|
+
getRootFolder(userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>;
|
|
359
733
|
/**
|
|
360
734
|
*
|
|
361
735
|
* @summary Gets similar items.
|
|
@@ -428,6 +802,15 @@ export declare const LibraryApiFp: (configuration?: Configuration) => {
|
|
|
428
802
|
* @throws {RequiredError}
|
|
429
803
|
*/
|
|
430
804
|
getSimilarTrailers(itemId: string, excludeArtistIds?: Array<string>, userId?: string, limit?: number, fields?: Array<ItemFields>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
|
|
805
|
+
/**
|
|
806
|
+
*
|
|
807
|
+
* @summary Gets special features for an item.
|
|
808
|
+
* @param {string} itemId Item id.
|
|
809
|
+
* @param {string} [userId] User id.
|
|
810
|
+
* @param {*} [options] Override http request option.
|
|
811
|
+
* @throws {RequiredError}
|
|
812
|
+
*/
|
|
813
|
+
getSpecialFeatures(itemId: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BaseItemDto>>>;
|
|
431
814
|
/**
|
|
432
815
|
*
|
|
433
816
|
* @summary Get theme songs and videos for an item.
|
|
@@ -506,6 +889,19 @@ export declare const LibraryApiFp: (configuration?: Configuration) => {
|
|
|
506
889
|
* @throws {RequiredError}
|
|
507
890
|
*/
|
|
508
891
|
postUpdatedSeries(tvdbId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
892
|
+
/**
|
|
893
|
+
*
|
|
894
|
+
* @summary Refreshes metadata for an item.
|
|
895
|
+
* @param {string} itemId Item id.
|
|
896
|
+
* @param {MetadataRefreshMode} [metadataRefreshMode] (Optional) Specifies the metadata refresh mode.
|
|
897
|
+
* @param {MetadataRefreshMode} [imageRefreshMode] (Optional) Specifies the image refresh mode.
|
|
898
|
+
* @param {boolean} [replaceAllMetadata] (Optional) Determines if metadata should be replaced. Only applicable if mode is FullRefresh.
|
|
899
|
+
* @param {boolean} [replaceAllImages] (Optional) Determines if images should be replaced. Only applicable if mode is FullRefresh.
|
|
900
|
+
* @param {boolean} [regenerateTrickplay] (Optional) Determines if trickplay images should be replaced. Only applicable if mode is FullRefresh.
|
|
901
|
+
* @param {*} [options] Override http request option.
|
|
902
|
+
* @throws {RequiredError}
|
|
903
|
+
*/
|
|
904
|
+
refreshItem(itemId: string, metadataRefreshMode?: MetadataRefreshMode, imageRefreshMode?: MetadataRefreshMode, replaceAllMetadata?: boolean, replaceAllImages?: boolean, regenerateTrickplay?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
509
905
|
/**
|
|
510
906
|
*
|
|
511
907
|
* @summary Starts a library scan.
|
|
@@ -516,7 +912,6 @@ export declare const LibraryApiFp: (configuration?: Configuration) => {
|
|
|
516
912
|
};
|
|
517
913
|
/**
|
|
518
914
|
* LibraryApi - factory interface
|
|
519
|
-
* @export
|
|
520
915
|
*/
|
|
521
916
|
export declare const LibraryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
522
917
|
/**
|
|
@@ -543,15 +938,6 @@ export declare const LibraryApiFactory: (configuration?: Configuration, basePath
|
|
|
543
938
|
* @throws {RequiredError}
|
|
544
939
|
*/
|
|
545
940
|
getAncestors(requestParameters: LibraryApiGetAncestorsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<BaseItemDto>>;
|
|
546
|
-
/**
|
|
547
|
-
*
|
|
548
|
-
* @summary Gets critic review for an item.
|
|
549
|
-
* @param {LibraryApiGetCriticReviewsRequest} requestParameters Request parameters.
|
|
550
|
-
* @param {*} [options] Override http request option.
|
|
551
|
-
* @deprecated
|
|
552
|
-
* @throws {RequiredError}
|
|
553
|
-
*/
|
|
554
|
-
getCriticReviews(requestParameters: LibraryApiGetCriticReviewsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
|
|
555
941
|
/**
|
|
556
942
|
*
|
|
557
943
|
* @summary Downloads item media.
|
|
@@ -568,6 +954,30 @@ export declare const LibraryApiFactory: (configuration?: Configuration, basePath
|
|
|
568
954
|
* @throws {RequiredError}
|
|
569
955
|
*/
|
|
570
956
|
getFile(requestParameters: LibraryApiGetFileRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
957
|
+
/**
|
|
958
|
+
*
|
|
959
|
+
* @summary Gets intros to play before the main media item plays.
|
|
960
|
+
* @param {LibraryApiGetIntrosRequest} requestParameters Request parameters.
|
|
961
|
+
* @param {*} [options] Override http request option.
|
|
962
|
+
* @throws {RequiredError}
|
|
963
|
+
*/
|
|
964
|
+
getIntros(requestParameters: LibraryApiGetIntrosRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
|
|
965
|
+
/**
|
|
966
|
+
*
|
|
967
|
+
* @summary Gets an item from a user\'s library.
|
|
968
|
+
* @param {LibraryApiGetItemRequest} requestParameters Request parameters.
|
|
969
|
+
* @param {*} [options] Override http request option.
|
|
970
|
+
* @throws {RequiredError}
|
|
971
|
+
*/
|
|
972
|
+
getItem(requestParameters: LibraryApiGetItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDto>;
|
|
973
|
+
/**
|
|
974
|
+
*
|
|
975
|
+
* @summary Gets the collections that include the specified item.
|
|
976
|
+
* @param {LibraryApiGetItemCollectionsRequest} requestParameters Request parameters.
|
|
977
|
+
* @param {*} [options] Override http request option.
|
|
978
|
+
* @throws {RequiredError}
|
|
979
|
+
*/
|
|
980
|
+
getItemCollections(requestParameters: LibraryApiGetItemCollectionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
|
|
571
981
|
/**
|
|
572
982
|
*
|
|
573
983
|
* @summary Get item counts.
|
|
@@ -576,6 +986,22 @@ export declare const LibraryApiFactory: (configuration?: Configuration, basePath
|
|
|
576
986
|
* @throws {RequiredError}
|
|
577
987
|
*/
|
|
578
988
|
getItemCounts(requestParameters?: LibraryApiGetItemCountsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ItemCounts>;
|
|
989
|
+
/**
|
|
990
|
+
*
|
|
991
|
+
* @summary Gets items based on a query.
|
|
992
|
+
* @param {LibraryApiGetItemsRequest} requestParameters Request parameters.
|
|
993
|
+
* @param {*} [options] Override http request option.
|
|
994
|
+
* @throws {RequiredError}
|
|
995
|
+
*/
|
|
996
|
+
getItems(requestParameters?: LibraryApiGetItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
|
|
997
|
+
/**
|
|
998
|
+
*
|
|
999
|
+
* @summary Gets latest media.
|
|
1000
|
+
* @param {LibraryApiGetLatestMediaRequest} requestParameters Request parameters.
|
|
1001
|
+
* @param {*} [options] Override http request option.
|
|
1002
|
+
* @throws {RequiredError}
|
|
1003
|
+
*/
|
|
1004
|
+
getLatestMedia(requestParameters?: LibraryApiGetLatestMediaRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<BaseItemDto>>;
|
|
579
1005
|
/**
|
|
580
1006
|
*
|
|
581
1007
|
* @summary Gets the library options info.
|
|
@@ -584,6 +1010,14 @@ export declare const LibraryApiFactory: (configuration?: Configuration, basePath
|
|
|
584
1010
|
* @throws {RequiredError}
|
|
585
1011
|
*/
|
|
586
1012
|
getLibraryOptionsInfo(requestParameters?: LibraryApiGetLibraryOptionsInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise<LibraryOptionsResultDto>;
|
|
1013
|
+
/**
|
|
1014
|
+
*
|
|
1015
|
+
* @summary Gets local trailers for an item.
|
|
1016
|
+
* @param {LibraryApiGetLocalTrailersRequest} requestParameters Request parameters.
|
|
1017
|
+
* @param {*} [options] Override http request option.
|
|
1018
|
+
* @throws {RequiredError}
|
|
1019
|
+
*/
|
|
1020
|
+
getLocalTrailers(requestParameters: LibraryApiGetLocalTrailersRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<BaseItemDto>>;
|
|
587
1021
|
/**
|
|
588
1022
|
*
|
|
589
1023
|
* @summary Gets all user media folders.
|
|
@@ -599,6 +1033,22 @@ export declare const LibraryApiFactory: (configuration?: Configuration, basePath
|
|
|
599
1033
|
* @throws {RequiredError}
|
|
600
1034
|
*/
|
|
601
1035
|
getPhysicalPaths(options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
|
|
1036
|
+
/**
|
|
1037
|
+
*
|
|
1038
|
+
* @summary Gets items based on a query.
|
|
1039
|
+
* @param {LibraryApiGetResumeItemsRequest} requestParameters Request parameters.
|
|
1040
|
+
* @param {*} [options] Override http request option.
|
|
1041
|
+
* @throws {RequiredError}
|
|
1042
|
+
*/
|
|
1043
|
+
getResumeItems(requestParameters?: LibraryApiGetResumeItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
|
|
1044
|
+
/**
|
|
1045
|
+
*
|
|
1046
|
+
* @summary Gets the root folder from a user\'s library.
|
|
1047
|
+
* @param {LibraryApiGetRootFolderRequest} requestParameters Request parameters.
|
|
1048
|
+
* @param {*} [options] Override http request option.
|
|
1049
|
+
* @throws {RequiredError}
|
|
1050
|
+
*/
|
|
1051
|
+
getRootFolder(requestParameters?: LibraryApiGetRootFolderRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDto>;
|
|
602
1052
|
/**
|
|
603
1053
|
*
|
|
604
1054
|
* @summary Gets similar items.
|
|
@@ -647,6 +1097,14 @@ export declare const LibraryApiFactory: (configuration?: Configuration, basePath
|
|
|
647
1097
|
* @throws {RequiredError}
|
|
648
1098
|
*/
|
|
649
1099
|
getSimilarTrailers(requestParameters: LibraryApiGetSimilarTrailersRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
|
|
1100
|
+
/**
|
|
1101
|
+
*
|
|
1102
|
+
* @summary Gets special features for an item.
|
|
1103
|
+
* @param {LibraryApiGetSpecialFeaturesRequest} requestParameters Request parameters.
|
|
1104
|
+
* @param {*} [options] Override http request option.
|
|
1105
|
+
* @throws {RequiredError}
|
|
1106
|
+
*/
|
|
1107
|
+
getSpecialFeatures(requestParameters: LibraryApiGetSpecialFeaturesRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<BaseItemDto>>;
|
|
650
1108
|
/**
|
|
651
1109
|
*
|
|
652
1110
|
* @summary Get theme songs and videos for an item.
|
|
@@ -711,6 +1169,14 @@ export declare const LibraryApiFactory: (configuration?: Configuration, basePath
|
|
|
711
1169
|
* @throws {RequiredError}
|
|
712
1170
|
*/
|
|
713
1171
|
postUpdatedSeries(requestParameters?: LibraryApiPostUpdatedSeriesRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1172
|
+
/**
|
|
1173
|
+
*
|
|
1174
|
+
* @summary Refreshes metadata for an item.
|
|
1175
|
+
* @param {LibraryApiRefreshItemRequest} requestParameters Request parameters.
|
|
1176
|
+
* @param {*} [options] Override http request option.
|
|
1177
|
+
* @throws {RequiredError}
|
|
1178
|
+
*/
|
|
1179
|
+
refreshItem(requestParameters: LibraryApiRefreshItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
714
1180
|
/**
|
|
715
1181
|
*
|
|
716
1182
|
* @summary Starts a library scan.
|
|
@@ -721,554 +1187,954 @@ export declare const LibraryApiFactory: (configuration?: Configuration, basePath
|
|
|
721
1187
|
};
|
|
722
1188
|
/**
|
|
723
1189
|
* Request parameters for deleteItem operation in LibraryApi.
|
|
724
|
-
* @export
|
|
725
|
-
* @interface LibraryApiDeleteItemRequest
|
|
726
1190
|
*/
|
|
727
1191
|
export interface LibraryApiDeleteItemRequest {
|
|
728
1192
|
/**
|
|
729
1193
|
* The item id.
|
|
730
|
-
* @type {string}
|
|
731
|
-
* @memberof LibraryApiDeleteItem
|
|
732
1194
|
*/
|
|
733
1195
|
readonly itemId: string;
|
|
734
1196
|
}
|
|
735
1197
|
/**
|
|
736
1198
|
* Request parameters for deleteItems operation in LibraryApi.
|
|
737
|
-
* @export
|
|
738
|
-
* @interface LibraryApiDeleteItemsRequest
|
|
739
1199
|
*/
|
|
740
1200
|
export interface LibraryApiDeleteItemsRequest {
|
|
741
1201
|
/**
|
|
742
1202
|
* The item ids.
|
|
743
|
-
* @type {Array<string>}
|
|
744
|
-
* @memberof LibraryApiDeleteItems
|
|
745
1203
|
*/
|
|
746
1204
|
readonly ids?: Array<string>;
|
|
747
1205
|
}
|
|
748
1206
|
/**
|
|
749
1207
|
* Request parameters for getAncestors operation in LibraryApi.
|
|
750
|
-
* @export
|
|
751
|
-
* @interface LibraryApiGetAncestorsRequest
|
|
752
1208
|
*/
|
|
753
1209
|
export interface LibraryApiGetAncestorsRequest {
|
|
754
1210
|
/**
|
|
755
1211
|
* The item id.
|
|
756
|
-
* @type {string}
|
|
757
|
-
* @memberof LibraryApiGetAncestors
|
|
758
1212
|
*/
|
|
759
1213
|
readonly itemId: string;
|
|
760
1214
|
/**
|
|
761
1215
|
* Optional. Filter by user id, and attach user data.
|
|
762
|
-
* @type {string}
|
|
763
|
-
* @memberof LibraryApiGetAncestors
|
|
764
1216
|
*/
|
|
765
1217
|
readonly userId?: string;
|
|
766
1218
|
}
|
|
767
|
-
/**
|
|
768
|
-
* Request parameters for getCriticReviews operation in LibraryApi.
|
|
769
|
-
* @export
|
|
770
|
-
* @interface LibraryApiGetCriticReviewsRequest
|
|
771
|
-
*/
|
|
772
|
-
export interface LibraryApiGetCriticReviewsRequest {
|
|
773
|
-
/**
|
|
774
|
-
*
|
|
775
|
-
* @type {string}
|
|
776
|
-
* @memberof LibraryApiGetCriticReviews
|
|
777
|
-
*/
|
|
778
|
-
readonly itemId: string;
|
|
779
|
-
}
|
|
780
1219
|
/**
|
|
781
1220
|
* Request parameters for getDownload operation in LibraryApi.
|
|
782
|
-
* @export
|
|
783
|
-
* @interface LibraryApiGetDownloadRequest
|
|
784
1221
|
*/
|
|
785
1222
|
export interface LibraryApiGetDownloadRequest {
|
|
786
1223
|
/**
|
|
787
1224
|
* The item id.
|
|
788
|
-
* @type {string}
|
|
789
|
-
* @memberof LibraryApiGetDownload
|
|
790
1225
|
*/
|
|
791
1226
|
readonly itemId: string;
|
|
792
1227
|
}
|
|
793
1228
|
/**
|
|
794
1229
|
* Request parameters for getFile operation in LibraryApi.
|
|
795
|
-
* @export
|
|
796
|
-
* @interface LibraryApiGetFileRequest
|
|
797
1230
|
*/
|
|
798
1231
|
export interface LibraryApiGetFileRequest {
|
|
799
1232
|
/**
|
|
800
1233
|
* The item id.
|
|
801
|
-
* @type {string}
|
|
802
|
-
* @memberof LibraryApiGetFile
|
|
803
1234
|
*/
|
|
804
1235
|
readonly itemId: string;
|
|
805
1236
|
}
|
|
806
1237
|
/**
|
|
807
|
-
* Request parameters for
|
|
808
|
-
* @export
|
|
809
|
-
* @interface LibraryApiGetItemCountsRequest
|
|
1238
|
+
* Request parameters for getIntros operation in LibraryApi.
|
|
810
1239
|
*/
|
|
811
|
-
export interface
|
|
1240
|
+
export interface LibraryApiGetIntrosRequest {
|
|
812
1241
|
/**
|
|
813
|
-
*
|
|
814
|
-
* @type {string}
|
|
815
|
-
* @memberof LibraryApiGetItemCounts
|
|
1242
|
+
* Item id.
|
|
816
1243
|
*/
|
|
817
|
-
readonly
|
|
1244
|
+
readonly itemId: string;
|
|
818
1245
|
/**
|
|
819
|
-
*
|
|
820
|
-
* @type {boolean}
|
|
821
|
-
* @memberof LibraryApiGetItemCounts
|
|
1246
|
+
* User id.
|
|
822
1247
|
*/
|
|
823
|
-
readonly
|
|
1248
|
+
readonly userId?: string;
|
|
824
1249
|
}
|
|
825
1250
|
/**
|
|
826
|
-
* Request parameters for
|
|
827
|
-
* @export
|
|
828
|
-
* @interface LibraryApiGetLibraryOptionsInfoRequest
|
|
1251
|
+
* Request parameters for getItem operation in LibraryApi.
|
|
829
1252
|
*/
|
|
830
|
-
export interface
|
|
831
|
-
/**
|
|
832
|
-
* Library content type.
|
|
833
|
-
* @type {CollectionType}
|
|
834
|
-
* @memberof LibraryApiGetLibraryOptionsInfo
|
|
835
|
-
*/
|
|
836
|
-
readonly libraryContentType?: CollectionType;
|
|
1253
|
+
export interface LibraryApiGetItemRequest {
|
|
837
1254
|
/**
|
|
838
|
-
*
|
|
839
|
-
* @type {boolean}
|
|
840
|
-
* @memberof LibraryApiGetLibraryOptionsInfo
|
|
1255
|
+
* Item id.
|
|
841
1256
|
*/
|
|
842
|
-
readonly
|
|
843
|
-
}
|
|
844
|
-
/**
|
|
845
|
-
* Request parameters for getMediaFolders operation in LibraryApi.
|
|
846
|
-
* @export
|
|
847
|
-
* @interface LibraryApiGetMediaFoldersRequest
|
|
848
|
-
*/
|
|
849
|
-
export interface LibraryApiGetMediaFoldersRequest {
|
|
1257
|
+
readonly itemId: string;
|
|
850
1258
|
/**
|
|
851
|
-
*
|
|
852
|
-
* @type {boolean}
|
|
853
|
-
* @memberof LibraryApiGetMediaFolders
|
|
1259
|
+
* User id.
|
|
854
1260
|
*/
|
|
855
|
-
readonly
|
|
1261
|
+
readonly userId?: string;
|
|
856
1262
|
}
|
|
857
1263
|
/**
|
|
858
|
-
* Request parameters for
|
|
859
|
-
* @export
|
|
860
|
-
* @interface LibraryApiGetSimilarAlbumsRequest
|
|
1264
|
+
* Request parameters for getItemCollections operation in LibraryApi.
|
|
861
1265
|
*/
|
|
862
|
-
export interface
|
|
1266
|
+
export interface LibraryApiGetItemCollectionsRequest {
|
|
863
1267
|
/**
|
|
864
1268
|
* The item id.
|
|
865
|
-
* @type {string}
|
|
866
|
-
* @memberof LibraryApiGetSimilarAlbums
|
|
867
1269
|
*/
|
|
868
1270
|
readonly itemId: string;
|
|
869
|
-
/**
|
|
870
|
-
* Exclude artist ids.
|
|
871
|
-
* @type {Array<string>}
|
|
872
|
-
* @memberof LibraryApiGetSimilarAlbums
|
|
873
|
-
*/
|
|
874
|
-
readonly excludeArtistIds?: Array<string>;
|
|
875
1271
|
/**
|
|
876
1272
|
* Optional. Filter by user id, and attach user data.
|
|
877
|
-
* @type {string}
|
|
878
|
-
* @memberof LibraryApiGetSimilarAlbums
|
|
879
1273
|
*/
|
|
880
1274
|
readonly userId?: string;
|
|
1275
|
+
/**
|
|
1276
|
+
* Optional. The index of the first record in the output.
|
|
1277
|
+
*/
|
|
1278
|
+
readonly startIndex?: number;
|
|
881
1279
|
/**
|
|
882
1280
|
* Optional. The maximum number of records to return.
|
|
883
|
-
* @type {number}
|
|
884
|
-
* @memberof LibraryApiGetSimilarAlbums
|
|
885
1281
|
*/
|
|
886
1282
|
readonly limit?: number;
|
|
887
1283
|
/**
|
|
888
|
-
* Optional. Specify additional fields of information to return in the output.
|
|
889
|
-
* @type {Array<ItemFields>}
|
|
890
|
-
* @memberof LibraryApiGetSimilarAlbums
|
|
1284
|
+
* Optional. Specify additional fields of information to return in the output.
|
|
891
1285
|
*/
|
|
892
1286
|
readonly fields?: Array<ItemFields>;
|
|
893
1287
|
}
|
|
894
1288
|
/**
|
|
895
|
-
* Request parameters for
|
|
896
|
-
* @export
|
|
897
|
-
* @interface LibraryApiGetSimilarArtistsRequest
|
|
1289
|
+
* Request parameters for getItemCounts operation in LibraryApi.
|
|
898
1290
|
*/
|
|
899
|
-
export interface
|
|
1291
|
+
export interface LibraryApiGetItemCountsRequest {
|
|
900
1292
|
/**
|
|
901
|
-
*
|
|
902
|
-
* @type {string}
|
|
903
|
-
* @memberof LibraryApiGetSimilarArtists
|
|
1293
|
+
* Optional. Get counts from a specific user\'s library.
|
|
904
1294
|
*/
|
|
905
|
-
readonly
|
|
1295
|
+
readonly userId?: string;
|
|
906
1296
|
/**
|
|
907
|
-
*
|
|
908
|
-
* @type {Array<string>}
|
|
909
|
-
* @memberof LibraryApiGetSimilarArtists
|
|
1297
|
+
* Optional. Get counts of favorite items.
|
|
910
1298
|
*/
|
|
911
|
-
readonly
|
|
1299
|
+
readonly isFavorite?: boolean;
|
|
1300
|
+
}
|
|
1301
|
+
/**
|
|
1302
|
+
* Request parameters for getItems operation in LibraryApi.
|
|
1303
|
+
*/
|
|
1304
|
+
export interface LibraryApiGetItemsRequest {
|
|
912
1305
|
/**
|
|
913
|
-
*
|
|
914
|
-
* @type {string}
|
|
915
|
-
* @memberof LibraryApiGetSimilarArtists
|
|
1306
|
+
* The user id supplied as query parameter; this is required when not using an API key.
|
|
916
1307
|
*/
|
|
917
1308
|
readonly userId?: string;
|
|
918
1309
|
/**
|
|
919
|
-
* Optional
|
|
920
|
-
* @type {number}
|
|
921
|
-
* @memberof LibraryApiGetSimilarArtists
|
|
1310
|
+
* Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).
|
|
922
1311
|
*/
|
|
923
|
-
readonly
|
|
1312
|
+
readonly maxOfficialRating?: string;
|
|
924
1313
|
/**
|
|
925
|
-
* Optional
|
|
926
|
-
* @type {Array<ItemFields>}
|
|
927
|
-
* @memberof LibraryApiGetSimilarArtists
|
|
1314
|
+
* Optional filter by items with theme songs.
|
|
928
1315
|
*/
|
|
929
|
-
readonly
|
|
930
|
-
}
|
|
931
|
-
/**
|
|
932
|
-
* Request parameters for getSimilarItems operation in LibraryApi.
|
|
933
|
-
* @export
|
|
934
|
-
* @interface LibraryApiGetSimilarItemsRequest
|
|
935
|
-
*/
|
|
936
|
-
export interface LibraryApiGetSimilarItemsRequest {
|
|
1316
|
+
readonly hasThemeSong?: boolean;
|
|
937
1317
|
/**
|
|
938
|
-
*
|
|
939
|
-
* @type {string}
|
|
940
|
-
* @memberof LibraryApiGetSimilarItems
|
|
1318
|
+
* Optional filter by items with theme videos.
|
|
941
1319
|
*/
|
|
942
|
-
readonly
|
|
1320
|
+
readonly hasThemeVideo?: boolean;
|
|
943
1321
|
/**
|
|
944
|
-
*
|
|
945
|
-
* @type {Array<string>}
|
|
946
|
-
* @memberof LibraryApiGetSimilarItems
|
|
1322
|
+
* Optional filter by items with subtitles.
|
|
947
1323
|
*/
|
|
948
|
-
readonly
|
|
1324
|
+
readonly hasSubtitles?: boolean;
|
|
949
1325
|
/**
|
|
950
|
-
* Optional
|
|
951
|
-
* @type {string}
|
|
952
|
-
* @memberof LibraryApiGetSimilarItems
|
|
1326
|
+
* Optional filter by items with special features.
|
|
953
1327
|
*/
|
|
954
|
-
readonly
|
|
1328
|
+
readonly hasSpecialFeature?: boolean;
|
|
955
1329
|
/**
|
|
956
|
-
* Optional
|
|
957
|
-
* @type {number}
|
|
958
|
-
* @memberof LibraryApiGetSimilarItems
|
|
1330
|
+
* Optional filter by items with trailers.
|
|
959
1331
|
*/
|
|
960
|
-
readonly
|
|
1332
|
+
readonly hasTrailer?: boolean;
|
|
961
1333
|
/**
|
|
962
|
-
* Optional.
|
|
963
|
-
* @type {Array<ItemFields>}
|
|
964
|
-
* @memberof LibraryApiGetSimilarItems
|
|
1334
|
+
* Optional. Return items that are siblings of a supplied item.
|
|
965
1335
|
*/
|
|
966
|
-
readonly
|
|
967
|
-
}
|
|
968
|
-
/**
|
|
969
|
-
* Request parameters for getSimilarMovies operation in LibraryApi.
|
|
970
|
-
* @export
|
|
971
|
-
* @interface LibraryApiGetSimilarMoviesRequest
|
|
972
|
-
*/
|
|
973
|
-
export interface LibraryApiGetSimilarMoviesRequest {
|
|
1336
|
+
readonly adjacentTo?: string;
|
|
974
1337
|
/**
|
|
975
|
-
*
|
|
976
|
-
* @type {string}
|
|
977
|
-
* @memberof LibraryApiGetSimilarMovies
|
|
1338
|
+
* Optional filter by index number.
|
|
978
1339
|
*/
|
|
979
|
-
readonly
|
|
1340
|
+
readonly indexNumber?: number;
|
|
980
1341
|
/**
|
|
981
|
-
*
|
|
982
|
-
* @type {Array<string>}
|
|
983
|
-
* @memberof LibraryApiGetSimilarMovies
|
|
1342
|
+
* Optional filter by parent index number.
|
|
984
1343
|
*/
|
|
985
|
-
readonly
|
|
1344
|
+
readonly parentIndexNumber?: number;
|
|
986
1345
|
/**
|
|
987
|
-
* Optional
|
|
988
|
-
* @type {string}
|
|
989
|
-
* @memberof LibraryApiGetSimilarMovies
|
|
1346
|
+
* Optional filter by items that have or do not have a parental rating.
|
|
990
1347
|
*/
|
|
991
|
-
readonly
|
|
1348
|
+
readonly hasParentalRating?: boolean;
|
|
992
1349
|
/**
|
|
993
|
-
* Optional
|
|
994
|
-
* @type {number}
|
|
995
|
-
* @memberof LibraryApiGetSimilarMovies
|
|
1350
|
+
* Optional filter by items that are HD or not.
|
|
996
1351
|
*/
|
|
997
|
-
readonly
|
|
1352
|
+
readonly isHd?: boolean;
|
|
998
1353
|
/**
|
|
999
|
-
* Optional
|
|
1000
|
-
* @type {Array<ItemFields>}
|
|
1001
|
-
* @memberof LibraryApiGetSimilarMovies
|
|
1354
|
+
* Optional filter by items that are 4K or not.
|
|
1002
1355
|
*/
|
|
1003
|
-
readonly
|
|
1004
|
-
}
|
|
1005
|
-
/**
|
|
1006
|
-
* Request parameters for getSimilarShows operation in LibraryApi.
|
|
1007
|
-
* @export
|
|
1008
|
-
* @interface LibraryApiGetSimilarShowsRequest
|
|
1009
|
-
*/
|
|
1010
|
-
export interface LibraryApiGetSimilarShowsRequest {
|
|
1356
|
+
readonly is4K?: boolean;
|
|
1011
1357
|
/**
|
|
1012
|
-
*
|
|
1013
|
-
* @type {string}
|
|
1014
|
-
* @memberof LibraryApiGetSimilarShows
|
|
1358
|
+
* Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.
|
|
1015
1359
|
*/
|
|
1016
|
-
readonly
|
|
1360
|
+
readonly locationTypes?: Array<LocationType>;
|
|
1017
1361
|
/**
|
|
1018
|
-
*
|
|
1019
|
-
* @type {Array<string>}
|
|
1020
|
-
* @memberof LibraryApiGetSimilarShows
|
|
1362
|
+
* Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.
|
|
1021
1363
|
*/
|
|
1022
|
-
readonly
|
|
1364
|
+
readonly excludeLocationTypes?: Array<LocationType>;
|
|
1023
1365
|
/**
|
|
1024
|
-
* Optional
|
|
1025
|
-
|
|
1026
|
-
|
|
1366
|
+
* Optional filter by items that are missing episodes or not.
|
|
1367
|
+
*/
|
|
1368
|
+
readonly isMissing?: boolean;
|
|
1369
|
+
/**
|
|
1370
|
+
* Optional filter by items that are unaired episodes or not.
|
|
1371
|
+
*/
|
|
1372
|
+
readonly isUnaired?: boolean;
|
|
1373
|
+
/**
|
|
1374
|
+
* Optional filter by minimum community rating.
|
|
1375
|
+
*/
|
|
1376
|
+
readonly minCommunityRating?: number;
|
|
1377
|
+
/**
|
|
1378
|
+
* Optional filter by minimum critic rating.
|
|
1379
|
+
*/
|
|
1380
|
+
readonly minCriticRating?: number;
|
|
1381
|
+
/**
|
|
1382
|
+
* Optional. The minimum premiere date. Format = ISO.
|
|
1383
|
+
*/
|
|
1384
|
+
readonly minPremiereDate?: string;
|
|
1385
|
+
/**
|
|
1386
|
+
* Optional. The minimum last saved date. Format = ISO.
|
|
1387
|
+
*/
|
|
1388
|
+
readonly minDateLastSaved?: string;
|
|
1389
|
+
/**
|
|
1390
|
+
* Optional. The minimum last saved date for the current user. Format = ISO.
|
|
1391
|
+
*/
|
|
1392
|
+
readonly minDateLastSavedForUser?: string;
|
|
1393
|
+
/**
|
|
1394
|
+
* Optional. The maximum premiere date. Format = ISO.
|
|
1395
|
+
*/
|
|
1396
|
+
readonly maxPremiereDate?: string;
|
|
1397
|
+
/**
|
|
1398
|
+
* Optional filter by items that have an overview or not.
|
|
1399
|
+
*/
|
|
1400
|
+
readonly hasOverview?: boolean;
|
|
1401
|
+
/**
|
|
1402
|
+
* Optional filter by items that have an IMDb id or not.
|
|
1403
|
+
*/
|
|
1404
|
+
readonly hasImdbId?: boolean;
|
|
1405
|
+
/**
|
|
1406
|
+
* Optional filter by items that have a TMDb id or not.
|
|
1407
|
+
*/
|
|
1408
|
+
readonly hasTmdbId?: boolean;
|
|
1409
|
+
/**
|
|
1410
|
+
* Optional filter by items that have a TVDb id or not.
|
|
1411
|
+
*/
|
|
1412
|
+
readonly hasTvdbId?: boolean;
|
|
1413
|
+
/**
|
|
1414
|
+
* Optional filter for live tv movies.
|
|
1415
|
+
*/
|
|
1416
|
+
readonly isMovie?: boolean;
|
|
1417
|
+
/**
|
|
1418
|
+
* Optional filter for live tv series.
|
|
1419
|
+
*/
|
|
1420
|
+
readonly isSeries?: boolean;
|
|
1421
|
+
/**
|
|
1422
|
+
* Optional filter for live tv news.
|
|
1423
|
+
*/
|
|
1424
|
+
readonly isNews?: boolean;
|
|
1425
|
+
/**
|
|
1426
|
+
* Optional filter for live tv kids.
|
|
1427
|
+
*/
|
|
1428
|
+
readonly isKids?: boolean;
|
|
1429
|
+
/**
|
|
1430
|
+
* Optional filter for live tv sports.
|
|
1431
|
+
*/
|
|
1432
|
+
readonly isSports?: boolean;
|
|
1433
|
+
/**
|
|
1434
|
+
* Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.
|
|
1435
|
+
*/
|
|
1436
|
+
readonly excludeItemIds?: Array<string>;
|
|
1437
|
+
/**
|
|
1438
|
+
* Optional. The record index to start at. All items with a lower index will be dropped from the results.
|
|
1439
|
+
*/
|
|
1440
|
+
readonly startIndex?: number;
|
|
1441
|
+
/**
|
|
1442
|
+
* Optional. The maximum number of records to return.
|
|
1443
|
+
*/
|
|
1444
|
+
readonly limit?: number;
|
|
1445
|
+
/**
|
|
1446
|
+
* When searching within folders, this determines whether or not the search will be recursive. true/false.
|
|
1447
|
+
*/
|
|
1448
|
+
readonly recursive?: boolean;
|
|
1449
|
+
/**
|
|
1450
|
+
* Optional. Filter based on a search term.
|
|
1451
|
+
*/
|
|
1452
|
+
readonly searchTerm?: string;
|
|
1453
|
+
/**
|
|
1454
|
+
* Sort Order - Ascending, Descending.
|
|
1455
|
+
*/
|
|
1456
|
+
readonly sortOrder?: Array<SortOrder>;
|
|
1457
|
+
/**
|
|
1458
|
+
* Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
1459
|
+
*/
|
|
1460
|
+
readonly parentId?: string;
|
|
1461
|
+
/**
|
|
1462
|
+
* 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.
|
|
1463
|
+
*/
|
|
1464
|
+
readonly fields?: Array<ItemFields>;
|
|
1465
|
+
/**
|
|
1466
|
+
* Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
1467
|
+
*/
|
|
1468
|
+
readonly excludeItemTypes?: Array<BaseItemKind>;
|
|
1469
|
+
/**
|
|
1470
|
+
* Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
|
|
1471
|
+
*/
|
|
1472
|
+
readonly includeItemTypes?: Array<BaseItemKind>;
|
|
1473
|
+
/**
|
|
1474
|
+
* Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.
|
|
1475
|
+
*/
|
|
1476
|
+
readonly filters?: Array<ItemFilter>;
|
|
1477
|
+
/**
|
|
1478
|
+
* Optional filter by items that are marked as favorite, or not.
|
|
1479
|
+
*/
|
|
1480
|
+
readonly isFavorite?: boolean;
|
|
1481
|
+
/**
|
|
1482
|
+
* Optional filter by MediaType. Allows multiple, comma delimited.
|
|
1483
|
+
*/
|
|
1484
|
+
readonly mediaTypes?: Array<MediaType>;
|
|
1485
|
+
/**
|
|
1486
|
+
* Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
|
|
1487
|
+
*/
|
|
1488
|
+
readonly imageTypes?: Array<ImageType>;
|
|
1489
|
+
/**
|
|
1490
|
+
* 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.
|
|
1491
|
+
*/
|
|
1492
|
+
readonly sortBy?: Array<ItemSortBy>;
|
|
1493
|
+
/**
|
|
1494
|
+
* Optional filter by items that are played, or not.
|
|
1495
|
+
*/
|
|
1496
|
+
readonly isPlayed?: boolean;
|
|
1497
|
+
/**
|
|
1498
|
+
* Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
|
|
1499
|
+
*/
|
|
1500
|
+
readonly genres?: Array<string>;
|
|
1501
|
+
/**
|
|
1502
|
+
* Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.
|
|
1503
|
+
*/
|
|
1504
|
+
readonly officialRatings?: Array<string>;
|
|
1505
|
+
/**
|
|
1506
|
+
* Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.
|
|
1507
|
+
*/
|
|
1508
|
+
readonly tags?: Array<string>;
|
|
1509
|
+
/**
|
|
1510
|
+
* Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.
|
|
1511
|
+
*/
|
|
1512
|
+
readonly years?: Array<number>;
|
|
1513
|
+
/**
|
|
1514
|
+
* Optional, include user data.
|
|
1515
|
+
*/
|
|
1516
|
+
readonly enableUserData?: boolean;
|
|
1517
|
+
/**
|
|
1518
|
+
* Optional, the max number of images to return, per image type.
|
|
1519
|
+
*/
|
|
1520
|
+
readonly imageTypeLimit?: number;
|
|
1521
|
+
/**
|
|
1522
|
+
* Optional. The image types to include in the output.
|
|
1523
|
+
*/
|
|
1524
|
+
readonly enableImageTypes?: Array<ImageType>;
|
|
1525
|
+
/**
|
|
1526
|
+
* Optional. If specified, results will be filtered to include only those containing the specified person.
|
|
1527
|
+
*/
|
|
1528
|
+
readonly person?: string;
|
|
1529
|
+
/**
|
|
1530
|
+
* Optional. If specified, results will be filtered to include only those containing the specified person id.
|
|
1531
|
+
*/
|
|
1532
|
+
readonly personIds?: Array<string>;
|
|
1533
|
+
/**
|
|
1534
|
+
* Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.
|
|
1535
|
+
*/
|
|
1536
|
+
readonly personTypes?: Array<string>;
|
|
1537
|
+
/**
|
|
1538
|
+
* Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.
|
|
1539
|
+
*/
|
|
1540
|
+
readonly studios?: Array<string>;
|
|
1541
|
+
/**
|
|
1542
|
+
* Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.
|
|
1543
|
+
*/
|
|
1544
|
+
readonly artists?: Array<string>;
|
|
1545
|
+
/**
|
|
1546
|
+
* Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.
|
|
1547
|
+
*/
|
|
1548
|
+
readonly excludeArtistIds?: Array<string>;
|
|
1549
|
+
/**
|
|
1550
|
+
* Optional. If specified, results will be filtered to include only those containing the specified artist id.
|
|
1551
|
+
*/
|
|
1552
|
+
readonly artistIds?: Array<string>;
|
|
1553
|
+
/**
|
|
1554
|
+
* Optional. If specified, results will be filtered to include only those containing the specified album artist id.
|
|
1555
|
+
*/
|
|
1556
|
+
readonly albumArtistIds?: Array<string>;
|
|
1557
|
+
/**
|
|
1558
|
+
* Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.
|
|
1559
|
+
*/
|
|
1560
|
+
readonly contributingArtistIds?: Array<string>;
|
|
1561
|
+
/**
|
|
1562
|
+
* Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.
|
|
1563
|
+
*/
|
|
1564
|
+
readonly albums?: Array<string>;
|
|
1565
|
+
/**
|
|
1566
|
+
* Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.
|
|
1567
|
+
*/
|
|
1568
|
+
readonly albumIds?: Array<string>;
|
|
1569
|
+
/**
|
|
1570
|
+
* Optional. If specific items are needed, specify a list of item id\'s to retrieve. This allows multiple, comma delimited.
|
|
1571
|
+
*/
|
|
1572
|
+
readonly ids?: Array<string>;
|
|
1573
|
+
/**
|
|
1574
|
+
* Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.
|
|
1575
|
+
*/
|
|
1576
|
+
readonly videoTypes?: Array<VideoType>;
|
|
1577
|
+
/**
|
|
1578
|
+
* Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).
|
|
1579
|
+
*/
|
|
1580
|
+
readonly minOfficialRating?: string;
|
|
1581
|
+
/**
|
|
1582
|
+
* Optional filter by items that are locked.
|
|
1583
|
+
*/
|
|
1584
|
+
readonly isLocked?: boolean;
|
|
1585
|
+
/**
|
|
1586
|
+
* Optional filter by items that are placeholders.
|
|
1587
|
+
*/
|
|
1588
|
+
readonly isPlaceHolder?: boolean;
|
|
1589
|
+
/**
|
|
1590
|
+
* Optional filter by items that have official ratings.
|
|
1591
|
+
*/
|
|
1592
|
+
readonly hasOfficialRating?: boolean;
|
|
1593
|
+
/**
|
|
1594
|
+
* Whether or not to hide items behind their boxsets.
|
|
1595
|
+
*/
|
|
1596
|
+
readonly collapseBoxSetItems?: boolean;
|
|
1597
|
+
/**
|
|
1598
|
+
* Optional. Filter by the minimum width of the item.
|
|
1599
|
+
*/
|
|
1600
|
+
readonly minWidth?: number;
|
|
1601
|
+
/**
|
|
1602
|
+
* Optional. Filter by the minimum height of the item.
|
|
1603
|
+
*/
|
|
1604
|
+
readonly minHeight?: number;
|
|
1605
|
+
/**
|
|
1606
|
+
* Optional. Filter by the maximum width of the item.
|
|
1607
|
+
*/
|
|
1608
|
+
readonly maxWidth?: number;
|
|
1609
|
+
/**
|
|
1610
|
+
* Optional. Filter by the maximum height of the item.
|
|
1611
|
+
*/
|
|
1612
|
+
readonly maxHeight?: number;
|
|
1613
|
+
/**
|
|
1614
|
+
* Optional filter by items that are 3D, or not.
|
|
1615
|
+
*/
|
|
1616
|
+
readonly is3D?: boolean;
|
|
1617
|
+
/**
|
|
1618
|
+
* Optional filter by Series Status. Allows multiple, comma delimited.
|
|
1619
|
+
*/
|
|
1620
|
+
readonly seriesStatus?: Array<SeriesStatus>;
|
|
1621
|
+
/**
|
|
1622
|
+
* Optional filter by items whose name is sorted equally or greater than a given input string.
|
|
1623
|
+
*/
|
|
1624
|
+
readonly nameStartsWithOrGreater?: string;
|
|
1625
|
+
/**
|
|
1626
|
+
* Optional filter by items whose name is sorted equally than a given input string.
|
|
1627
|
+
*/
|
|
1628
|
+
readonly nameStartsWith?: string;
|
|
1629
|
+
/**
|
|
1630
|
+
* Optional filter by items whose name is equally or lesser than a given input string.
|
|
1631
|
+
*/
|
|
1632
|
+
readonly nameLessThan?: string;
|
|
1633
|
+
/**
|
|
1634
|
+
* Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.
|
|
1635
|
+
*/
|
|
1636
|
+
readonly studioIds?: Array<string>;
|
|
1637
|
+
/**
|
|
1638
|
+
* Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
|
|
1639
|
+
*/
|
|
1640
|
+
readonly genreIds?: Array<string>;
|
|
1641
|
+
/**
|
|
1642
|
+
* Optional. If specified, results will be filtered based on audio language. This allows multiple, comma delimited values.
|
|
1643
|
+
*/
|
|
1644
|
+
readonly audioLanguages?: Array<string>;
|
|
1645
|
+
/**
|
|
1646
|
+
* Optional. If specified, results will be filtered based on subtitle language. This allows multiple, comma delimited values.
|
|
1647
|
+
*/
|
|
1648
|
+
readonly subtitleLanguages?: Array<string>;
|
|
1649
|
+
/**
|
|
1650
|
+
* Optional. Enable the total record count.
|
|
1651
|
+
*/
|
|
1652
|
+
readonly enableTotalRecordCount?: boolean;
|
|
1653
|
+
/**
|
|
1654
|
+
* Optional, include image information in output.
|
|
1655
|
+
*/
|
|
1656
|
+
readonly enableImages?: boolean;
|
|
1657
|
+
}
|
|
1658
|
+
/**
|
|
1659
|
+
* Request parameters for getLatestMedia operation in LibraryApi.
|
|
1660
|
+
*/
|
|
1661
|
+
export interface LibraryApiGetLatestMediaRequest {
|
|
1662
|
+
/**
|
|
1663
|
+
* User id.
|
|
1664
|
+
*/
|
|
1665
|
+
readonly userId?: string;
|
|
1666
|
+
/**
|
|
1667
|
+
* Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
1668
|
+
*/
|
|
1669
|
+
readonly parentId?: string;
|
|
1670
|
+
/**
|
|
1671
|
+
* Optional. Specify additional fields of information to return in the output.
|
|
1672
|
+
*/
|
|
1673
|
+
readonly fields?: Array<ItemFields>;
|
|
1674
|
+
/**
|
|
1675
|
+
* Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
1676
|
+
*/
|
|
1677
|
+
readonly includeItemTypes?: Array<BaseItemKind>;
|
|
1678
|
+
/**
|
|
1679
|
+
* Filter by items that are played, or not.
|
|
1680
|
+
*/
|
|
1681
|
+
readonly isPlayed?: boolean;
|
|
1682
|
+
/**
|
|
1683
|
+
* Optional. include image information in output.
|
|
1684
|
+
*/
|
|
1685
|
+
readonly enableImages?: boolean;
|
|
1686
|
+
/**
|
|
1687
|
+
* Optional. the max number of images to return, per image type.
|
|
1688
|
+
*/
|
|
1689
|
+
readonly imageTypeLimit?: number;
|
|
1690
|
+
/**
|
|
1691
|
+
* Optional. The image types to include in the output.
|
|
1692
|
+
*/
|
|
1693
|
+
readonly enableImageTypes?: Array<ImageType>;
|
|
1694
|
+
/**
|
|
1695
|
+
* Optional. include user data.
|
|
1696
|
+
*/
|
|
1697
|
+
readonly enableUserData?: boolean;
|
|
1698
|
+
/**
|
|
1699
|
+
* Return item limit.
|
|
1700
|
+
*/
|
|
1701
|
+
readonly limit?: number;
|
|
1702
|
+
/**
|
|
1703
|
+
* Whether or not to group items into a parent container.
|
|
1704
|
+
*/
|
|
1705
|
+
readonly groupItems?: boolean;
|
|
1706
|
+
}
|
|
1707
|
+
/**
|
|
1708
|
+
* Request parameters for getLibraryOptionsInfo operation in LibraryApi.
|
|
1709
|
+
*/
|
|
1710
|
+
export interface LibraryApiGetLibraryOptionsInfoRequest {
|
|
1711
|
+
/**
|
|
1712
|
+
* Library content type.
|
|
1713
|
+
*/
|
|
1714
|
+
readonly libraryContentType?: CollectionType;
|
|
1715
|
+
/**
|
|
1716
|
+
* Whether this is a new library.
|
|
1717
|
+
*/
|
|
1718
|
+
readonly isNewLibrary?: boolean;
|
|
1719
|
+
}
|
|
1720
|
+
/**
|
|
1721
|
+
* Request parameters for getLocalTrailers operation in LibraryApi.
|
|
1722
|
+
*/
|
|
1723
|
+
export interface LibraryApiGetLocalTrailersRequest {
|
|
1724
|
+
/**
|
|
1725
|
+
* Item id.
|
|
1726
|
+
*/
|
|
1727
|
+
readonly itemId: string;
|
|
1728
|
+
/**
|
|
1729
|
+
* User id.
|
|
1730
|
+
*/
|
|
1731
|
+
readonly userId?: string;
|
|
1732
|
+
}
|
|
1733
|
+
/**
|
|
1734
|
+
* Request parameters for getMediaFolders operation in LibraryApi.
|
|
1735
|
+
*/
|
|
1736
|
+
export interface LibraryApiGetMediaFoldersRequest {
|
|
1737
|
+
/**
|
|
1738
|
+
* Optional. Filter by folders that are marked hidden, or not.
|
|
1739
|
+
*/
|
|
1740
|
+
readonly isHidden?: boolean;
|
|
1741
|
+
}
|
|
1742
|
+
/**
|
|
1743
|
+
* Request parameters for getResumeItems operation in LibraryApi.
|
|
1744
|
+
*/
|
|
1745
|
+
export interface LibraryApiGetResumeItemsRequest {
|
|
1746
|
+
/**
|
|
1747
|
+
* The user id.
|
|
1748
|
+
*/
|
|
1749
|
+
readonly userId?: string;
|
|
1750
|
+
/**
|
|
1751
|
+
* The start index.
|
|
1752
|
+
*/
|
|
1753
|
+
readonly startIndex?: number;
|
|
1754
|
+
/**
|
|
1755
|
+
* The item limit.
|
|
1756
|
+
*/
|
|
1757
|
+
readonly limit?: number;
|
|
1758
|
+
/**
|
|
1759
|
+
* The search term.
|
|
1760
|
+
*/
|
|
1761
|
+
readonly searchTerm?: string;
|
|
1762
|
+
/**
|
|
1763
|
+
* Specify this to localize the search to a specific item or folder. Omit to use the root.
|
|
1764
|
+
*/
|
|
1765
|
+
readonly parentId?: string;
|
|
1766
|
+
/**
|
|
1767
|
+
* 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.
|
|
1768
|
+
*/
|
|
1769
|
+
readonly fields?: Array<ItemFields>;
|
|
1770
|
+
/**
|
|
1771
|
+
* Optional. Filter by MediaType. Allows multiple, comma delimited.
|
|
1772
|
+
*/
|
|
1773
|
+
readonly mediaTypes?: Array<MediaType>;
|
|
1774
|
+
/**
|
|
1775
|
+
* Optional. Include user data.
|
|
1776
|
+
*/
|
|
1777
|
+
readonly enableUserData?: boolean;
|
|
1778
|
+
/**
|
|
1779
|
+
* Optional. The max number of images to return, per image type.
|
|
1780
|
+
*/
|
|
1781
|
+
readonly imageTypeLimit?: number;
|
|
1782
|
+
/**
|
|
1783
|
+
* Optional. The image types to include in the output.
|
|
1784
|
+
*/
|
|
1785
|
+
readonly enableImageTypes?: Array<ImageType>;
|
|
1786
|
+
/**
|
|
1787
|
+
* Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
|
|
1788
|
+
*/
|
|
1789
|
+
readonly excludeItemTypes?: Array<BaseItemKind>;
|
|
1790
|
+
/**
|
|
1791
|
+
* Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.
|
|
1792
|
+
*/
|
|
1793
|
+
readonly includeItemTypes?: Array<BaseItemKind>;
|
|
1794
|
+
/**
|
|
1795
|
+
* Optional. Enable the total record count.
|
|
1796
|
+
*/
|
|
1797
|
+
readonly enableTotalRecordCount?: boolean;
|
|
1798
|
+
/**
|
|
1799
|
+
* Optional. Include image information in output.
|
|
1800
|
+
*/
|
|
1801
|
+
readonly enableImages?: boolean;
|
|
1802
|
+
/**
|
|
1803
|
+
* Optional. Whether to exclude the currently active sessions.
|
|
1804
|
+
*/
|
|
1805
|
+
readonly excludeActiveSessions?: boolean;
|
|
1806
|
+
}
|
|
1807
|
+
/**
|
|
1808
|
+
* Request parameters for getRootFolder operation in LibraryApi.
|
|
1809
|
+
*/
|
|
1810
|
+
export interface LibraryApiGetRootFolderRequest {
|
|
1811
|
+
/**
|
|
1812
|
+
* User id.
|
|
1813
|
+
*/
|
|
1814
|
+
readonly userId?: string;
|
|
1815
|
+
}
|
|
1816
|
+
/**
|
|
1817
|
+
* Request parameters for getSimilarAlbums operation in LibraryApi.
|
|
1818
|
+
*/
|
|
1819
|
+
export interface LibraryApiGetSimilarAlbumsRequest {
|
|
1820
|
+
/**
|
|
1821
|
+
* The item id.
|
|
1822
|
+
*/
|
|
1823
|
+
readonly itemId: string;
|
|
1824
|
+
/**
|
|
1825
|
+
* Exclude artist ids.
|
|
1826
|
+
*/
|
|
1827
|
+
readonly excludeArtistIds?: Array<string>;
|
|
1828
|
+
/**
|
|
1829
|
+
* Optional. Filter by user id, and attach user data.
|
|
1830
|
+
*/
|
|
1831
|
+
readonly userId?: string;
|
|
1832
|
+
/**
|
|
1833
|
+
* Optional. The maximum number of records to return.
|
|
1834
|
+
*/
|
|
1835
|
+
readonly limit?: number;
|
|
1836
|
+
/**
|
|
1837
|
+
* 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, TrailerUrls.
|
|
1838
|
+
*/
|
|
1839
|
+
readonly fields?: Array<ItemFields>;
|
|
1840
|
+
}
|
|
1841
|
+
/**
|
|
1842
|
+
* Request parameters for getSimilarArtists operation in LibraryApi.
|
|
1843
|
+
*/
|
|
1844
|
+
export interface LibraryApiGetSimilarArtistsRequest {
|
|
1845
|
+
/**
|
|
1846
|
+
* The item id.
|
|
1847
|
+
*/
|
|
1848
|
+
readonly itemId: string;
|
|
1849
|
+
/**
|
|
1850
|
+
* Exclude artist ids.
|
|
1851
|
+
*/
|
|
1852
|
+
readonly excludeArtistIds?: Array<string>;
|
|
1853
|
+
/**
|
|
1854
|
+
* Optional. Filter by user id, and attach user data.
|
|
1855
|
+
*/
|
|
1856
|
+
readonly userId?: string;
|
|
1857
|
+
/**
|
|
1858
|
+
* Optional. The maximum number of records to return.
|
|
1859
|
+
*/
|
|
1860
|
+
readonly limit?: number;
|
|
1861
|
+
/**
|
|
1862
|
+
* 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, TrailerUrls.
|
|
1863
|
+
*/
|
|
1864
|
+
readonly fields?: Array<ItemFields>;
|
|
1865
|
+
}
|
|
1866
|
+
/**
|
|
1867
|
+
* Request parameters for getSimilarItems operation in LibraryApi.
|
|
1868
|
+
*/
|
|
1869
|
+
export interface LibraryApiGetSimilarItemsRequest {
|
|
1870
|
+
/**
|
|
1871
|
+
* The item id.
|
|
1872
|
+
*/
|
|
1873
|
+
readonly itemId: string;
|
|
1874
|
+
/**
|
|
1875
|
+
* Exclude artist ids.
|
|
1876
|
+
*/
|
|
1877
|
+
readonly excludeArtistIds?: Array<string>;
|
|
1878
|
+
/**
|
|
1879
|
+
* Optional. Filter by user id, and attach user data.
|
|
1880
|
+
*/
|
|
1881
|
+
readonly userId?: string;
|
|
1882
|
+
/**
|
|
1883
|
+
* Optional. The maximum number of records to return.
|
|
1884
|
+
*/
|
|
1885
|
+
readonly limit?: number;
|
|
1886
|
+
/**
|
|
1887
|
+
* 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, TrailerUrls.
|
|
1888
|
+
*/
|
|
1889
|
+
readonly fields?: Array<ItemFields>;
|
|
1890
|
+
}
|
|
1891
|
+
/**
|
|
1892
|
+
* Request parameters for getSimilarMovies operation in LibraryApi.
|
|
1893
|
+
*/
|
|
1894
|
+
export interface LibraryApiGetSimilarMoviesRequest {
|
|
1895
|
+
/**
|
|
1896
|
+
* The item id.
|
|
1897
|
+
*/
|
|
1898
|
+
readonly itemId: string;
|
|
1899
|
+
/**
|
|
1900
|
+
* Exclude artist ids.
|
|
1901
|
+
*/
|
|
1902
|
+
readonly excludeArtistIds?: Array<string>;
|
|
1903
|
+
/**
|
|
1904
|
+
* Optional. Filter by user id, and attach user data.
|
|
1905
|
+
*/
|
|
1906
|
+
readonly userId?: string;
|
|
1907
|
+
/**
|
|
1908
|
+
* Optional. The maximum number of records to return.
|
|
1909
|
+
*/
|
|
1910
|
+
readonly limit?: number;
|
|
1911
|
+
/**
|
|
1912
|
+
* 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, TrailerUrls.
|
|
1913
|
+
*/
|
|
1914
|
+
readonly fields?: Array<ItemFields>;
|
|
1915
|
+
}
|
|
1916
|
+
/**
|
|
1917
|
+
* Request parameters for getSimilarShows operation in LibraryApi.
|
|
1918
|
+
*/
|
|
1919
|
+
export interface LibraryApiGetSimilarShowsRequest {
|
|
1920
|
+
/**
|
|
1921
|
+
* The item id.
|
|
1922
|
+
*/
|
|
1923
|
+
readonly itemId: string;
|
|
1924
|
+
/**
|
|
1925
|
+
* Exclude artist ids.
|
|
1926
|
+
*/
|
|
1927
|
+
readonly excludeArtistIds?: Array<string>;
|
|
1928
|
+
/**
|
|
1929
|
+
* Optional. Filter by user id, and attach user data.
|
|
1027
1930
|
*/
|
|
1028
1931
|
readonly userId?: string;
|
|
1029
1932
|
/**
|
|
1030
1933
|
* Optional. The maximum number of records to return.
|
|
1031
|
-
* @type {number}
|
|
1032
|
-
* @memberof LibraryApiGetSimilarShows
|
|
1033
1934
|
*/
|
|
1034
1935
|
readonly limit?: number;
|
|
1035
1936
|
/**
|
|
1036
1937
|
* 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, TrailerUrls.
|
|
1037
|
-
* @type {Array<ItemFields>}
|
|
1038
|
-
* @memberof LibraryApiGetSimilarShows
|
|
1039
1938
|
*/
|
|
1040
1939
|
readonly fields?: Array<ItemFields>;
|
|
1041
1940
|
}
|
|
1042
1941
|
/**
|
|
1043
1942
|
* Request parameters for getSimilarTrailers operation in LibraryApi.
|
|
1044
|
-
* @export
|
|
1045
|
-
* @interface LibraryApiGetSimilarTrailersRequest
|
|
1046
1943
|
*/
|
|
1047
1944
|
export interface LibraryApiGetSimilarTrailersRequest {
|
|
1048
1945
|
/**
|
|
1049
1946
|
* The item id.
|
|
1050
|
-
* @type {string}
|
|
1051
|
-
* @memberof LibraryApiGetSimilarTrailers
|
|
1052
1947
|
*/
|
|
1053
1948
|
readonly itemId: string;
|
|
1054
1949
|
/**
|
|
1055
1950
|
* Exclude artist ids.
|
|
1056
|
-
* @type {Array<string>}
|
|
1057
|
-
* @memberof LibraryApiGetSimilarTrailers
|
|
1058
1951
|
*/
|
|
1059
1952
|
readonly excludeArtistIds?: Array<string>;
|
|
1060
1953
|
/**
|
|
1061
1954
|
* Optional. Filter by user id, and attach user data.
|
|
1062
|
-
* @type {string}
|
|
1063
|
-
* @memberof LibraryApiGetSimilarTrailers
|
|
1064
1955
|
*/
|
|
1065
1956
|
readonly userId?: string;
|
|
1066
1957
|
/**
|
|
1067
1958
|
* Optional. The maximum number of records to return.
|
|
1068
|
-
* @type {number}
|
|
1069
|
-
* @memberof LibraryApiGetSimilarTrailers
|
|
1070
1959
|
*/
|
|
1071
1960
|
readonly limit?: number;
|
|
1072
1961
|
/**
|
|
1073
1962
|
* 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, TrailerUrls.
|
|
1074
|
-
* @type {Array<ItemFields>}
|
|
1075
|
-
* @memberof LibraryApiGetSimilarTrailers
|
|
1076
1963
|
*/
|
|
1077
1964
|
readonly fields?: Array<ItemFields>;
|
|
1078
1965
|
}
|
|
1966
|
+
/**
|
|
1967
|
+
* Request parameters for getSpecialFeatures operation in LibraryApi.
|
|
1968
|
+
*/
|
|
1969
|
+
export interface LibraryApiGetSpecialFeaturesRequest {
|
|
1970
|
+
/**
|
|
1971
|
+
* Item id.
|
|
1972
|
+
*/
|
|
1973
|
+
readonly itemId: string;
|
|
1974
|
+
/**
|
|
1975
|
+
* User id.
|
|
1976
|
+
*/
|
|
1977
|
+
readonly userId?: string;
|
|
1978
|
+
}
|
|
1079
1979
|
/**
|
|
1080
1980
|
* Request parameters for getThemeMedia operation in LibraryApi.
|
|
1081
|
-
* @export
|
|
1082
|
-
* @interface LibraryApiGetThemeMediaRequest
|
|
1083
1981
|
*/
|
|
1084
1982
|
export interface LibraryApiGetThemeMediaRequest {
|
|
1085
1983
|
/**
|
|
1086
1984
|
* The item id.
|
|
1087
|
-
* @type {string}
|
|
1088
|
-
* @memberof LibraryApiGetThemeMedia
|
|
1089
1985
|
*/
|
|
1090
1986
|
readonly itemId: string;
|
|
1091
1987
|
/**
|
|
1092
1988
|
* Optional. Filter by user id, and attach user data.
|
|
1093
|
-
* @type {string}
|
|
1094
|
-
* @memberof LibraryApiGetThemeMedia
|
|
1095
1989
|
*/
|
|
1096
1990
|
readonly userId?: string;
|
|
1097
1991
|
/**
|
|
1098
1992
|
* Optional. Determines whether or not parent items should be searched for theme media.
|
|
1099
|
-
* @type {boolean}
|
|
1100
|
-
* @memberof LibraryApiGetThemeMedia
|
|
1101
1993
|
*/
|
|
1102
1994
|
readonly inheritFromParent?: boolean;
|
|
1103
1995
|
/**
|
|
1104
1996
|
* 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.
|
|
1105
|
-
* @type {Array<ItemSortBy>}
|
|
1106
|
-
* @memberof LibraryApiGetThemeMedia
|
|
1107
1997
|
*/
|
|
1108
1998
|
readonly sortBy?: Array<ItemSortBy>;
|
|
1109
1999
|
/**
|
|
1110
2000
|
* Optional. Sort Order - Ascending, Descending.
|
|
1111
|
-
* @type {Array<SortOrder>}
|
|
1112
|
-
* @memberof LibraryApiGetThemeMedia
|
|
1113
2001
|
*/
|
|
1114
2002
|
readonly sortOrder?: Array<SortOrder>;
|
|
1115
2003
|
}
|
|
1116
2004
|
/**
|
|
1117
2005
|
* Request parameters for getThemeSongs operation in LibraryApi.
|
|
1118
|
-
* @export
|
|
1119
|
-
* @interface LibraryApiGetThemeSongsRequest
|
|
1120
2006
|
*/
|
|
1121
2007
|
export interface LibraryApiGetThemeSongsRequest {
|
|
1122
2008
|
/**
|
|
1123
2009
|
* The item id.
|
|
1124
|
-
* @type {string}
|
|
1125
|
-
* @memberof LibraryApiGetThemeSongs
|
|
1126
2010
|
*/
|
|
1127
2011
|
readonly itemId: string;
|
|
1128
2012
|
/**
|
|
1129
2013
|
* Optional. Filter by user id, and attach user data.
|
|
1130
|
-
* @type {string}
|
|
1131
|
-
* @memberof LibraryApiGetThemeSongs
|
|
1132
2014
|
*/
|
|
1133
2015
|
readonly userId?: string;
|
|
1134
2016
|
/**
|
|
1135
2017
|
* Optional. Determines whether or not parent items should be searched for theme media.
|
|
1136
|
-
* @type {boolean}
|
|
1137
|
-
* @memberof LibraryApiGetThemeSongs
|
|
1138
2018
|
*/
|
|
1139
2019
|
readonly inheritFromParent?: boolean;
|
|
1140
2020
|
/**
|
|
1141
2021
|
* 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.
|
|
1142
|
-
* @type {Array<ItemSortBy>}
|
|
1143
|
-
* @memberof LibraryApiGetThemeSongs
|
|
1144
2022
|
*/
|
|
1145
2023
|
readonly sortBy?: Array<ItemSortBy>;
|
|
1146
2024
|
/**
|
|
1147
2025
|
* Optional. Sort Order - Ascending, Descending.
|
|
1148
|
-
* @type {Array<SortOrder>}
|
|
1149
|
-
* @memberof LibraryApiGetThemeSongs
|
|
1150
2026
|
*/
|
|
1151
2027
|
readonly sortOrder?: Array<SortOrder>;
|
|
1152
2028
|
}
|
|
1153
2029
|
/**
|
|
1154
2030
|
* Request parameters for getThemeVideos operation in LibraryApi.
|
|
1155
|
-
* @export
|
|
1156
|
-
* @interface LibraryApiGetThemeVideosRequest
|
|
1157
2031
|
*/
|
|
1158
2032
|
export interface LibraryApiGetThemeVideosRequest {
|
|
1159
2033
|
/**
|
|
1160
2034
|
* The item id.
|
|
1161
|
-
* @type {string}
|
|
1162
|
-
* @memberof LibraryApiGetThemeVideos
|
|
1163
2035
|
*/
|
|
1164
2036
|
readonly itemId: string;
|
|
1165
2037
|
/**
|
|
1166
2038
|
* Optional. Filter by user id, and attach user data.
|
|
1167
|
-
* @type {string}
|
|
1168
|
-
* @memberof LibraryApiGetThemeVideos
|
|
1169
2039
|
*/
|
|
1170
2040
|
readonly userId?: string;
|
|
1171
2041
|
/**
|
|
1172
2042
|
* Optional. Determines whether or not parent items should be searched for theme media.
|
|
1173
|
-
* @type {boolean}
|
|
1174
|
-
* @memberof LibraryApiGetThemeVideos
|
|
1175
2043
|
*/
|
|
1176
2044
|
readonly inheritFromParent?: boolean;
|
|
1177
2045
|
/**
|
|
1178
2046
|
* 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.
|
|
1179
|
-
* @type {Array<ItemSortBy>}
|
|
1180
|
-
* @memberof LibraryApiGetThemeVideos
|
|
1181
2047
|
*/
|
|
1182
2048
|
readonly sortBy?: Array<ItemSortBy>;
|
|
1183
2049
|
/**
|
|
1184
2050
|
* Optional. Sort Order - Ascending, Descending.
|
|
1185
|
-
* @type {Array<SortOrder>}
|
|
1186
|
-
* @memberof LibraryApiGetThemeVideos
|
|
1187
2051
|
*/
|
|
1188
2052
|
readonly sortOrder?: Array<SortOrder>;
|
|
1189
2053
|
}
|
|
1190
2054
|
/**
|
|
1191
2055
|
* Request parameters for postAddedMovies operation in LibraryApi.
|
|
1192
|
-
* @export
|
|
1193
|
-
* @interface LibraryApiPostAddedMoviesRequest
|
|
1194
2056
|
*/
|
|
1195
2057
|
export interface LibraryApiPostAddedMoviesRequest {
|
|
1196
2058
|
/**
|
|
1197
2059
|
* The tmdbId.
|
|
1198
|
-
* @type {string}
|
|
1199
|
-
* @memberof LibraryApiPostAddedMovies
|
|
1200
2060
|
*/
|
|
1201
2061
|
readonly tmdbId?: string;
|
|
1202
2062
|
/**
|
|
1203
2063
|
* The imdbId.
|
|
1204
|
-
* @type {string}
|
|
1205
|
-
* @memberof LibraryApiPostAddedMovies
|
|
1206
2064
|
*/
|
|
1207
2065
|
readonly imdbId?: string;
|
|
1208
2066
|
}
|
|
1209
2067
|
/**
|
|
1210
2068
|
* Request parameters for postAddedSeries operation in LibraryApi.
|
|
1211
|
-
* @export
|
|
1212
|
-
* @interface LibraryApiPostAddedSeriesRequest
|
|
1213
2069
|
*/
|
|
1214
2070
|
export interface LibraryApiPostAddedSeriesRequest {
|
|
1215
2071
|
/**
|
|
1216
2072
|
* The tvdbId.
|
|
1217
|
-
* @type {string}
|
|
1218
|
-
* @memberof LibraryApiPostAddedSeries
|
|
1219
2073
|
*/
|
|
1220
2074
|
readonly tvdbId?: string;
|
|
1221
2075
|
}
|
|
1222
2076
|
/**
|
|
1223
2077
|
* Request parameters for postUpdatedMedia operation in LibraryApi.
|
|
1224
|
-
* @export
|
|
1225
|
-
* @interface LibraryApiPostUpdatedMediaRequest
|
|
1226
2078
|
*/
|
|
1227
2079
|
export interface LibraryApiPostUpdatedMediaRequest {
|
|
1228
2080
|
/**
|
|
1229
2081
|
* The update paths.
|
|
1230
|
-
* @type {MediaUpdateInfoDto}
|
|
1231
|
-
* @memberof LibraryApiPostUpdatedMedia
|
|
1232
2082
|
*/
|
|
1233
2083
|
readonly mediaUpdateInfoDto: MediaUpdateInfoDto;
|
|
1234
2084
|
}
|
|
1235
2085
|
/**
|
|
1236
2086
|
* Request parameters for postUpdatedMovies operation in LibraryApi.
|
|
1237
|
-
* @export
|
|
1238
|
-
* @interface LibraryApiPostUpdatedMoviesRequest
|
|
1239
2087
|
*/
|
|
1240
2088
|
export interface LibraryApiPostUpdatedMoviesRequest {
|
|
1241
2089
|
/**
|
|
1242
2090
|
* The tmdbId.
|
|
1243
|
-
* @type {string}
|
|
1244
|
-
* @memberof LibraryApiPostUpdatedMovies
|
|
1245
2091
|
*/
|
|
1246
2092
|
readonly tmdbId?: string;
|
|
1247
2093
|
/**
|
|
1248
2094
|
* The imdbId.
|
|
1249
|
-
* @type {string}
|
|
1250
|
-
* @memberof LibraryApiPostUpdatedMovies
|
|
1251
2095
|
*/
|
|
1252
2096
|
readonly imdbId?: string;
|
|
1253
2097
|
}
|
|
1254
2098
|
/**
|
|
1255
2099
|
* Request parameters for postUpdatedSeries operation in LibraryApi.
|
|
1256
|
-
* @export
|
|
1257
|
-
* @interface LibraryApiPostUpdatedSeriesRequest
|
|
1258
2100
|
*/
|
|
1259
2101
|
export interface LibraryApiPostUpdatedSeriesRequest {
|
|
1260
2102
|
/**
|
|
1261
2103
|
* The tvdbId.
|
|
1262
|
-
* @type {string}
|
|
1263
|
-
* @memberof LibraryApiPostUpdatedSeries
|
|
1264
2104
|
*/
|
|
1265
2105
|
readonly tvdbId?: string;
|
|
1266
2106
|
}
|
|
2107
|
+
/**
|
|
2108
|
+
* Request parameters for refreshItem operation in LibraryApi.
|
|
2109
|
+
*/
|
|
2110
|
+
export interface LibraryApiRefreshItemRequest {
|
|
2111
|
+
/**
|
|
2112
|
+
* Item id.
|
|
2113
|
+
*/
|
|
2114
|
+
readonly itemId: string;
|
|
2115
|
+
/**
|
|
2116
|
+
* (Optional) Specifies the metadata refresh mode.
|
|
2117
|
+
*/
|
|
2118
|
+
readonly metadataRefreshMode?: MetadataRefreshMode;
|
|
2119
|
+
/**
|
|
2120
|
+
* (Optional) Specifies the image refresh mode.
|
|
2121
|
+
*/
|
|
2122
|
+
readonly imageRefreshMode?: MetadataRefreshMode;
|
|
2123
|
+
/**
|
|
2124
|
+
* (Optional) Determines if metadata should be replaced. Only applicable if mode is FullRefresh.
|
|
2125
|
+
*/
|
|
2126
|
+
readonly replaceAllMetadata?: boolean;
|
|
2127
|
+
/**
|
|
2128
|
+
* (Optional) Determines if images should be replaced. Only applicable if mode is FullRefresh.
|
|
2129
|
+
*/
|
|
2130
|
+
readonly replaceAllImages?: boolean;
|
|
2131
|
+
/**
|
|
2132
|
+
* (Optional) Determines if trickplay images should be replaced. Only applicable if mode is FullRefresh.
|
|
2133
|
+
*/
|
|
2134
|
+
readonly regenerateTrickplay?: boolean;
|
|
2135
|
+
}
|
|
1267
2136
|
/**
|
|
1268
2137
|
* LibraryApi - object-oriented interface
|
|
1269
|
-
* @export
|
|
1270
|
-
* @class LibraryApi
|
|
1271
|
-
* @extends {BaseAPI}
|
|
1272
2138
|
*/
|
|
1273
2139
|
export declare class LibraryApi extends BaseAPI {
|
|
1274
2140
|
/**
|
|
@@ -1277,7 +2143,6 @@ export declare class LibraryApi extends BaseAPI {
|
|
|
1277
2143
|
* @param {LibraryApiDeleteItemRequest} requestParameters Request parameters.
|
|
1278
2144
|
* @param {*} [options] Override http request option.
|
|
1279
2145
|
* @throws {RequiredError}
|
|
1280
|
-
* @memberof LibraryApi
|
|
1281
2146
|
*/
|
|
1282
2147
|
deleteItem(requestParameters: LibraryApiDeleteItemRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1283
2148
|
/**
|
|
@@ -1286,7 +2151,6 @@ export declare class LibraryApi extends BaseAPI {
|
|
|
1286
2151
|
* @param {LibraryApiDeleteItemsRequest} requestParameters Request parameters.
|
|
1287
2152
|
* @param {*} [options] Override http request option.
|
|
1288
2153
|
* @throws {RequiredError}
|
|
1289
|
-
* @memberof LibraryApi
|
|
1290
2154
|
*/
|
|
1291
2155
|
deleteItems(requestParameters?: LibraryApiDeleteItemsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1292
2156
|
/**
|
|
@@ -1295,26 +2159,14 @@ export declare class LibraryApi extends BaseAPI {
|
|
|
1295
2159
|
* @param {LibraryApiGetAncestorsRequest} requestParameters Request parameters.
|
|
1296
2160
|
* @param {*} [options] Override http request option.
|
|
1297
2161
|
* @throws {RequiredError}
|
|
1298
|
-
* @memberof LibraryApi
|
|
1299
2162
|
*/
|
|
1300
2163
|
getAncestors(requestParameters: LibraryApiGetAncestorsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDto[], any, {}>>;
|
|
1301
|
-
/**
|
|
1302
|
-
*
|
|
1303
|
-
* @summary Gets critic review for an item.
|
|
1304
|
-
* @param {LibraryApiGetCriticReviewsRequest} requestParameters Request parameters.
|
|
1305
|
-
* @param {*} [options] Override http request option.
|
|
1306
|
-
* @deprecated
|
|
1307
|
-
* @throws {RequiredError}
|
|
1308
|
-
* @memberof LibraryApi
|
|
1309
|
-
*/
|
|
1310
|
-
getCriticReviews(requestParameters: LibraryApiGetCriticReviewsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
|
|
1311
2164
|
/**
|
|
1312
2165
|
*
|
|
1313
2166
|
* @summary Downloads item media.
|
|
1314
2167
|
* @param {LibraryApiGetDownloadRequest} requestParameters Request parameters.
|
|
1315
2168
|
* @param {*} [options] Override http request option.
|
|
1316
2169
|
* @throws {RequiredError}
|
|
1317
|
-
* @memberof LibraryApi
|
|
1318
2170
|
*/
|
|
1319
2171
|
getDownload(requestParameters: LibraryApiGetDownloadRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
|
|
1320
2172
|
/**
|
|
@@ -1323,34 +2175,78 @@ export declare class LibraryApi extends BaseAPI {
|
|
|
1323
2175
|
* @param {LibraryApiGetFileRequest} requestParameters Request parameters.
|
|
1324
2176
|
* @param {*} [options] Override http request option.
|
|
1325
2177
|
* @throws {RequiredError}
|
|
1326
|
-
* @memberof LibraryApi
|
|
1327
2178
|
*/
|
|
1328
2179
|
getFile(requestParameters: LibraryApiGetFileRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
|
|
2180
|
+
/**
|
|
2181
|
+
*
|
|
2182
|
+
* @summary Gets intros to play before the main media item plays.
|
|
2183
|
+
* @param {LibraryApiGetIntrosRequest} requestParameters Request parameters.
|
|
2184
|
+
* @param {*} [options] Override http request option.
|
|
2185
|
+
* @throws {RequiredError}
|
|
2186
|
+
*/
|
|
2187
|
+
getIntros(requestParameters: LibraryApiGetIntrosRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
|
|
2188
|
+
/**
|
|
2189
|
+
*
|
|
2190
|
+
* @summary Gets an item from a user\'s library.
|
|
2191
|
+
* @param {LibraryApiGetItemRequest} requestParameters Request parameters.
|
|
2192
|
+
* @param {*} [options] Override http request option.
|
|
2193
|
+
* @throws {RequiredError}
|
|
2194
|
+
*/
|
|
2195
|
+
getItem(requestParameters: LibraryApiGetItemRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDto, any, {}>>;
|
|
2196
|
+
/**
|
|
2197
|
+
*
|
|
2198
|
+
* @summary Gets the collections that include the specified item.
|
|
2199
|
+
* @param {LibraryApiGetItemCollectionsRequest} requestParameters Request parameters.
|
|
2200
|
+
* @param {*} [options] Override http request option.
|
|
2201
|
+
* @throws {RequiredError}
|
|
2202
|
+
*/
|
|
2203
|
+
getItemCollections(requestParameters: LibraryApiGetItemCollectionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
|
|
1329
2204
|
/**
|
|
1330
2205
|
*
|
|
1331
2206
|
* @summary Get item counts.
|
|
1332
2207
|
* @param {LibraryApiGetItemCountsRequest} requestParameters Request parameters.
|
|
1333
2208
|
* @param {*} [options] Override http request option.
|
|
1334
2209
|
* @throws {RequiredError}
|
|
1335
|
-
* @memberof LibraryApi
|
|
1336
2210
|
*/
|
|
1337
2211
|
getItemCounts(requestParameters?: LibraryApiGetItemCountsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ItemCounts, any, {}>>;
|
|
2212
|
+
/**
|
|
2213
|
+
*
|
|
2214
|
+
* @summary Gets items based on a query.
|
|
2215
|
+
* @param {LibraryApiGetItemsRequest} requestParameters Request parameters.
|
|
2216
|
+
* @param {*} [options] Override http request option.
|
|
2217
|
+
* @throws {RequiredError}
|
|
2218
|
+
*/
|
|
2219
|
+
getItems(requestParameters?: LibraryApiGetItemsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
|
|
2220
|
+
/**
|
|
2221
|
+
*
|
|
2222
|
+
* @summary Gets latest media.
|
|
2223
|
+
* @param {LibraryApiGetLatestMediaRequest} requestParameters Request parameters.
|
|
2224
|
+
* @param {*} [options] Override http request option.
|
|
2225
|
+
* @throws {RequiredError}
|
|
2226
|
+
*/
|
|
2227
|
+
getLatestMedia(requestParameters?: LibraryApiGetLatestMediaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDto[], any, {}>>;
|
|
1338
2228
|
/**
|
|
1339
2229
|
*
|
|
1340
2230
|
* @summary Gets the library options info.
|
|
1341
2231
|
* @param {LibraryApiGetLibraryOptionsInfoRequest} requestParameters Request parameters.
|
|
1342
2232
|
* @param {*} [options] Override http request option.
|
|
1343
2233
|
* @throws {RequiredError}
|
|
1344
|
-
* @memberof LibraryApi
|
|
1345
2234
|
*/
|
|
1346
2235
|
getLibraryOptionsInfo(requestParameters?: LibraryApiGetLibraryOptionsInfoRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LibraryOptionsResultDto, any, {}>>;
|
|
2236
|
+
/**
|
|
2237
|
+
*
|
|
2238
|
+
* @summary Gets local trailers for an item.
|
|
2239
|
+
* @param {LibraryApiGetLocalTrailersRequest} requestParameters Request parameters.
|
|
2240
|
+
* @param {*} [options] Override http request option.
|
|
2241
|
+
* @throws {RequiredError}
|
|
2242
|
+
*/
|
|
2243
|
+
getLocalTrailers(requestParameters: LibraryApiGetLocalTrailersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDto[], any, {}>>;
|
|
1347
2244
|
/**
|
|
1348
2245
|
*
|
|
1349
2246
|
* @summary Gets all user media folders.
|
|
1350
2247
|
* @param {LibraryApiGetMediaFoldersRequest} requestParameters Request parameters.
|
|
1351
2248
|
* @param {*} [options] Override http request option.
|
|
1352
2249
|
* @throws {RequiredError}
|
|
1353
|
-
* @memberof LibraryApi
|
|
1354
2250
|
*/
|
|
1355
2251
|
getMediaFolders(requestParameters?: LibraryApiGetMediaFoldersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
|
|
1356
2252
|
/**
|
|
@@ -1358,16 +2254,30 @@ export declare class LibraryApi extends BaseAPI {
|
|
|
1358
2254
|
* @summary Gets a list of physical paths from virtual folders.
|
|
1359
2255
|
* @param {*} [options] Override http request option.
|
|
1360
2256
|
* @throws {RequiredError}
|
|
1361
|
-
* @memberof LibraryApi
|
|
1362
2257
|
*/
|
|
1363
2258
|
getPhysicalPaths(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any, {}>>;
|
|
2259
|
+
/**
|
|
2260
|
+
*
|
|
2261
|
+
* @summary Gets items based on a query.
|
|
2262
|
+
* @param {LibraryApiGetResumeItemsRequest} requestParameters Request parameters.
|
|
2263
|
+
* @param {*} [options] Override http request option.
|
|
2264
|
+
* @throws {RequiredError}
|
|
2265
|
+
*/
|
|
2266
|
+
getResumeItems(requestParameters?: LibraryApiGetResumeItemsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
|
|
2267
|
+
/**
|
|
2268
|
+
*
|
|
2269
|
+
* @summary Gets the root folder from a user\'s library.
|
|
2270
|
+
* @param {LibraryApiGetRootFolderRequest} requestParameters Request parameters.
|
|
2271
|
+
* @param {*} [options] Override http request option.
|
|
2272
|
+
* @throws {RequiredError}
|
|
2273
|
+
*/
|
|
2274
|
+
getRootFolder(requestParameters?: LibraryApiGetRootFolderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDto, any, {}>>;
|
|
1364
2275
|
/**
|
|
1365
2276
|
*
|
|
1366
2277
|
* @summary Gets similar items.
|
|
1367
2278
|
* @param {LibraryApiGetSimilarAlbumsRequest} requestParameters Request parameters.
|
|
1368
2279
|
* @param {*} [options] Override http request option.
|
|
1369
2280
|
* @throws {RequiredError}
|
|
1370
|
-
* @memberof LibraryApi
|
|
1371
2281
|
*/
|
|
1372
2282
|
getSimilarAlbums(requestParameters: LibraryApiGetSimilarAlbumsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
|
|
1373
2283
|
/**
|
|
@@ -1376,7 +2286,6 @@ export declare class LibraryApi extends BaseAPI {
|
|
|
1376
2286
|
* @param {LibraryApiGetSimilarArtistsRequest} requestParameters Request parameters.
|
|
1377
2287
|
* @param {*} [options] Override http request option.
|
|
1378
2288
|
* @throws {RequiredError}
|
|
1379
|
-
* @memberof LibraryApi
|
|
1380
2289
|
*/
|
|
1381
2290
|
getSimilarArtists(requestParameters: LibraryApiGetSimilarArtistsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
|
|
1382
2291
|
/**
|
|
@@ -1385,7 +2294,6 @@ export declare class LibraryApi extends BaseAPI {
|
|
|
1385
2294
|
* @param {LibraryApiGetSimilarItemsRequest} requestParameters Request parameters.
|
|
1386
2295
|
* @param {*} [options] Override http request option.
|
|
1387
2296
|
* @throws {RequiredError}
|
|
1388
|
-
* @memberof LibraryApi
|
|
1389
2297
|
*/
|
|
1390
2298
|
getSimilarItems(requestParameters: LibraryApiGetSimilarItemsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
|
|
1391
2299
|
/**
|
|
@@ -1394,7 +2302,6 @@ export declare class LibraryApi extends BaseAPI {
|
|
|
1394
2302
|
* @param {LibraryApiGetSimilarMoviesRequest} requestParameters Request parameters.
|
|
1395
2303
|
* @param {*} [options] Override http request option.
|
|
1396
2304
|
* @throws {RequiredError}
|
|
1397
|
-
* @memberof LibraryApi
|
|
1398
2305
|
*/
|
|
1399
2306
|
getSimilarMovies(requestParameters: LibraryApiGetSimilarMoviesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
|
|
1400
2307
|
/**
|
|
@@ -1403,7 +2310,6 @@ export declare class LibraryApi extends BaseAPI {
|
|
|
1403
2310
|
* @param {LibraryApiGetSimilarShowsRequest} requestParameters Request parameters.
|
|
1404
2311
|
* @param {*} [options] Override http request option.
|
|
1405
2312
|
* @throws {RequiredError}
|
|
1406
|
-
* @memberof LibraryApi
|
|
1407
2313
|
*/
|
|
1408
2314
|
getSimilarShows(requestParameters: LibraryApiGetSimilarShowsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
|
|
1409
2315
|
/**
|
|
@@ -1412,16 +2318,22 @@ export declare class LibraryApi extends BaseAPI {
|
|
|
1412
2318
|
* @param {LibraryApiGetSimilarTrailersRequest} requestParameters Request parameters.
|
|
1413
2319
|
* @param {*} [options] Override http request option.
|
|
1414
2320
|
* @throws {RequiredError}
|
|
1415
|
-
* @memberof LibraryApi
|
|
1416
2321
|
*/
|
|
1417
2322
|
getSimilarTrailers(requestParameters: LibraryApiGetSimilarTrailersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
|
|
2323
|
+
/**
|
|
2324
|
+
*
|
|
2325
|
+
* @summary Gets special features for an item.
|
|
2326
|
+
* @param {LibraryApiGetSpecialFeaturesRequest} requestParameters Request parameters.
|
|
2327
|
+
* @param {*} [options] Override http request option.
|
|
2328
|
+
* @throws {RequiredError}
|
|
2329
|
+
*/
|
|
2330
|
+
getSpecialFeatures(requestParameters: LibraryApiGetSpecialFeaturesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDto[], any, {}>>;
|
|
1418
2331
|
/**
|
|
1419
2332
|
*
|
|
1420
2333
|
* @summary Get theme songs and videos for an item.
|
|
1421
2334
|
* @param {LibraryApiGetThemeMediaRequest} requestParameters Request parameters.
|
|
1422
2335
|
* @param {*} [options] Override http request option.
|
|
1423
2336
|
* @throws {RequiredError}
|
|
1424
|
-
* @memberof LibraryApi
|
|
1425
2337
|
*/
|
|
1426
2338
|
getThemeMedia(requestParameters: LibraryApiGetThemeMediaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AllThemeMediaResult, any, {}>>;
|
|
1427
2339
|
/**
|
|
@@ -1430,7 +2342,6 @@ export declare class LibraryApi extends BaseAPI {
|
|
|
1430
2342
|
* @param {LibraryApiGetThemeSongsRequest} requestParameters Request parameters.
|
|
1431
2343
|
* @param {*} [options] Override http request option.
|
|
1432
2344
|
* @throws {RequiredError}
|
|
1433
|
-
* @memberof LibraryApi
|
|
1434
2345
|
*/
|
|
1435
2346
|
getThemeSongs(requestParameters: LibraryApiGetThemeSongsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ThemeMediaResult, any, {}>>;
|
|
1436
2347
|
/**
|
|
@@ -1439,7 +2350,6 @@ export declare class LibraryApi extends BaseAPI {
|
|
|
1439
2350
|
* @param {LibraryApiGetThemeVideosRequest} requestParameters Request parameters.
|
|
1440
2351
|
* @param {*} [options] Override http request option.
|
|
1441
2352
|
* @throws {RequiredError}
|
|
1442
|
-
* @memberof LibraryApi
|
|
1443
2353
|
*/
|
|
1444
2354
|
getThemeVideos(requestParameters: LibraryApiGetThemeVideosRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ThemeMediaResult, any, {}>>;
|
|
1445
2355
|
/**
|
|
@@ -1448,7 +2358,6 @@ export declare class LibraryApi extends BaseAPI {
|
|
|
1448
2358
|
* @param {LibraryApiPostAddedMoviesRequest} requestParameters Request parameters.
|
|
1449
2359
|
* @param {*} [options] Override http request option.
|
|
1450
2360
|
* @throws {RequiredError}
|
|
1451
|
-
* @memberof LibraryApi
|
|
1452
2361
|
*/
|
|
1453
2362
|
postAddedMovies(requestParameters?: LibraryApiPostAddedMoviesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1454
2363
|
/**
|
|
@@ -1457,7 +2366,6 @@ export declare class LibraryApi extends BaseAPI {
|
|
|
1457
2366
|
* @param {LibraryApiPostAddedSeriesRequest} requestParameters Request parameters.
|
|
1458
2367
|
* @param {*} [options] Override http request option.
|
|
1459
2368
|
* @throws {RequiredError}
|
|
1460
|
-
* @memberof LibraryApi
|
|
1461
2369
|
*/
|
|
1462
2370
|
postAddedSeries(requestParameters?: LibraryApiPostAddedSeriesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1463
2371
|
/**
|
|
@@ -1466,7 +2374,6 @@ export declare class LibraryApi extends BaseAPI {
|
|
|
1466
2374
|
* @param {LibraryApiPostUpdatedMediaRequest} requestParameters Request parameters.
|
|
1467
2375
|
* @param {*} [options] Override http request option.
|
|
1468
2376
|
* @throws {RequiredError}
|
|
1469
|
-
* @memberof LibraryApi
|
|
1470
2377
|
*/
|
|
1471
2378
|
postUpdatedMedia(requestParameters: LibraryApiPostUpdatedMediaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1472
2379
|
/**
|
|
@@ -1475,7 +2382,6 @@ export declare class LibraryApi extends BaseAPI {
|
|
|
1475
2382
|
* @param {LibraryApiPostUpdatedMoviesRequest} requestParameters Request parameters.
|
|
1476
2383
|
* @param {*} [options] Override http request option.
|
|
1477
2384
|
* @throws {RequiredError}
|
|
1478
|
-
* @memberof LibraryApi
|
|
1479
2385
|
*/
|
|
1480
2386
|
postUpdatedMovies(requestParameters?: LibraryApiPostUpdatedMoviesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1481
2387
|
/**
|
|
@@ -1484,15 +2390,21 @@ export declare class LibraryApi extends BaseAPI {
|
|
|
1484
2390
|
* @param {LibraryApiPostUpdatedSeriesRequest} requestParameters Request parameters.
|
|
1485
2391
|
* @param {*} [options] Override http request option.
|
|
1486
2392
|
* @throws {RequiredError}
|
|
1487
|
-
* @memberof LibraryApi
|
|
1488
2393
|
*/
|
|
1489
2394
|
postUpdatedSeries(requestParameters?: LibraryApiPostUpdatedSeriesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
2395
|
+
/**
|
|
2396
|
+
*
|
|
2397
|
+
* @summary Refreshes metadata for an item.
|
|
2398
|
+
* @param {LibraryApiRefreshItemRequest} requestParameters Request parameters.
|
|
2399
|
+
* @param {*} [options] Override http request option.
|
|
2400
|
+
* @throws {RequiredError}
|
|
2401
|
+
*/
|
|
2402
|
+
refreshItem(requestParameters: LibraryApiRefreshItemRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1490
2403
|
/**
|
|
1491
2404
|
*
|
|
1492
2405
|
* @summary Starts a library scan.
|
|
1493
2406
|
* @param {*} [options] Override http request option.
|
|
1494
2407
|
* @throws {RequiredError}
|
|
1495
|
-
* @memberof LibraryApi
|
|
1496
2408
|
*/
|
|
1497
2409
|
refreshLibrary(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1498
2410
|
}
|