diff --git a/openapi.json b/openapi.json index 2f9c87c8..506b813d 100644 --- a/openapi.json +++ b/openapi.json @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:0ef41c6408992817d9a3be00aa0266ba19b92757fb51f48c8d5332a08bf5e4b3 -size 853085 +oid sha256:fd06ef9c4b4d7071278563d5843a7f02834390f155ea5309ca13d06817c74b38 +size 850061 diff --git a/src/generated-client/.openapi-generator/FILES b/src/generated-client/.openapi-generator/FILES index a4754b2d..7cf44a98 100644 --- a/src/generated-client/.openapi-generator/FILES +++ b/src/generated-client/.openapi-generator/FILES @@ -13,15 +13,12 @@ api/configuration-api.ts api/dashboard-api.ts api/devices-api.ts api/display-preferences-api.ts -api/dlna-api.ts -api/dlna-server-api.ts api/dynamic-hls-api.ts api/environment-api.ts api/filter-api.ts api/genres-api.ts api/hls-segment-api.ts api/image-api.ts -api/image-by-name-api.ts api/instant-mix-api.ts api/item-lookup-api.ts api/item-refresh-api.ts @@ -31,10 +28,10 @@ api/library-api.ts api/library-structure-api.ts api/live-tv-api.ts api/localization-api.ts +api/lyrics-api.ts api/media-info-api.ts api/movies-api.ts api/music-genres-api.ts -api/notifications-api.ts api/package-api.ts api/persons-api.ts api/playlists-api.ts @@ -54,6 +51,7 @@ api/system-api.ts api/time-sync-api.ts api/tmdb-api.ts api/trailers-api.ts +api/trickplay-api.ts api/tv-shows-api.ts api/universal-audio-api.ts api/user-api.ts @@ -68,16 +66,18 @@ configuration.ts git_push.sh index.ts models/access-schedule.ts +models/activity-log-entry-message.ts models/activity-log-entry-query-result.ts +models/activity-log-entry-start-message.ts +models/activity-log-entry-stop-message.ts models/activity-log-entry.ts models/add-virtual-folder-dto.ts -models/admin-notification-dto.ts models/album-info-remote-search-query.ts models/album-info.ts models/all-theme-media-result.ts -models/architecture.ts models/artist-info-remote-search-query.ts models/artist-info.ts +models/audio-spatial-format.ts models/authenticate-user-by-name.ts models/authentication-info-query-result.ts models/authentication-info.ts @@ -88,13 +88,13 @@ models/base-item-dto.ts models/base-item-kind.ts models/base-item-person-image-blur-hashes.ts models/base-item-person.ts -models/base-item.ts models/book-info-remote-search-query.ts models/book-info.ts models/box-set-info-remote-search-query.ts models/box-set-info.ts models/branding-options.ts models/buffer-request-dto.ts +models/cast-receiver-application.ts models/channel-features.ts models/channel-item-sort-field.ts models/channel-mapping-options-dto.ts @@ -109,10 +109,10 @@ models/codec-profile.ts models/codec-type.ts models/collection-creation-result.ts models/collection-type-options.ts +models/collection-type.ts models/config-image-types.ts models/configuration-page-info.ts models/container-profile.ts -models/control-response.ts models/country-info.ts models/create-playlist-dto.ts models/create-user-by-name.ts @@ -120,18 +120,15 @@ models/culture-dto.ts models/day-of-week.ts models/day-pattern.ts models/default-directory-browser-info-dto.ts -models/device-identification.ts models/device-info-query-result.ts models/device-info.ts models/device-options-dto.ts models/device-options.ts -models/device-profile-info.ts -models/device-profile-type.ts models/device-profile.ts models/direct-play-profile.ts models/display-preferences-dto.ts -models/dlna-options.ts models/dlna-profile-type.ts +models/down-mix-stereo-algorithms.ts models/dynamic-day-of-week.ts models/embedded-subtitle-options.ts models/encoding-context.ts @@ -140,36 +137,42 @@ models/end-point-info.ts models/external-id-info.ts models/external-id-media-type.ts models/external-url.ts -models/ffmpeg-location.ts +models/extra-type.ts models/file-system-entry-info.ts models/file-system-entry-type.ts models/font-file.ts +models/force-keep-alive-message.ts models/forgot-password-action.ts models/forgot-password-dto.ts models/forgot-password-pin-dto.ts models/forgot-password-result.ts +models/general-command-message.ts models/general-command-type.ts models/general-command.ts models/get-programs-dto.ts +models/group-info-dto-group-update.ts models/group-info-dto.ts models/group-queue-mode.ts models/group-repeat-mode.ts models/group-shuffle-mode.ts models/group-state-type.ts +models/group-state-update-group-update.ts +models/group-state-update.ts models/group-update-type.ts +models/group-update.ts models/guide-info.ts models/hardware-encoding-type.ts -models/header-match-type.ts -models/http-header-info.ts models/ignore-wait-request-dto.ts -models/image-by-name-info.ts models/image-format.ts models/image-info.ts models/image-option.ts models/image-orientation.ts models/image-provider-info.ts +models/image-resolution.ts models/image-saving-convention.ts models/image-type.ts +models/inbound-keep-alive-message.ts +models/inbound-web-socket-message.ts models/index.ts models/installation-info.ts models/iplugin.ts @@ -177,8 +180,10 @@ models/iso-type.ts models/item-counts.ts models/item-fields.ts models/item-filter.ts +models/item-sort-by.ts models/join-group-request-dto.ts models/keep-until.ts +models/library-changed-message.ts models/library-option-info-dto.ts models/library-options-result-dto.ts models/library-options.ts @@ -194,15 +199,19 @@ models/localization-option.ts models/location-type.ts models/log-file.ts models/log-level.ts +models/lyric-dto.ts +models/lyric-line.ts +models/lyric-metadata.ts models/media-attachment.ts -models/media-encoder-path-dto.ts models/media-path-dto.ts models/media-path-info.ts models/media-protocol.ts models/media-source-info.ts models/media-source-type.ts +models/media-stream-protocol.ts models/media-stream-type.ts models/media-stream.ts +models/media-type.ts models/media-update-info-dto.ts models/media-update-info-path-dto.ts models/media-url.ts @@ -223,41 +232,50 @@ models/name-value-pair.ts models/network-configuration.ts models/new-group-request-dto.ts models/next-item-request-dto.ts -models/notification-dto.ts -models/notification-level.ts -models/notification-option.ts -models/notification-options.ts -models/notification-result-dto.ts -models/notification-type-info.ts -models/notifications-summary-dto.ts -models/object-group-update.ts models/open-live-stream-dto.ts +models/outbound-keep-alive-message.ts +models/outbound-web-socket-message.ts models/package-info.ts models/parental-rating.ts models/path-substitution.ts +models/person-kind.ts models/person-lookup-info-remote-search-query.ts models/person-lookup-info.ts models/pin-redeem-result.ts models/ping-request-dto.ts models/play-access.ts models/play-command.ts +models/play-message.ts models/play-method.ts +models/play-queue-update-group-update.ts +models/play-queue-update-reason.ts +models/play-queue-update.ts models/play-request-dto.ts models/play-request.ts models/playback-error-code.ts models/playback-info-dto.ts models/playback-info-response.ts +models/playback-order.ts models/playback-progress-info.ts +models/playback-request-type.ts models/playback-start-info.ts models/playback-stop-info.ts models/player-state-info.ts models/playlist-creation-result.ts +models/playlist-user-permissions.ts models/playstate-command.ts +models/playstate-message.ts models/playstate-request.ts models/plugin-info.ts +models/plugin-installation-cancelled-message.ts +models/plugin-installation-completed-message.ts +models/plugin-installation-failed-message.ts +models/plugin-installing-message.ts models/plugin-status.ts +models/plugin-uninstalled-message.ts models/previous-item-request-dto.ts models/problem-details.ts +models/process-priority-class.ts models/profile-condition-type.ts models/profile-condition-value.ts models/profile-condition.ts @@ -274,31 +292,43 @@ models/ready-request-dto.ts models/recommendation-dto.ts models/recommendation-type.ts models/recording-status.ts +models/refresh-progress-message.ts models/remote-image-info.ts models/remote-image-result.ts +models/remote-lyric-info-dto.ts models/remote-search-result.ts models/remote-subtitle-info.ts models/remove-from-playlist-request-dto.ts models/repeat-mode.ts models/repository-info.ts -models/response-profile.ts +models/restart-required-message.ts +models/scheduled-task-ended-message.ts +models/scheduled-tasks-info-message.ts +models/scheduled-tasks-info-start-message.ts +models/scheduled-tasks-info-stop-message.ts models/scroll-direction.ts models/search-hint-result.ts models/search-hint.ts models/seek-request-dto.ts models/send-command-type.ts models/send-command.ts -models/send-to-user-type.ts models/series-info-remote-search-query.ts models/series-info.ts models/series-status.ts +models/series-timer-cancelled-message.ts +models/series-timer-created-message.ts models/series-timer-info-dto-query-result.ts models/series-timer-info-dto.ts models/server-configuration.ts models/server-discovery-info.ts +models/server-restarting-message.ts +models/server-shutting-down-message.ts models/session-info.ts models/session-message-type.ts models/session-user-info.ts +models/sessions-message.ts +models/sessions-start-message.ts +models/sessions-stop-message.ts models/set-channel-mapping-dto.ts models/set-playlist-item-request-dto.ts models/set-repeat-mode-request-dto.ts @@ -309,10 +339,14 @@ models/special-view-option-dto.ts models/startup-configuration-dto.ts models/startup-remote-access-dto.ts models/startup-user-dto.ts +models/string-group-update.ts models/subtitle-delivery-method.ts models/subtitle-options.ts models/subtitle-playback-mode.ts models/subtitle-profile.ts +models/sync-play-command-message.ts +models/sync-play-group-update-command-message.ts +models/sync-play-queue-item.ts models/sync-play-user-access-type.ts models/system-info.ts models/task-completion-status.ts @@ -321,6 +355,8 @@ models/task-result.ts models/task-state.ts models/task-trigger-info.ts models/theme-media-result.ts +models/timer-cancelled-message.ts +models/timer-created-message.ts models/timer-event-info.ts models/timer-info-dto-query-result.ts models/timer-info-dto.ts @@ -331,25 +367,36 @@ models/transcode-seek-info.ts models/transcoding-info.ts models/transcoding-profile.ts models/transport-stream-timestamp.ts +models/trickplay-info.ts +models/trickplay-options.ts +models/trickplay-scan-behavior.ts models/tuner-channel-mapping.ts models/tuner-host-info.ts models/type-options.ts models/unrated-item.ts models/update-library-options-dto.ts models/update-media-path-request-dto.ts -models/update-user-easy-password.ts +models/update-playlist-dto.ts +models/update-playlist-user-dto.ts +models/update-user-item-data-dto.ts models/update-user-password.ts models/upload-subtitle-dto.ts models/user-configuration.ts +models/user-data-change-info.ts +models/user-data-changed-message.ts +models/user-deleted-message.ts models/user-dto.ts models/user-item-data-dto.ts models/user-policy.ts +models/user-updated-message.ts models/utc-time-response.ts models/validate-path-dto.ts models/version-info.ts +models/video-range-type.ts +models/video-range.ts models/video-type.ts models/video3-dformat.ts models/virtual-folder-info.ts models/wake-on-lan-info.ts +models/web-socket-message.ts models/xbmc-metadata-options.ts -models/xml-attribute.ts diff --git a/src/generated-client/api.ts b/src/generated-client/api.ts index 8133e6c6..79e873cc 100644 --- a/src/generated-client/api.ts +++ b/src/generated-client/api.ts @@ -25,15 +25,12 @@ export * from './api/configuration-api'; export * from './api/dashboard-api'; export * from './api/devices-api'; export * from './api/display-preferences-api'; -export * from './api/dlna-api'; -export * from './api/dlna-server-api'; export * from './api/dynamic-hls-api'; export * from './api/environment-api'; export * from './api/filter-api'; export * from './api/genres-api'; export * from './api/hls-segment-api'; export * from './api/image-api'; -export * from './api/image-by-name-api'; export * from './api/instant-mix-api'; export * from './api/item-lookup-api'; export * from './api/item-refresh-api'; @@ -43,10 +40,10 @@ export * from './api/library-api'; export * from './api/library-structure-api'; export * from './api/live-tv-api'; export * from './api/localization-api'; +export * from './api/lyrics-api'; export * from './api/media-info-api'; export * from './api/movies-api'; export * from './api/music-genres-api'; -export * from './api/notifications-api'; export * from './api/package-api'; export * from './api/persons-api'; export * from './api/playlists-api'; @@ -66,6 +63,7 @@ export * from './api/system-api'; export * from './api/time-sync-api'; export * from './api/tmdb-api'; export * from './api/trailers-api'; +export * from './api/trickplay-api'; export * from './api/tv-shows-api'; export * from './api/universal-audio-api'; export * from './api/user-api'; diff --git a/src/generated-client/api/artists-api.ts b/src/generated-client/api/artists-api.ts index f2d24bf1..669cc16d 100644 --- a/src/generated-client/api/artists-api.ts +++ b/src/generated-client/api/artists-api.ts @@ -32,6 +32,10 @@ import { ItemFields } from '../models'; // @ts-ignore import { ItemFilter } from '../models'; // @ts-ignore +import { ItemSortBy } from '../models'; +// @ts-ignore +import { MediaType } from '../models'; +// @ts-ignore import { SortOrder } from '../models'; /** * ArtistsApi - axios parameter creator @@ -52,7 +56,7 @@ export const ArtistsApiAxiosParamCreator = function (configuration?: Configurati * @param {Array} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. * @param {Array} [filters] Optional. Specify additional filters to apply. * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not. - * @param {Array} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited. + * @param {Array} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited. * @param {Array} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. * @param {Array} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. * @param {Array} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. @@ -70,14 +74,14 @@ export const ArtistsApiAxiosParamCreator = function (configuration?: Configurati * @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string. * @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string. * @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string. - * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. + * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. * @param {Array} [sortOrder] Sort Order - Ascending,Descending. * @param {boolean} [enableImages] Optional, include image information in output. * @param {boolean} [enableTotalRecordCount] Total record count. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getAlbumArtists: async (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, filters?: Array, isFavorite?: boolean, mediaTypes?: Array, genres?: Array, genreIds?: Array, officialRatings?: Array, tags?: Array, years?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, person?: string, personIds?: Array, personTypes?: Array, studios?: Array, studioIds?: Array, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array, sortOrder?: Array, enableImages?: boolean, enableTotalRecordCount?: boolean, options: AxiosRequestConfig = {}): Promise => { + getAlbumArtists: async (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, filters?: Array, isFavorite?: boolean, mediaTypes?: Array, genres?: Array, genreIds?: Array, officialRatings?: Array, tags?: Array, years?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, person?: string, personIds?: Array, personTypes?: Array, studios?: Array, studioIds?: Array, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array, sortOrder?: Array, enableImages?: boolean, enableTotalRecordCount?: boolean, options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/Artists/AlbumArtists`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -287,7 +291,7 @@ export const ArtistsApiAxiosParamCreator = function (configuration?: Configurati * @param {Array} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. * @param {Array} [filters] Optional. Specify additional filters to apply. * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not. - * @param {Array} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited. + * @param {Array} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited. * @param {Array} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. * @param {Array} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. * @param {Array} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. @@ -305,14 +309,14 @@ export const ArtistsApiAxiosParamCreator = function (configuration?: Configurati * @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string. * @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string. * @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string. - * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. + * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. * @param {Array} [sortOrder] Sort Order - Ascending,Descending. * @param {boolean} [enableImages] Optional, include image information in output. * @param {boolean} [enableTotalRecordCount] Total record count. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getArtists: async (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, filters?: Array, isFavorite?: boolean, mediaTypes?: Array, genres?: Array, genreIds?: Array, officialRatings?: Array, tags?: Array, years?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, person?: string, personIds?: Array, personTypes?: Array, studios?: Array, studioIds?: Array, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array, sortOrder?: Array, enableImages?: boolean, enableTotalRecordCount?: boolean, options: AxiosRequestConfig = {}): Promise => { + getArtists: async (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, filters?: Array, isFavorite?: boolean, mediaTypes?: Array, genres?: Array, genreIds?: Array, officialRatings?: Array, tags?: Array, years?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, person?: string, personIds?: Array, personTypes?: Array, studios?: Array, studioIds?: Array, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array, sortOrder?: Array, enableImages?: boolean, enableTotalRecordCount?: boolean, options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/Artists`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -490,7 +494,7 @@ export const ArtistsApiFp = function(configuration?: Configuration) { * @param {Array} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. * @param {Array} [filters] Optional. Specify additional filters to apply. * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not. - * @param {Array} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited. + * @param {Array} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited. * @param {Array} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. * @param {Array} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. * @param {Array} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. @@ -508,14 +512,14 @@ export const ArtistsApiFp = function(configuration?: Configuration) { * @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string. * @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string. * @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string. - * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. + * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. * @param {Array} [sortOrder] Sort Order - Ascending,Descending. * @param {boolean} [enableImages] Optional, include image information in output. * @param {boolean} [enableTotalRecordCount] Total record count. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getAlbumArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, filters?: Array, isFavorite?: boolean, mediaTypes?: Array, genres?: Array, genreIds?: Array, officialRatings?: Array, tags?: Array, years?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, person?: string, personIds?: Array, personTypes?: Array, studios?: Array, studioIds?: Array, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array, sortOrder?: Array, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getAlbumArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, filters?: Array, isFavorite?: boolean, mediaTypes?: Array, genres?: Array, genreIds?: Array, officialRatings?: Array, tags?: Array, years?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, person?: string, personIds?: Array, personTypes?: Array, studios?: Array, studioIds?: Array, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array, sortOrder?: Array, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getAlbumArtists(minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -544,7 +548,7 @@ export const ArtistsApiFp = function(configuration?: Configuration) { * @param {Array} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. * @param {Array} [filters] Optional. Specify additional filters to apply. * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not. - * @param {Array} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited. + * @param {Array} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited. * @param {Array} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. * @param {Array} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. * @param {Array} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. @@ -562,14 +566,14 @@ export const ArtistsApiFp = function(configuration?: Configuration) { * @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string. * @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string. * @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string. - * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. + * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. * @param {Array} [sortOrder] Sort Order - Ascending,Descending. * @param {boolean} [enableImages] Optional, include image information in output. * @param {boolean} [enableTotalRecordCount] Total record count. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, filters?: Array, isFavorite?: boolean, mediaTypes?: Array, genres?: Array, genreIds?: Array, officialRatings?: Array, tags?: Array, years?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, person?: string, personIds?: Array, personTypes?: Array, studios?: Array, studioIds?: Array, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array, sortOrder?: Array, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, filters?: Array, isFavorite?: boolean, mediaTypes?: Array, genres?: Array, genreIds?: Array, officialRatings?: Array, tags?: Array, years?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, person?: string, personIds?: Array, personTypes?: Array, studios?: Array, studioIds?: Array, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array, sortOrder?: Array, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getArtists(minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -596,7 +600,7 @@ export const ArtistsApiFactory = function (configuration?: Configuration, basePa * @param {Array} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. * @param {Array} [filters] Optional. Specify additional filters to apply. * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not. - * @param {Array} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited. + * @param {Array} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited. * @param {Array} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. * @param {Array} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. * @param {Array} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. @@ -614,14 +618,14 @@ export const ArtistsApiFactory = function (configuration?: Configuration, basePa * @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string. * @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string. * @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string. - * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. + * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. * @param {Array} [sortOrder] Sort Order - Ascending,Descending. * @param {boolean} [enableImages] Optional, include image information in output. * @param {boolean} [enableTotalRecordCount] Total record count. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getAlbumArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, filters?: Array, isFavorite?: boolean, mediaTypes?: Array, genres?: Array, genreIds?: Array, officialRatings?: Array, tags?: Array, years?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, person?: string, personIds?: Array, personTypes?: Array, studios?: Array, studioIds?: Array, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array, sortOrder?: Array, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise { + getAlbumArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, filters?: Array, isFavorite?: boolean, mediaTypes?: Array, genres?: Array, genreIds?: Array, officialRatings?: Array, tags?: Array, years?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, person?: string, personIds?: Array, personTypes?: Array, studios?: Array, studioIds?: Array, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array, sortOrder?: Array, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise { return localVarFp.getAlbumArtists(minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, options).then((request) => request(axios, basePath)); }, /** @@ -648,7 +652,7 @@ export const ArtistsApiFactory = function (configuration?: Configuration, basePa * @param {Array} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. * @param {Array} [filters] Optional. Specify additional filters to apply. * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not. - * @param {Array} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited. + * @param {Array} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited. * @param {Array} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. * @param {Array} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. * @param {Array} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. @@ -666,14 +670,14 @@ export const ArtistsApiFactory = function (configuration?: Configuration, basePa * @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string. * @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string. * @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string. - * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. + * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. * @param {Array} [sortOrder] Sort Order - Ascending,Descending. * @param {boolean} [enableImages] Optional, include image information in output. * @param {boolean} [enableTotalRecordCount] Total record count. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, filters?: Array, isFavorite?: boolean, mediaTypes?: Array, genres?: Array, genreIds?: Array, officialRatings?: Array, tags?: Array, years?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, person?: string, personIds?: Array, personTypes?: Array, studios?: Array, studioIds?: Array, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array, sortOrder?: Array, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise { + getArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, filters?: Array, isFavorite?: boolean, mediaTypes?: Array, genres?: Array, genreIds?: Array, officialRatings?: Array, tags?: Array, years?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, person?: string, personIds?: Array, personTypes?: Array, studios?: Array, studioIds?: Array, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array, sortOrder?: Array, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise { return localVarFp.getArtists(minCommunityRating, startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, genres, genreIds, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, studioIds, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, options).then((request) => request(axios, basePath)); }, }; @@ -757,10 +761,10 @@ export interface ArtistsApiGetAlbumArtistsRequest { /** * Optional filter by MediaType. Allows multiple, comma delimited. - * @type {Array} + * @type {Array} * @memberof ArtistsApiGetAlbumArtists */ - readonly mediaTypes?: Array + readonly mediaTypes?: Array /** * Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. @@ -883,10 +887,10 @@ export interface ArtistsApiGetAlbumArtistsRequest { /** * Optional. Specify one or more sort orders, comma delimited. - * @type {Array} + * @type {Array} * @memberof ArtistsApiGetAlbumArtists */ - readonly sortBy?: Array + readonly sortBy?: Array /** * Sort Order - Ascending,Descending. @@ -1009,10 +1013,10 @@ export interface ArtistsApiGetArtistsRequest { /** * Optional filter by MediaType. Allows multiple, comma delimited. - * @type {Array} + * @type {Array} * @memberof ArtistsApiGetArtists */ - readonly mediaTypes?: Array + readonly mediaTypes?: Array /** * Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. @@ -1135,10 +1139,10 @@ export interface ArtistsApiGetArtistsRequest { /** * Optional. Specify one or more sort orders, comma delimited. - * @type {Array} + * @type {Array} * @memberof ArtistsApiGetArtists */ - readonly sortBy?: Array + readonly sortBy?: Array /** * Sort Order - Ascending,Descending. diff --git a/src/generated-client/api/audio-api.ts b/src/generated-client/api/audio-api.ts index 341122b2..32c4b697 100644 --- a/src/generated-client/api/audio-api.ts +++ b/src/generated-client/api/audio-api.ts @@ -314,7 +314,7 @@ export const AudioApiAxiosParamCreator = function (configuration?: Configuration * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize. * @param {string} [playSessionId] The play session id. * @param {string} [segmentContainer] The segment container. - * @param {number} [segmentLength] The segment lenght. + * @param {number} [segmentLength] The segment length. * @param {number} [minSegments] The minimum number of segments. * @param {string} [mediaSourceId] The media version id, if playing an alternate version. * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed. @@ -861,7 +861,7 @@ export const AudioApiAxiosParamCreator = function (configuration?: Configuration * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize. * @param {string} [playSessionId] The play session id. * @param {string} [segmentContainer] The segment container. - * @param {number} [segmentLength] The segment lenght. + * @param {number} [segmentLength] The segment length. * @param {number} [minSegments] The minimum number of segments. * @param {string} [mediaSourceId] The media version id, if playing an alternate version. * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed. @@ -1203,7 +1203,7 @@ export const AudioApiFp = function(configuration?: Configuration) { * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize. * @param {string} [playSessionId] The play session id. * @param {string} [segmentContainer] The segment container. - * @param {number} [segmentLength] The segment lenght. + * @param {number} [segmentLength] The segment length. * @param {number} [minSegments] The minimum number of segments. * @param {string} [mediaSourceId] The media version id, if playing an alternate version. * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed. @@ -1321,7 +1321,7 @@ export const AudioApiFp = function(configuration?: Configuration) { * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize. * @param {string} [playSessionId] The play session id. * @param {string} [segmentContainer] The segment container. - * @param {number} [segmentLength] The segment lenght. + * @param {number} [segmentLength] The segment length. * @param {number} [minSegments] The minimum number of segments. * @param {string} [mediaSourceId] The media version id, if playing an alternate version. * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed. @@ -1448,7 +1448,7 @@ export const AudioApiFactory = function (configuration?: Configuration, basePath * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize. * @param {string} [playSessionId] The play session id. * @param {string} [segmentContainer] The segment container. - * @param {number} [segmentLength] The segment lenght. + * @param {number} [segmentLength] The segment length. * @param {number} [minSegments] The minimum number of segments. * @param {string} [mediaSourceId] The media version id, if playing an alternate version. * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed. @@ -1564,7 +1564,7 @@ export const AudioApiFactory = function (configuration?: Configuration, basePath * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize. * @param {string} [playSessionId] The play session id. * @param {string} [segmentContainer] The segment container. - * @param {number} [segmentLength] The segment lenght. + * @param {number} [segmentLength] The segment length. * @param {number} [minSegments] The minimum number of segments. * @param {string} [mediaSourceId] The media version id, if playing an alternate version. * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed. @@ -2027,7 +2027,7 @@ export interface AudioApiGetAudioStreamByContainerRequest { readonly segmentContainer?: string /** - * The segment lenght. + * The segment length. * @type {number} * @memberof AudioApiGetAudioStreamByContainer */ @@ -2727,7 +2727,7 @@ export interface AudioApiHeadAudioStreamByContainerRequest { readonly segmentContainer?: string /** - * The segment lenght. + * The segment length. * @type {number} * @memberof AudioApiHeadAudioStreamByContainer */ diff --git a/src/generated-client/api/channels-api.ts b/src/generated-client/api/channels-api.ts index 0eeaa707..d1a3ee02 100644 --- a/src/generated-client/api/channels-api.ts +++ b/src/generated-client/api/channels-api.ts @@ -28,6 +28,8 @@ import { ItemFields } from '../models'; // @ts-ignore import { ItemFilter } from '../models'; // @ts-ignore +import { ItemSortBy } from '../models'; +// @ts-ignore import { SortOrder } from '../models'; /** * ChannelsApi - axios parameter creator @@ -115,12 +117,12 @@ export const ChannelsApiAxiosParamCreator = function (configuration?: Configurat * @param {number} [limit] Optional. The maximum number of records to return. * @param {Array} [sortOrder] Optional. Sort Order - Ascending,Descending. * @param {Array} [filters] Optional. Specify additional filters to apply. - * @param {Array} [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. + * @param {Array} [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. * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getChannelItems: async (channelId: string, folderId?: string, userId?: string, startIndex?: number, limit?: number, sortOrder?: Array, filters?: Array, sortBy?: Array, fields?: Array, options: AxiosRequestConfig = {}): Promise => { + getChannelItems: async (channelId: string, folderId?: string, userId?: string, startIndex?: number, limit?: number, sortOrder?: Array, filters?: Array, sortBy?: Array, fields?: Array, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'channelId' is not null or undefined assertParamExists('getChannelItems', 'channelId', channelId) const localVarPath = `/Channels/{channelId}/Items` @@ -349,12 +351,12 @@ export const ChannelsApiFp = function(configuration?: Configuration) { * @param {number} [limit] Optional. The maximum number of records to return. * @param {Array} [sortOrder] Optional. Sort Order - Ascending,Descending. * @param {Array} [filters] Optional. Specify additional filters to apply. - * @param {Array} [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. + * @param {Array} [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. * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getChannelItems(channelId: string, folderId?: string, userId?: string, startIndex?: number, limit?: number, sortOrder?: Array, filters?: Array, sortBy?: Array, fields?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getChannelItems(channelId: string, folderId?: string, userId?: string, startIndex?: number, limit?: number, sortOrder?: Array, filters?: Array, sortBy?: Array, fields?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getChannelItems(channelId, folderId, userId, startIndex, limit, sortOrder, filters, sortBy, fields, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -429,12 +431,12 @@ export const ChannelsApiFactory = function (configuration?: Configuration, baseP * @param {number} [limit] Optional. The maximum number of records to return. * @param {Array} [sortOrder] Optional. Sort Order - Ascending,Descending. * @param {Array} [filters] Optional. Specify additional filters to apply. - * @param {Array} [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. + * @param {Array} [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. * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getChannelItems(channelId: string, folderId?: string, userId?: string, startIndex?: number, limit?: number, sortOrder?: Array, filters?: Array, sortBy?: Array, fields?: Array, options?: any): AxiosPromise { + getChannelItems(channelId: string, folderId?: string, userId?: string, startIndex?: number, limit?: number, sortOrder?: Array, filters?: Array, sortBy?: Array, fields?: Array, options?: any): AxiosPromise { return localVarFp.getChannelItems(channelId, folderId, userId, startIndex, limit, sortOrder, filters, sortBy, fields, options).then((request) => request(axios, basePath)); }, /** @@ -541,10 +543,10 @@ export interface ChannelsApiGetChannelItemsRequest { /** * 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. - * @type {Array} + * @type {Array} * @memberof ChannelsApiGetChannelItems */ - readonly sortBy?: Array + readonly sortBy?: Array /** * Optional. Specify additional fields of information to return in the output. diff --git a/src/generated-client/api/configuration-api.ts b/src/generated-client/api/configuration-api.ts index 99f7c32d..ff1b4d7a 100644 --- a/src/generated-client/api/configuration-api.ts +++ b/src/generated-client/api/configuration-api.ts @@ -20,8 +20,6 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base'; // @ts-ignore -import { MediaEncoderPathDto } from '../models'; -// @ts-ignore import { MetadataOptions } from '../models'; // @ts-ignore import { ServerConfiguration } from '../models'; @@ -173,46 +171,6 @@ export const ConfigurationApiAxiosParamCreator = function (configuration?: Confi options: localVarRequestOptions, }; }, - /** - * - * @summary Updates the path to the media encoder. - * @param {MediaEncoderPathDto} mediaEncoderPathDto Media encoder path form body. - * @param {*} [options] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - updateMediaEncoderPath: async (mediaEncoderPathDto: MediaEncoderPathDto, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'mediaEncoderPathDto' is not null or undefined - assertParamExists('updateMediaEncoderPath', 'mediaEncoderPathDto', mediaEncoderPathDto) - const localVarPath = `/System/MediaEncoder/Path`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication CustomAuthentication required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(mediaEncoderPathDto, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, /** * * @summary Updates named configuration. @@ -308,18 +266,6 @@ export const ConfigurationApiFp = function(configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.updateConfiguration(serverConfiguration, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, - /** - * - * @summary Updates the path to the media encoder. - * @param {MediaEncoderPathDto} mediaEncoderPathDto Media encoder path form body. - * @param {*} [options] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - async updateMediaEncoderPath(mediaEncoderPathDto: MediaEncoderPathDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateMediaEncoderPath(mediaEncoderPathDto, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, /** * * @summary Updates named configuration. @@ -380,17 +326,6 @@ export const ConfigurationApiFactory = function (configuration?: Configuration, updateConfiguration(serverConfiguration: ServerConfiguration, options?: any): AxiosPromise { return localVarFp.updateConfiguration(serverConfiguration, options).then((request) => request(axios, basePath)); }, - /** - * - * @summary Updates the path to the media encoder. - * @param {MediaEncoderPathDto} mediaEncoderPathDto Media encoder path form body. - * @param {*} [options] Override http request option. - * @deprecated - * @throws {RequiredError} - */ - updateMediaEncoderPath(mediaEncoderPathDto: MediaEncoderPathDto, options?: any): AxiosPromise { - return localVarFp.updateMediaEncoderPath(mediaEncoderPathDto, options).then((request) => request(axios, basePath)); - }, /** * * @summary Updates named configuration. @@ -433,20 +368,6 @@ export interface ConfigurationApiUpdateConfigurationRequest { readonly serverConfiguration: ServerConfiguration } -/** - * Request parameters for updateMediaEncoderPath operation in ConfigurationApi. - * @export - * @interface ConfigurationApiUpdateMediaEncoderPathRequest - */ -export interface ConfigurationApiUpdateMediaEncoderPathRequest { - /** - * Media encoder path form body. - * @type {MediaEncoderPathDto} - * @memberof ConfigurationApiUpdateMediaEncoderPath - */ - readonly mediaEncoderPathDto: MediaEncoderPathDto -} - /** * Request parameters for updateNamedConfiguration operation in ConfigurationApi. * @export @@ -521,19 +442,6 @@ export class ConfigurationApi extends BaseAPI { return ConfigurationApiFp(this.configuration).updateConfiguration(requestParameters.serverConfiguration, options).then((request) => request(this.axios, this.basePath)); } - /** - * - * @summary Updates the path to the media encoder. - * @param {ConfigurationApiUpdateMediaEncoderPathRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @deprecated - * @throws {RequiredError} - * @memberof ConfigurationApi - */ - public updateMediaEncoderPath(requestParameters: ConfigurationApiUpdateMediaEncoderPathRequest, options?: AxiosRequestConfig) { - return ConfigurationApiFp(this.configuration).updateMediaEncoderPath(requestParameters.mediaEncoderPathDto, options).then((request) => request(this.axios, this.basePath)); - } - /** * * @summary Updates named configuration. diff --git a/src/generated-client/api/devices-api.ts b/src/generated-client/api/devices-api.ts index acda9a21..93d6913c 100644 --- a/src/generated-client/api/devices-api.ts +++ b/src/generated-client/api/devices-api.ts @@ -158,12 +158,11 @@ export const DevicesApiAxiosParamCreator = function (configuration?: Configurati /** * * @summary Get Devices. - * @param {boolean} [supportsSync] Gets or sets a value indicating whether [supports synchronize]. * @param {string} [userId] Gets or sets the user identifier. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getDevices: async (supportsSync?: boolean, userId?: string, options: AxiosRequestConfig = {}): Promise => { + getDevices: async (userId?: string, options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/Devices`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -179,10 +178,6 @@ export const DevicesApiAxiosParamCreator = function (configuration?: Configurati // authentication CustomAuthentication required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - if (supportsSync !== undefined) { - localVarQueryParameter['supportsSync'] = supportsSync; - } - if (userId !== undefined) { localVarQueryParameter['userId'] = userId; } @@ -290,13 +285,12 @@ export const DevicesApiFp = function(configuration?: Configuration) { /** * * @summary Get Devices. - * @param {boolean} [supportsSync] Gets or sets a value indicating whether [supports synchronize]. * @param {string} [userId] Gets or sets the user identifier. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getDevices(supportsSync?: boolean, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDevices(supportsSync, userId, options); + async getDevices(userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getDevices(userId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -354,13 +348,12 @@ export const DevicesApiFactory = function (configuration?: Configuration, basePa /** * * @summary Get Devices. - * @param {boolean} [supportsSync] Gets or sets a value indicating whether [supports synchronize]. * @param {string} [userId] Gets or sets the user identifier. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getDevices(supportsSync?: boolean, userId?: string, options?: any): AxiosPromise { - return localVarFp.getDevices(supportsSync, userId, options).then((request) => request(axios, basePath)); + getDevices(userId?: string, options?: any): AxiosPromise { + return localVarFp.getDevices(userId, options).then((request) => request(axios, basePath)); }, /** * @@ -424,13 +417,6 @@ export interface DevicesApiGetDeviceOptionsRequest { * @interface DevicesApiGetDevicesRequest */ export interface DevicesApiGetDevicesRequest { - /** - * Gets or sets a value indicating whether [supports synchronize]. - * @type {boolean} - * @memberof DevicesApiGetDevices - */ - readonly supportsSync?: boolean - /** * Gets or sets the user identifier. * @type {string} @@ -512,7 +498,7 @@ export class DevicesApi extends BaseAPI { * @memberof DevicesApi */ public getDevices(requestParameters: DevicesApiGetDevicesRequest = {}, options?: AxiosRequestConfig) { - return DevicesApiFp(this.configuration).getDevices(requestParameters.supportsSync, requestParameters.userId, options).then((request) => request(this.axios, this.basePath)); + return DevicesApiFp(this.configuration).getDevices(requestParameters.userId, options).then((request) => request(this.axios, this.basePath)); } /** diff --git a/src/generated-client/api/display-preferences-api.ts b/src/generated-client/api/display-preferences-api.ts index d9fa1bf9..56864377 100644 --- a/src/generated-client/api/display-preferences-api.ts +++ b/src/generated-client/api/display-preferences-api.ts @@ -31,16 +31,14 @@ export const DisplayPreferencesApiAxiosParamCreator = function (configuration?: * * @summary Get Display Preferences. * @param {string} displayPreferencesId Display preferences id. - * @param {string} userId User id. * @param {string} client Client. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getDisplayPreferences: async (displayPreferencesId: string, userId: string, client: string, options: AxiosRequestConfig = {}): Promise => { + getDisplayPreferences: async (displayPreferencesId: string, client: string, userId?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'displayPreferencesId' is not null or undefined assertParamExists('getDisplayPreferences', 'displayPreferencesId', displayPreferencesId) - // verify required parameter 'userId' is not null or undefined - assertParamExists('getDisplayPreferences', 'userId', userId) // verify required parameter 'client' is not null or undefined assertParamExists('getDisplayPreferences', 'client', client) const localVarPath = `/DisplayPreferences/{displayPreferencesId}` @@ -82,17 +80,15 @@ export const DisplayPreferencesApiAxiosParamCreator = function (configuration?: * * @summary Update Display Preferences. * @param {string} displayPreferencesId Display preferences id. - * @param {string} userId User Id. * @param {string} client Client. * @param {DisplayPreferencesDto} displayPreferencesDto New Display Preferences object. + * @param {string} [userId] User Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateDisplayPreferences: async (displayPreferencesId: string, userId: string, client: string, displayPreferencesDto: DisplayPreferencesDto, options: AxiosRequestConfig = {}): Promise => { + updateDisplayPreferences: async (displayPreferencesId: string, client: string, displayPreferencesDto: DisplayPreferencesDto, userId?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'displayPreferencesId' is not null or undefined assertParamExists('updateDisplayPreferences', 'displayPreferencesId', displayPreferencesId) - // verify required parameter 'userId' is not null or undefined - assertParamExists('updateDisplayPreferences', 'userId', userId) // verify required parameter 'client' is not null or undefined assertParamExists('updateDisplayPreferences', 'client', client) // verify required parameter 'displayPreferencesDto' is not null or undefined @@ -149,27 +145,27 @@ export const DisplayPreferencesApiFp = function(configuration?: Configuration) { * * @summary Get Display Preferences. * @param {string} displayPreferencesId Display preferences id. - * @param {string} userId User id. * @param {string} client Client. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getDisplayPreferences(displayPreferencesId: string, userId: string, client: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getDisplayPreferences(displayPreferencesId, userId, client, options); + async getDisplayPreferences(displayPreferencesId: string, client: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getDisplayPreferences(displayPreferencesId, client, userId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * * @summary Update Display Preferences. * @param {string} displayPreferencesId Display preferences id. - * @param {string} userId User Id. * @param {string} client Client. * @param {DisplayPreferencesDto} displayPreferencesDto New Display Preferences object. + * @param {string} [userId] User Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async updateDisplayPreferences(displayPreferencesId: string, userId: string, client: string, displayPreferencesDto: DisplayPreferencesDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateDisplayPreferences(displayPreferencesId, userId, client, displayPreferencesDto, options); + async updateDisplayPreferences(displayPreferencesId: string, client: string, displayPreferencesDto: DisplayPreferencesDto, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateDisplayPreferences(displayPreferencesId, client, displayPreferencesDto, userId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, } @@ -186,26 +182,26 @@ export const DisplayPreferencesApiFactory = function (configuration?: Configurat * * @summary Get Display Preferences. * @param {string} displayPreferencesId Display preferences id. - * @param {string} userId User id. * @param {string} client Client. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getDisplayPreferences(displayPreferencesId: string, userId: string, client: string, options?: any): AxiosPromise { - return localVarFp.getDisplayPreferences(displayPreferencesId, userId, client, options).then((request) => request(axios, basePath)); + getDisplayPreferences(displayPreferencesId: string, client: string, userId?: string, options?: any): AxiosPromise { + return localVarFp.getDisplayPreferences(displayPreferencesId, client, userId, options).then((request) => request(axios, basePath)); }, /** * * @summary Update Display Preferences. * @param {string} displayPreferencesId Display preferences id. - * @param {string} userId User Id. * @param {string} client Client. * @param {DisplayPreferencesDto} displayPreferencesDto New Display Preferences object. + * @param {string} [userId] User Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateDisplayPreferences(displayPreferencesId: string, userId: string, client: string, displayPreferencesDto: DisplayPreferencesDto, options?: any): AxiosPromise { - return localVarFp.updateDisplayPreferences(displayPreferencesId, userId, client, displayPreferencesDto, options).then((request) => request(axios, basePath)); + updateDisplayPreferences(displayPreferencesId: string, client: string, displayPreferencesDto: DisplayPreferencesDto, userId?: string, options?: any): AxiosPromise { + return localVarFp.updateDisplayPreferences(displayPreferencesId, client, displayPreferencesDto, userId, options).then((request) => request(axios, basePath)); }, }; }; @@ -223,19 +219,19 @@ export interface DisplayPreferencesApiGetDisplayPreferencesRequest { */ readonly displayPreferencesId: string - /** - * User id. - * @type {string} - * @memberof DisplayPreferencesApiGetDisplayPreferences - */ - readonly userId: string - /** * Client. * @type {string} * @memberof DisplayPreferencesApiGetDisplayPreferences */ readonly client: string + + /** + * User id. + * @type {string} + * @memberof DisplayPreferencesApiGetDisplayPreferences + */ + readonly userId?: string } /** @@ -251,13 +247,6 @@ export interface DisplayPreferencesApiUpdateDisplayPreferencesRequest { */ readonly displayPreferencesId: string - /** - * User Id. - * @type {string} - * @memberof DisplayPreferencesApiUpdateDisplayPreferences - */ - readonly userId: string - /** * Client. * @type {string} @@ -271,6 +260,13 @@ export interface DisplayPreferencesApiUpdateDisplayPreferencesRequest { * @memberof DisplayPreferencesApiUpdateDisplayPreferences */ readonly displayPreferencesDto: DisplayPreferencesDto + + /** + * User Id. + * @type {string} + * @memberof DisplayPreferencesApiUpdateDisplayPreferences + */ + readonly userId?: string } /** @@ -289,7 +285,7 @@ export class DisplayPreferencesApi extends BaseAPI { * @memberof DisplayPreferencesApi */ public getDisplayPreferences(requestParameters: DisplayPreferencesApiGetDisplayPreferencesRequest, options?: AxiosRequestConfig) { - return DisplayPreferencesApiFp(this.configuration).getDisplayPreferences(requestParameters.displayPreferencesId, requestParameters.userId, requestParameters.client, options).then((request) => request(this.axios, this.basePath)); + return DisplayPreferencesApiFp(this.configuration).getDisplayPreferences(requestParameters.displayPreferencesId, requestParameters.client, requestParameters.userId, options).then((request) => request(this.axios, this.basePath)); } /** @@ -301,6 +297,6 @@ export class DisplayPreferencesApi extends BaseAPI { * @memberof DisplayPreferencesApi */ public updateDisplayPreferences(requestParameters: DisplayPreferencesApiUpdateDisplayPreferencesRequest, options?: AxiosRequestConfig) { - return DisplayPreferencesApiFp(this.configuration).updateDisplayPreferences(requestParameters.displayPreferencesId, requestParameters.userId, requestParameters.client, requestParameters.displayPreferencesDto, options).then((request) => request(this.axios, this.basePath)); + return DisplayPreferencesApiFp(this.configuration).updateDisplayPreferences(requestParameters.displayPreferencesId, requestParameters.client, requestParameters.displayPreferencesDto, requestParameters.userId, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/generated-client/api/dynamic-hls-api.ts b/src/generated-client/api/dynamic-hls-api.ts index 92b5daea..2aa6405a 100644 --- a/src/generated-client/api/dynamic-hls-api.ts +++ b/src/generated-client/api/dynamic-hls-api.ts @@ -651,7 +651,7 @@ export const DynamicHlsApiAxiosParamCreator = function (configuration?: Configur * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize. * @param {string} [playSessionId] The play session id. * @param {string} [segmentContainer] The segment container. - * @param {number} [segmentLength] The segment lenght. + * @param {number} [segmentLength] The segment length. * @param {number} [minSegments] The minimum number of segments. * @param {string} [mediaSourceId] The media version id, if playing an alternate version. * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed. @@ -1270,10 +1270,11 @@ export const DynamicHlsApiAxiosParamCreator = function (configuration?: Configur * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext. * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options. * @param {boolean} [enableAdaptiveBitrateStreaming] Enable adaptive bitrate streaming. + * @param {boolean} [enableTrickplay] Enable trickplay image playlists being added to master playlist. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getMasterHlsVideoPlaylist: async (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: { [key: string]: string; }, enableAdaptiveBitrateStreaming?: boolean, options: AxiosRequestConfig = {}): Promise => { + getMasterHlsVideoPlaylist: async (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: { [key: string]: string; }, enableAdaptiveBitrateStreaming?: boolean, enableTrickplay?: boolean, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'itemId' is not null or undefined assertParamExists('getMasterHlsVideoPlaylist', 'itemId', itemId) // verify required parameter 'mediaSourceId' is not null or undefined @@ -1494,6 +1495,10 @@ export const DynamicHlsApiAxiosParamCreator = function (configuration?: Configur localVarQueryParameter['enableAdaptiveBitrateStreaming'] = enableAdaptiveBitrateStreaming; } + if (enableTrickplay !== undefined) { + localVarQueryParameter['enableTrickplay'] = enableTrickplay; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -2402,10 +2407,11 @@ export const DynamicHlsApiAxiosParamCreator = function (configuration?: Configur * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext. * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options. * @param {boolean} [enableAdaptiveBitrateStreaming] Enable adaptive bitrate streaming. + * @param {boolean} [enableTrickplay] Enable trickplay image playlists being added to master playlist. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headMasterHlsVideoPlaylist: async (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: { [key: string]: string; }, enableAdaptiveBitrateStreaming?: boolean, options: AxiosRequestConfig = {}): Promise => { + headMasterHlsVideoPlaylist: async (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: { [key: string]: string; }, enableAdaptiveBitrateStreaming?: boolean, enableTrickplay?: boolean, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'itemId' is not null or undefined assertParamExists('headMasterHlsVideoPlaylist', 'itemId', itemId) // verify required parameter 'mediaSourceId' is not null or undefined @@ -2626,6 +2632,10 @@ export const DynamicHlsApiAxiosParamCreator = function (configuration?: Configur localVarQueryParameter['enableAdaptiveBitrateStreaming'] = enableAdaptiveBitrateStreaming; } + if (enableTrickplay !== undefined) { + localVarQueryParameter['enableTrickplay'] = enableTrickplay; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -2787,7 +2797,7 @@ export const DynamicHlsApiFp = function(configuration?: Configuration) { * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize. * @param {string} [playSessionId] The play session id. * @param {string} [segmentContainer] The segment container. - * @param {number} [segmentLength] The segment lenght. + * @param {number} [segmentLength] The segment length. * @param {number} [minSegments] The minimum number of segments. * @param {string} [mediaSourceId] The media version id, if playing an alternate version. * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed. @@ -2952,11 +2962,12 @@ export const DynamicHlsApiFp = function(configuration?: Configuration) { * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext. * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options. * @param {boolean} [enableAdaptiveBitrateStreaming] Enable adaptive bitrate streaming. + * @param {boolean} [enableTrickplay] Enable trickplay image playlists being added to master playlist. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getMasterHlsVideoPlaylist(itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: { [key: string]: string; }, enableAdaptiveBitrateStreaming?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMasterHlsVideoPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, options); + async getMasterHlsVideoPlaylist(itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: { [key: string]: string; }, enableAdaptiveBitrateStreaming?: boolean, enableTrickplay?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getMasterHlsVideoPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableTrickplay, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -3192,11 +3203,12 @@ export const DynamicHlsApiFp = function(configuration?: Configuration) { * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext. * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options. * @param {boolean} [enableAdaptiveBitrateStreaming] Enable adaptive bitrate streaming. + * @param {boolean} [enableTrickplay] Enable trickplay image playlists being added to master playlist. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async headMasterHlsVideoPlaylist(itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: { [key: string]: string; }, enableAdaptiveBitrateStreaming?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.headMasterHlsVideoPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, options); + async headMasterHlsVideoPlaylist(itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: { [key: string]: string; }, enableAdaptiveBitrateStreaming?: boolean, enableTrickplay?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.headMasterHlsVideoPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableTrickplay, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, } @@ -3347,7 +3359,7 @@ export const DynamicHlsApiFactory = function (configuration?: Configuration, bas * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize. * @param {string} [playSessionId] The play session id. * @param {string} [segmentContainer] The segment container. - * @param {number} [segmentLength] The segment lenght. + * @param {number} [segmentLength] The segment length. * @param {number} [minSegments] The minimum number of segments. * @param {string} [mediaSourceId] The media version id, if playing an alternate version. * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed. @@ -3510,11 +3522,12 @@ export const DynamicHlsApiFactory = function (configuration?: Configuration, bas * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext. * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options. * @param {boolean} [enableAdaptiveBitrateStreaming] Enable adaptive bitrate streaming. + * @param {boolean} [enableTrickplay] Enable trickplay image playlists being added to master playlist. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getMasterHlsVideoPlaylist(itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: { [key: string]: string; }, enableAdaptiveBitrateStreaming?: boolean, options?: any): AxiosPromise { - return localVarFp.getMasterHlsVideoPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, options).then((request) => request(axios, basePath)); + getMasterHlsVideoPlaylist(itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: { [key: string]: string; }, enableAdaptiveBitrateStreaming?: boolean, enableTrickplay?: boolean, options?: any): AxiosPromise { + return localVarFp.getMasterHlsVideoPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableTrickplay, options).then((request) => request(axios, basePath)); }, /** * @@ -3746,11 +3759,12 @@ export const DynamicHlsApiFactory = function (configuration?: Configuration, bas * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext. * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options. * @param {boolean} [enableAdaptiveBitrateStreaming] Enable adaptive bitrate streaming. + * @param {boolean} [enableTrickplay] Enable trickplay image playlists being added to master playlist. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headMasterHlsVideoPlaylist(itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: { [key: string]: string; }, enableAdaptiveBitrateStreaming?: boolean, options?: any): AxiosPromise { - return localVarFp.headMasterHlsVideoPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, options).then((request) => request(axios, basePath)); + headMasterHlsVideoPlaylist(itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: { [key: string]: string; }, enableAdaptiveBitrateStreaming?: boolean, enableTrickplay?: boolean, options?: any): AxiosPromise { + return localVarFp.headMasterHlsVideoPlaylist(itemId, mediaSourceId, _static, params, tag, deviceProfileId, playSessionId, segmentContainer, segmentLength, minSegments, deviceId, audioCodec, enableAutoStreamCopy, allowVideoStreamCopy, allowAudioStreamCopy, breakOnNonKeyFrames, audioSampleRate, maxAudioBitDepth, audioBitRate, audioChannels, maxAudioChannels, profile, level, framerate, maxFramerate, copyTimestamps, startTimeTicks, width, height, maxWidth, maxHeight, videoBitRate, subtitleStreamIndex, subtitleMethod, maxRefFrames, maxVideoBitDepth, requireAvc, deInterlace, requireNonAnamorphic, transcodingMaxAudioChannels, cpuCoreLimit, liveStreamId, enableMpegtsM2TsMode, videoCodec, subtitleCodec, transcodeReasons, audioStreamIndex, videoStreamIndex, context, streamOptions, enableAdaptiveBitrateStreaming, enableTrickplay, options).then((request) => request(axios, basePath)); }, }; }; @@ -4595,7 +4609,7 @@ export interface DynamicHlsApiGetLiveHlsStreamRequest { readonly segmentContainer?: string /** - * The segment lenght. + * The segment length. * @type {number} * @memberof DynamicHlsApiGetLiveHlsStream */ @@ -5622,6 +5636,13 @@ export interface DynamicHlsApiGetMasterHlsVideoPlaylistRequest { * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist */ readonly enableAdaptiveBitrateStreaming?: boolean + + /** + * Enable trickplay image playlists being added to master playlist. + * @type {boolean} + * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist + */ + readonly enableTrickplay?: boolean } /** @@ -7050,6 +7071,13 @@ export interface DynamicHlsApiHeadMasterHlsVideoPlaylistRequest { * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist */ readonly enableAdaptiveBitrateStreaming?: boolean + + /** + * Enable trickplay image playlists being added to master playlist. + * @type {boolean} + * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist + */ + readonly enableTrickplay?: boolean } /** @@ -7116,7 +7144,7 @@ export class DynamicHlsApi extends BaseAPI { * @memberof DynamicHlsApi */ public getMasterHlsVideoPlaylist(requestParameters: DynamicHlsApiGetMasterHlsVideoPlaylistRequest, options?: AxiosRequestConfig) { - return DynamicHlsApiFp(this.configuration).getMasterHlsVideoPlaylist(requestParameters.itemId, requestParameters.mediaSourceId, requestParameters._static, requestParameters.params, requestParameters.tag, requestParameters.deviceProfileId, requestParameters.playSessionId, requestParameters.segmentContainer, requestParameters.segmentLength, requestParameters.minSegments, requestParameters.deviceId, requestParameters.audioCodec, requestParameters.enableAutoStreamCopy, requestParameters.allowVideoStreamCopy, requestParameters.allowAudioStreamCopy, requestParameters.breakOnNonKeyFrames, requestParameters.audioSampleRate, requestParameters.maxAudioBitDepth, requestParameters.audioBitRate, requestParameters.audioChannels, requestParameters.maxAudioChannels, requestParameters.profile, requestParameters.level, requestParameters.framerate, requestParameters.maxFramerate, requestParameters.copyTimestamps, requestParameters.startTimeTicks, requestParameters.width, requestParameters.height, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.videoBitRate, requestParameters.subtitleStreamIndex, requestParameters.subtitleMethod, requestParameters.maxRefFrames, requestParameters.maxVideoBitDepth, requestParameters.requireAvc, requestParameters.deInterlace, requestParameters.requireNonAnamorphic, requestParameters.transcodingMaxAudioChannels, requestParameters.cpuCoreLimit, requestParameters.liveStreamId, requestParameters.enableMpegtsM2TsMode, requestParameters.videoCodec, requestParameters.subtitleCodec, requestParameters.transcodeReasons, requestParameters.audioStreamIndex, requestParameters.videoStreamIndex, requestParameters.context, requestParameters.streamOptions, requestParameters.enableAdaptiveBitrateStreaming, options).then((request) => request(this.axios, this.basePath)); + return DynamicHlsApiFp(this.configuration).getMasterHlsVideoPlaylist(requestParameters.itemId, requestParameters.mediaSourceId, requestParameters._static, requestParameters.params, requestParameters.tag, requestParameters.deviceProfileId, requestParameters.playSessionId, requestParameters.segmentContainer, requestParameters.segmentLength, requestParameters.minSegments, requestParameters.deviceId, requestParameters.audioCodec, requestParameters.enableAutoStreamCopy, requestParameters.allowVideoStreamCopy, requestParameters.allowAudioStreamCopy, requestParameters.breakOnNonKeyFrames, requestParameters.audioSampleRate, requestParameters.maxAudioBitDepth, requestParameters.audioBitRate, requestParameters.audioChannels, requestParameters.maxAudioChannels, requestParameters.profile, requestParameters.level, requestParameters.framerate, requestParameters.maxFramerate, requestParameters.copyTimestamps, requestParameters.startTimeTicks, requestParameters.width, requestParameters.height, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.videoBitRate, requestParameters.subtitleStreamIndex, requestParameters.subtitleMethod, requestParameters.maxRefFrames, requestParameters.maxVideoBitDepth, requestParameters.requireAvc, requestParameters.deInterlace, requestParameters.requireNonAnamorphic, requestParameters.transcodingMaxAudioChannels, requestParameters.cpuCoreLimit, requestParameters.liveStreamId, requestParameters.enableMpegtsM2TsMode, requestParameters.videoCodec, requestParameters.subtitleCodec, requestParameters.transcodeReasons, requestParameters.audioStreamIndex, requestParameters.videoStreamIndex, requestParameters.context, requestParameters.streamOptions, requestParameters.enableAdaptiveBitrateStreaming, requestParameters.enableTrickplay, options).then((request) => request(this.axios, this.basePath)); } /** @@ -7164,6 +7192,6 @@ export class DynamicHlsApi extends BaseAPI { * @memberof DynamicHlsApi */ public headMasterHlsVideoPlaylist(requestParameters: DynamicHlsApiHeadMasterHlsVideoPlaylistRequest, options?: AxiosRequestConfig) { - return DynamicHlsApiFp(this.configuration).headMasterHlsVideoPlaylist(requestParameters.itemId, requestParameters.mediaSourceId, requestParameters._static, requestParameters.params, requestParameters.tag, requestParameters.deviceProfileId, requestParameters.playSessionId, requestParameters.segmentContainer, requestParameters.segmentLength, requestParameters.minSegments, requestParameters.deviceId, requestParameters.audioCodec, requestParameters.enableAutoStreamCopy, requestParameters.allowVideoStreamCopy, requestParameters.allowAudioStreamCopy, requestParameters.breakOnNonKeyFrames, requestParameters.audioSampleRate, requestParameters.maxAudioBitDepth, requestParameters.audioBitRate, requestParameters.audioChannels, requestParameters.maxAudioChannels, requestParameters.profile, requestParameters.level, requestParameters.framerate, requestParameters.maxFramerate, requestParameters.copyTimestamps, requestParameters.startTimeTicks, requestParameters.width, requestParameters.height, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.videoBitRate, requestParameters.subtitleStreamIndex, requestParameters.subtitleMethod, requestParameters.maxRefFrames, requestParameters.maxVideoBitDepth, requestParameters.requireAvc, requestParameters.deInterlace, requestParameters.requireNonAnamorphic, requestParameters.transcodingMaxAudioChannels, requestParameters.cpuCoreLimit, requestParameters.liveStreamId, requestParameters.enableMpegtsM2TsMode, requestParameters.videoCodec, requestParameters.subtitleCodec, requestParameters.transcodeReasons, requestParameters.audioStreamIndex, requestParameters.videoStreamIndex, requestParameters.context, requestParameters.streamOptions, requestParameters.enableAdaptiveBitrateStreaming, options).then((request) => request(this.axios, this.basePath)); + return DynamicHlsApiFp(this.configuration).headMasterHlsVideoPlaylist(requestParameters.itemId, requestParameters.mediaSourceId, requestParameters._static, requestParameters.params, requestParameters.tag, requestParameters.deviceProfileId, requestParameters.playSessionId, requestParameters.segmentContainer, requestParameters.segmentLength, requestParameters.minSegments, requestParameters.deviceId, requestParameters.audioCodec, requestParameters.enableAutoStreamCopy, requestParameters.allowVideoStreamCopy, requestParameters.allowAudioStreamCopy, requestParameters.breakOnNonKeyFrames, requestParameters.audioSampleRate, requestParameters.maxAudioBitDepth, requestParameters.audioBitRate, requestParameters.audioChannels, requestParameters.maxAudioChannels, requestParameters.profile, requestParameters.level, requestParameters.framerate, requestParameters.maxFramerate, requestParameters.copyTimestamps, requestParameters.startTimeTicks, requestParameters.width, requestParameters.height, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.videoBitRate, requestParameters.subtitleStreamIndex, requestParameters.subtitleMethod, requestParameters.maxRefFrames, requestParameters.maxVideoBitDepth, requestParameters.requireAvc, requestParameters.deInterlace, requestParameters.requireNonAnamorphic, requestParameters.transcodingMaxAudioChannels, requestParameters.cpuCoreLimit, requestParameters.liveStreamId, requestParameters.enableMpegtsM2TsMode, requestParameters.videoCodec, requestParameters.subtitleCodec, requestParameters.transcodeReasons, requestParameters.audioStreamIndex, requestParameters.videoStreamIndex, requestParameters.context, requestParameters.streamOptions, requestParameters.enableAdaptiveBitrateStreaming, requestParameters.enableTrickplay, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/generated-client/api/filter-api.ts b/src/generated-client/api/filter-api.ts index 2a70f67e..6a131cbd 100644 --- a/src/generated-client/api/filter-api.ts +++ b/src/generated-client/api/filter-api.ts @@ -22,6 +22,8 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr // @ts-ignore import { BaseItemKind } from '../models'; // @ts-ignore +import { MediaType } from '../models'; +// @ts-ignore import { QueryFilters } from '../models'; // @ts-ignore import { QueryFiltersLegacy } from '../models'; @@ -120,11 +122,11 @@ export const FilterApiAxiosParamCreator = function (configuration?: Configuratio * @param {string} [userId] Optional. User id. * @param {string} [parentId] Optional. Parent id. * @param {Array} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. - * @param {Array} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited. + * @param {Array} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getQueryFiltersLegacy: async (userId?: string, parentId?: string, includeItemTypes?: Array, mediaTypes?: Array, options: AxiosRequestConfig = {}): Promise => { + getQueryFiltersLegacy: async (userId?: string, parentId?: string, includeItemTypes?: Array, mediaTypes?: Array, options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/Items/Filters`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -203,11 +205,11 @@ export const FilterApiFp = function(configuration?: Configuration) { * @param {string} [userId] Optional. User id. * @param {string} [parentId] Optional. Parent id. * @param {Array} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. - * @param {Array} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited. + * @param {Array} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getQueryFiltersLegacy(userId?: string, parentId?: string, includeItemTypes?: Array, mediaTypes?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getQueryFiltersLegacy(userId?: string, parentId?: string, includeItemTypes?: Array, mediaTypes?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getQueryFiltersLegacy(userId, parentId, includeItemTypes, mediaTypes, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -246,11 +248,11 @@ export const FilterApiFactory = function (configuration?: Configuration, basePat * @param {string} [userId] Optional. User id. * @param {string} [parentId] Optional. Parent id. * @param {Array} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. - * @param {Array} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited. + * @param {Array} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getQueryFiltersLegacy(userId?: string, parentId?: string, includeItemTypes?: Array, mediaTypes?: Array, options?: any): AxiosPromise { + getQueryFiltersLegacy(userId?: string, parentId?: string, includeItemTypes?: Array, mediaTypes?: Array, options?: any): AxiosPromise { return localVarFp.getQueryFiltersLegacy(userId, parentId, includeItemTypes, mediaTypes, options).then((request) => request(axios, basePath)); }, }; @@ -362,10 +364,10 @@ export interface FilterApiGetQueryFiltersLegacyRequest { /** * Optional. Filter by MediaType. Allows multiple, comma delimited. - * @type {Array} + * @type {Array} * @memberof FilterApiGetQueryFiltersLegacy */ - readonly mediaTypes?: Array + readonly mediaTypes?: Array } /** diff --git a/src/generated-client/api/genres-api.ts b/src/generated-client/api/genres-api.ts index ed692820..8b62e7fe 100644 --- a/src/generated-client/api/genres-api.ts +++ b/src/generated-client/api/genres-api.ts @@ -30,6 +30,8 @@ import { ImageType } from '../models'; // @ts-ignore import { ItemFields } from '../models'; // @ts-ignore +import { ItemSortBy } from '../models'; +// @ts-ignore import { SortOrder } from '../models'; /** * GenresApi - axios parameter creator @@ -96,14 +98,14 @@ export const GenresApiAxiosParamCreator = function (configuration?: Configuratio * @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string. * @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string. * @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string. - * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. + * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. * @param {Array} [sortOrder] Sort Order - Ascending,Descending. * @param {boolean} [enableImages] Optional, include image information in output. * @param {boolean} [enableTotalRecordCount] Optional. Include total record count. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getGenres: async (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array, sortOrder?: Array, enableImages?: boolean, enableTotalRecordCount?: boolean, options: AxiosRequestConfig = {}): Promise => { + getGenres: async (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array, sortOrder?: Array, enableImages?: boolean, enableTotalRecordCount?: boolean, options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/Genres`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -241,14 +243,14 @@ export const GenresApiFp = function(configuration?: Configuration) { * @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string. * @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string. * @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string. - * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. + * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. * @param {Array} [sortOrder] Sort Order - Ascending,Descending. * @param {boolean} [enableImages] Optional, include image information in output. * @param {boolean} [enableTotalRecordCount] Optional. Include total record count. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getGenres(startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array, sortOrder?: Array, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getGenres(startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array, sortOrder?: Array, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getGenres(startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, isFavorite, imageTypeLimit, enableImageTypes, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -290,14 +292,14 @@ export const GenresApiFactory = function (configuration?: Configuration, basePat * @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string. * @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string. * @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string. - * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. + * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. * @param {Array} [sortOrder] Sort Order - Ascending,Descending. * @param {boolean} [enableImages] Optional, include image information in output. * @param {boolean} [enableTotalRecordCount] Optional. Include total record count. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getGenres(startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array, sortOrder?: Array, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise { + getGenres(startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array, sortOrder?: Array, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise { return localVarFp.getGenres(startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, isFavorite, imageTypeLimit, enableImageTypes, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, options).then((request) => request(axios, basePath)); }, }; @@ -430,10 +432,10 @@ export interface GenresApiGetGenresRequest { /** * Optional. Specify one or more sort orders, comma delimited. - * @type {Array} + * @type {Array} * @memberof GenresApiGetGenres */ - readonly sortBy?: Array + readonly sortBy?: Array /** * Sort Order - Ascending,Descending. diff --git a/src/generated-client/api/image-api.ts b/src/generated-client/api/image-api.ts index c93830ed..ad2b5078 100644 --- a/src/generated-client/api/image-api.ts +++ b/src/generated-client/api/image-api.ts @@ -160,20 +160,12 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration /** * * @summary Delete the user\'s image. - * @param {string} userId User Id. - * @param {ImageType} imageType (Unused) Image type. - * @param {number} [index] (Unused) Image index. + * @param {string} [userId] User Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deleteUserImage: async (userId: string, imageType: ImageType, index?: number, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('deleteUserImage', 'userId', userId) - // verify required parameter 'imageType' is not null or undefined - assertParamExists('deleteUserImage', 'imageType', imageType) - const localVarPath = `/Users/{userId}/Images/{imageType}` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))) - .replace(`{${"imageType"}}`, encodeURIComponent(String(imageType))); + deleteUserImage: async (userId?: string, options: AxiosRequestConfig = {}): Promise => { + const localVarPath = `/UserImage`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -188,57 +180,12 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration // authentication CustomAuthentication required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - if (index !== undefined) { - localVarQueryParameter['index'] = index; + if (userId !== undefined) { + localVarQueryParameter['userId'] = userId; } - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * - * @summary Delete the user\'s image. - * @param {string} userId User Id. - * @param {ImageType} imageType (Unused) Image type. - * @param {number} index (Unused) Image index. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - deleteUserImageByIndex: async (userId: string, imageType: ImageType, index: number, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('deleteUserImageByIndex', 'userId', userId) - // verify required parameter 'imageType' is not null or undefined - assertParamExists('deleteUserImageByIndex', 'imageType', imageType) - // verify required parameter 'index' is not null or undefined - assertParamExists('deleteUserImageByIndex', 'index', index) - const localVarPath = `/Users/{userId}/Images/{imageType}/{index}` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))) - .replace(`{${"imageType"}}`, encodeURIComponent(String(imageType))) - .replace(`{${"index"}}`, encodeURIComponent(String(index))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication CustomAuthentication required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - - - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -265,15 +212,13 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getArtistImage: async (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { + getArtistImage: async (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('getArtistImage', 'name', name) // verify required parameter 'imageType' is not null or undefined @@ -339,14 +284,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['fillHeight'] = fillHeight; } - if (cropWhitespace !== undefined) { - localVarQueryParameter['cropWhitespace'] = cropWhitespace; - } - - if (addPlayedIndicator !== undefined) { - localVarQueryParameter['addPlayedIndicator'] = addPlayedIndicator; - } - if (blur !== undefined) { localVarQueryParameter['blur'] = blur; } @@ -386,8 +323,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -395,7 +330,7 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getGenreImage: async (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options: AxiosRequestConfig = {}): Promise => { + getGenreImage: async (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('getGenreImage', 'name', name) // verify required parameter 'imageType' is not null or undefined @@ -458,14 +393,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['fillHeight'] = fillHeight; } - if (cropWhitespace !== undefined) { - localVarQueryParameter['cropWhitespace'] = cropWhitespace; - } - - if (addPlayedIndicator !== undefined) { - localVarQueryParameter['addPlayedIndicator'] = addPlayedIndicator; - } - if (blur !== undefined) { localVarQueryParameter['blur'] = blur; } @@ -510,15 +437,13 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getGenreImageByIndex: async (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { + getGenreImageByIndex: async (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('getGenreImageByIndex', 'name', name) // verify required parameter 'imageType' is not null or undefined @@ -584,14 +509,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['fillHeight'] = fillHeight; } - if (cropWhitespace !== undefined) { - localVarQueryParameter['cropWhitespace'] = cropWhitespace; - } - - if (addPlayedIndicator !== undefined) { - localVarQueryParameter['addPlayedIndicator'] = addPlayedIndicator; - } - if (blur !== undefined) { localVarQueryParameter['blur'] = blur; } @@ -628,9 +545,7 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. * @param {ImageFormat} [format] Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay. * @param {number} [unplayedCount] Optional. Unplayed count overlay to render. * @param {number} [blur] Optional. Blur image. @@ -640,7 +555,7 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getItemImage: async (itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options: AxiosRequestConfig = {}): Promise => { + getItemImage: async (itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, format?: ImageFormat, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'itemId' is not null or undefined assertParamExists('getItemImage', 'itemId', itemId) // verify required parameter 'imageType' is not null or undefined @@ -691,18 +606,10 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['tag'] = tag; } - if (cropWhitespace !== undefined) { - localVarQueryParameter['cropWhitespace'] = cropWhitespace; - } - if (format !== undefined) { localVarQueryParameter['format'] = format; } - if (addPlayedIndicator !== undefined) { - localVarQueryParameter['addPlayedIndicator'] = addPlayedIndicator; - } - if (percentPlayed !== undefined) { localVarQueryParameter['percentPlayed'] = percentPlayed; } @@ -755,15 +662,13 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getItemImage2: async (itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { + getItemImage2: async (itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'itemId' is not null or undefined assertParamExists('getItemImage2', 'itemId', itemId) // verify required parameter 'imageType' is not null or undefined @@ -823,14 +728,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['fillHeight'] = fillHeight; } - if (cropWhitespace !== undefined) { - localVarQueryParameter['cropWhitespace'] = cropWhitespace; - } - - if (addPlayedIndicator !== undefined) { - localVarQueryParameter['addPlayedIndicator'] = addPlayedIndicator; - } - if (blur !== undefined) { localVarQueryParameter['blur'] = blur; } @@ -868,9 +765,7 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. * @param {ImageFormat} [format] Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay. * @param {number} [unplayedCount] Optional. Unplayed count overlay to render. * @param {number} [blur] Optional. Blur image. @@ -879,7 +774,7 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getItemImageByIndex: async (itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { + getItemImageByIndex: async (itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, format?: ImageFormat, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'itemId' is not null or undefined assertParamExists('getItemImageByIndex', 'itemId', itemId) // verify required parameter 'imageType' is not null or undefined @@ -933,18 +828,10 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['tag'] = tag; } - if (cropWhitespace !== undefined) { - localVarQueryParameter['cropWhitespace'] = cropWhitespace; - } - if (format !== undefined) { localVarQueryParameter['format'] = format; } - if (addPlayedIndicator !== undefined) { - localVarQueryParameter['addPlayedIndicator'] = addPlayedIndicator; - } - if (percentPlayed !== undefined) { localVarQueryParameter['percentPlayed'] = percentPlayed; } @@ -1029,8 +916,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -1038,7 +923,7 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getMusicGenreImage: async (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options: AxiosRequestConfig = {}): Promise => { + getMusicGenreImage: async (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('getMusicGenreImage', 'name', name) // verify required parameter 'imageType' is not null or undefined @@ -1101,14 +986,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['fillHeight'] = fillHeight; } - if (cropWhitespace !== undefined) { - localVarQueryParameter['cropWhitespace'] = cropWhitespace; - } - - if (addPlayedIndicator !== undefined) { - localVarQueryParameter['addPlayedIndicator'] = addPlayedIndicator; - } - if (blur !== undefined) { localVarQueryParameter['blur'] = blur; } @@ -1153,15 +1030,13 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getMusicGenreImageByIndex: async (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { + getMusicGenreImageByIndex: async (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('getMusicGenreImageByIndex', 'name', name) // verify required parameter 'imageType' is not null or undefined @@ -1227,14 +1102,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['fillHeight'] = fillHeight; } - if (cropWhitespace !== undefined) { - localVarQueryParameter['cropWhitespace'] = cropWhitespace; - } - - if (addPlayedIndicator !== undefined) { - localVarQueryParameter['addPlayedIndicator'] = addPlayedIndicator; - } - if (blur !== undefined) { localVarQueryParameter['blur'] = blur; } @@ -1274,8 +1141,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -1283,7 +1148,7 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getPersonImage: async (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options: AxiosRequestConfig = {}): Promise => { + getPersonImage: async (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('getPersonImage', 'name', name) // verify required parameter 'imageType' is not null or undefined @@ -1346,14 +1211,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['fillHeight'] = fillHeight; } - if (cropWhitespace !== undefined) { - localVarQueryParameter['cropWhitespace'] = cropWhitespace; - } - - if (addPlayedIndicator !== undefined) { - localVarQueryParameter['addPlayedIndicator'] = addPlayedIndicator; - } - if (blur !== undefined) { localVarQueryParameter['blur'] = blur; } @@ -1398,15 +1255,13 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getPersonImageByIndex: async (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { + getPersonImageByIndex: async (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('getPersonImageByIndex', 'name', name) // verify required parameter 'imageType' is not null or undefined @@ -1472,14 +1327,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['fillHeight'] = fillHeight; } - if (cropWhitespace !== undefined) { - localVarQueryParameter['cropWhitespace'] = cropWhitespace; - } - - if (addPlayedIndicator !== undefined) { - localVarQueryParameter['addPlayedIndicator'] = addPlayedIndicator; - } - if (blur !== undefined) { localVarQueryParameter['blur'] = blur; } @@ -1609,8 +1456,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -1618,7 +1463,7 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getStudioImage: async (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options: AxiosRequestConfig = {}): Promise => { + getStudioImage: async (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('getStudioImage', 'name', name) // verify required parameter 'imageType' is not null or undefined @@ -1681,14 +1526,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['fillHeight'] = fillHeight; } - if (cropWhitespace !== undefined) { - localVarQueryParameter['cropWhitespace'] = cropWhitespace; - } - - if (addPlayedIndicator !== undefined) { - localVarQueryParameter['addPlayedIndicator'] = addPlayedIndicator; - } - if (blur !== undefined) { localVarQueryParameter['blur'] = blur; } @@ -1733,15 +1570,13 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getStudioImageByIndex: async (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { + getStudioImageByIndex: async (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('getStudioImageByIndex', 'name', name) // verify required parameter 'imageType' is not null or undefined @@ -1807,14 +1642,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['fillHeight'] = fillHeight; } - if (cropWhitespace !== undefined) { - localVarQueryParameter['cropWhitespace'] = cropWhitespace; - } - - if (addPlayedIndicator !== undefined) { - localVarQueryParameter['addPlayedIndicator'] = addPlayedIndicator; - } - if (blur !== undefined) { localVarQueryParameter['blur'] = blur; } @@ -1841,8 +1668,7 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration /** * * @summary Get user profile image. - * @param {string} userId User id. - * @param {ImageType} imageType Image type. + * @param {string} [userId] User id. * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers. * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png. * @param {number} [maxWidth] The maximum image width to return. @@ -1854,8 +1680,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -1863,14 +1687,8 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getUserImage: async (userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('getUserImage', 'userId', userId) - // verify required parameter 'imageType' is not null or undefined - assertParamExists('getUserImage', 'imageType', imageType) - const localVarPath = `/Users/{userId}/Images/{imageType}` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))) - .replace(`{${"imageType"}}`, encodeURIComponent(String(imageType))); + getUserImage: async (userId?: string, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options: AxiosRequestConfig = {}): Promise => { + const localVarPath = `/UserImage`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -1882,6 +1700,10 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; + if (userId !== undefined) { + localVarQueryParameter['userId'] = userId; + } + if (tag !== undefined) { localVarQueryParameter['tag'] = tag; } @@ -1926,14 +1748,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['fillHeight'] = fillHeight; } - if (cropWhitespace !== undefined) { - localVarQueryParameter['cropWhitespace'] = cropWhitespace; - } - - if (addPlayedIndicator !== undefined) { - localVarQueryParameter['addPlayedIndicator'] = addPlayedIndicator; - } - if (blur !== undefined) { localVarQueryParameter['blur'] = blur; } @@ -1952,128 +1766,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * - * @summary Get user profile image. - * @param {string} userId User id. - * @param {ImageType} imageType Image type. - * @param {number} imageIndex Image index. - * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers. - * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png. - * @param {number} [maxWidth] The maximum image width to return. - * @param {number} [maxHeight] The maximum image height to return. - * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay. - * @param {number} [unplayedCount] Optional. Unplayed count overlay to render. - * @param {number} [width] The fixed image width to return. - * @param {number} [height] The fixed image height to return. - * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - * @param {number} [fillWidth] Width of box to fill. - * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. - * @param {number} [blur] Optional. Blur image. - * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. - * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getUserImageByIndex: async (userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('getUserImageByIndex', 'userId', userId) - // verify required parameter 'imageType' is not null or undefined - assertParamExists('getUserImageByIndex', 'imageType', imageType) - // verify required parameter 'imageIndex' is not null or undefined - assertParamExists('getUserImageByIndex', 'imageIndex', imageIndex) - const localVarPath = `/Users/{userId}/Images/{imageType}/{imageIndex}` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))) - .replace(`{${"imageType"}}`, encodeURIComponent(String(imageType))) - .replace(`{${"imageIndex"}}`, encodeURIComponent(String(imageIndex))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (tag !== undefined) { - localVarQueryParameter['tag'] = tag; - } - - if (format !== undefined) { - localVarQueryParameter['format'] = format; - } - - if (maxWidth !== undefined) { - localVarQueryParameter['maxWidth'] = maxWidth; - } - - if (maxHeight !== undefined) { - localVarQueryParameter['maxHeight'] = maxHeight; - } - - if (percentPlayed !== undefined) { - localVarQueryParameter['percentPlayed'] = percentPlayed; - } - - if (unplayedCount !== undefined) { - localVarQueryParameter['unplayedCount'] = unplayedCount; - } - - if (width !== undefined) { - localVarQueryParameter['width'] = width; - } - - if (height !== undefined) { - localVarQueryParameter['height'] = height; - } - - if (quality !== undefined) { - localVarQueryParameter['quality'] = quality; - } - - if (fillWidth !== undefined) { - localVarQueryParameter['fillWidth'] = fillWidth; - } - - if (fillHeight !== undefined) { - localVarQueryParameter['fillHeight'] = fillHeight; - } - - if (cropWhitespace !== undefined) { - localVarQueryParameter['cropWhitespace'] = cropWhitespace; - } - - if (addPlayedIndicator !== undefined) { - localVarQueryParameter['addPlayedIndicator'] = addPlayedIndicator; - } - - if (blur !== undefined) { - localVarQueryParameter['blur'] = blur; - } - - if (backgroundColor !== undefined) { - localVarQueryParameter['backgroundColor'] = backgroundColor; - } - - if (foregroundLayer !== undefined) { - localVarQueryParameter['foregroundLayer'] = foregroundLayer; - } - - - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -2100,15 +1792,13 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headArtistImage: async (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { + headArtistImage: async (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('headArtistImage', 'name', name) // verify required parameter 'imageType' is not null or undefined @@ -2174,14 +1864,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['fillHeight'] = fillHeight; } - if (cropWhitespace !== undefined) { - localVarQueryParameter['cropWhitespace'] = cropWhitespace; - } - - if (addPlayedIndicator !== undefined) { - localVarQueryParameter['addPlayedIndicator'] = addPlayedIndicator; - } - if (blur !== undefined) { localVarQueryParameter['blur'] = blur; } @@ -2221,8 +1903,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -2230,7 +1910,7 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headGenreImage: async (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options: AxiosRequestConfig = {}): Promise => { + headGenreImage: async (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('headGenreImage', 'name', name) // verify required parameter 'imageType' is not null or undefined @@ -2293,14 +1973,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['fillHeight'] = fillHeight; } - if (cropWhitespace !== undefined) { - localVarQueryParameter['cropWhitespace'] = cropWhitespace; - } - - if (addPlayedIndicator !== undefined) { - localVarQueryParameter['addPlayedIndicator'] = addPlayedIndicator; - } - if (blur !== undefined) { localVarQueryParameter['blur'] = blur; } @@ -2345,15 +2017,13 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headGenreImageByIndex: async (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { + headGenreImageByIndex: async (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('headGenreImageByIndex', 'name', name) // verify required parameter 'imageType' is not null or undefined @@ -2419,14 +2089,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['fillHeight'] = fillHeight; } - if (cropWhitespace !== undefined) { - localVarQueryParameter['cropWhitespace'] = cropWhitespace; - } - - if (addPlayedIndicator !== undefined) { - localVarQueryParameter['addPlayedIndicator'] = addPlayedIndicator; - } - if (blur !== undefined) { localVarQueryParameter['blur'] = blur; } @@ -2463,9 +2125,7 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. * @param {ImageFormat} [format] Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay. * @param {number} [unplayedCount] Optional. Unplayed count overlay to render. * @param {number} [blur] Optional. Blur image. @@ -2475,7 +2135,7 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headItemImage: async (itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options: AxiosRequestConfig = {}): Promise => { + headItemImage: async (itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, format?: ImageFormat, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'itemId' is not null or undefined assertParamExists('headItemImage', 'itemId', itemId) // verify required parameter 'imageType' is not null or undefined @@ -2526,18 +2186,10 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['tag'] = tag; } - if (cropWhitespace !== undefined) { - localVarQueryParameter['cropWhitespace'] = cropWhitespace; - } - if (format !== undefined) { localVarQueryParameter['format'] = format; } - if (addPlayedIndicator !== undefined) { - localVarQueryParameter['addPlayedIndicator'] = addPlayedIndicator; - } - if (percentPlayed !== undefined) { localVarQueryParameter['percentPlayed'] = percentPlayed; } @@ -2590,15 +2242,13 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headItemImage2: async (itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { + headItemImage2: async (itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'itemId' is not null or undefined assertParamExists('headItemImage2', 'itemId', itemId) // verify required parameter 'imageType' is not null or undefined @@ -2658,14 +2308,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['fillHeight'] = fillHeight; } - if (cropWhitespace !== undefined) { - localVarQueryParameter['cropWhitespace'] = cropWhitespace; - } - - if (addPlayedIndicator !== undefined) { - localVarQueryParameter['addPlayedIndicator'] = addPlayedIndicator; - } - if (blur !== undefined) { localVarQueryParameter['blur'] = blur; } @@ -2703,9 +2345,7 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. * @param {ImageFormat} [format] Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay. * @param {number} [unplayedCount] Optional. Unplayed count overlay to render. * @param {number} [blur] Optional. Blur image. @@ -2714,7 +2354,7 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headItemImageByIndex: async (itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { + headItemImageByIndex: async (itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, format?: ImageFormat, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'itemId' is not null or undefined assertParamExists('headItemImageByIndex', 'itemId', itemId) // verify required parameter 'imageType' is not null or undefined @@ -2768,18 +2408,10 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['tag'] = tag; } - if (cropWhitespace !== undefined) { - localVarQueryParameter['cropWhitespace'] = cropWhitespace; - } - if (format !== undefined) { localVarQueryParameter['format'] = format; } - if (addPlayedIndicator !== undefined) { - localVarQueryParameter['addPlayedIndicator'] = addPlayedIndicator; - } - if (percentPlayed !== undefined) { localVarQueryParameter['percentPlayed'] = percentPlayed; } @@ -2827,8 +2459,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -2836,7 +2466,7 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headMusicGenreImage: async (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options: AxiosRequestConfig = {}): Promise => { + headMusicGenreImage: async (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('headMusicGenreImage', 'name', name) // verify required parameter 'imageType' is not null or undefined @@ -2899,14 +2529,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['fillHeight'] = fillHeight; } - if (cropWhitespace !== undefined) { - localVarQueryParameter['cropWhitespace'] = cropWhitespace; - } - - if (addPlayedIndicator !== undefined) { - localVarQueryParameter['addPlayedIndicator'] = addPlayedIndicator; - } - if (blur !== undefined) { localVarQueryParameter['blur'] = blur; } @@ -2951,15 +2573,13 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headMusicGenreImageByIndex: async (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { + headMusicGenreImageByIndex: async (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('headMusicGenreImageByIndex', 'name', name) // verify required parameter 'imageType' is not null or undefined @@ -3025,14 +2645,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['fillHeight'] = fillHeight; } - if (cropWhitespace !== undefined) { - localVarQueryParameter['cropWhitespace'] = cropWhitespace; - } - - if (addPlayedIndicator !== undefined) { - localVarQueryParameter['addPlayedIndicator'] = addPlayedIndicator; - } - if (blur !== undefined) { localVarQueryParameter['blur'] = blur; } @@ -3072,8 +2684,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -3081,7 +2691,7 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headPersonImage: async (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options: AxiosRequestConfig = {}): Promise => { + headPersonImage: async (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('headPersonImage', 'name', name) // verify required parameter 'imageType' is not null or undefined @@ -3144,14 +2754,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['fillHeight'] = fillHeight; } - if (cropWhitespace !== undefined) { - localVarQueryParameter['cropWhitespace'] = cropWhitespace; - } - - if (addPlayedIndicator !== undefined) { - localVarQueryParameter['addPlayedIndicator'] = addPlayedIndicator; - } - if (blur !== undefined) { localVarQueryParameter['blur'] = blur; } @@ -3196,15 +2798,13 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headPersonImageByIndex: async (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { + headPersonImageByIndex: async (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('headPersonImageByIndex', 'name', name) // verify required parameter 'imageType' is not null or undefined @@ -3270,14 +2870,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['fillHeight'] = fillHeight; } - if (cropWhitespace !== undefined) { - localVarQueryParameter['cropWhitespace'] = cropWhitespace; - } - - if (addPlayedIndicator !== undefined) { - localVarQueryParameter['addPlayedIndicator'] = addPlayedIndicator; - } - if (blur !== undefined) { localVarQueryParameter['blur'] = blur; } @@ -3317,8 +2909,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -3326,7 +2916,7 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headStudioImage: async (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options: AxiosRequestConfig = {}): Promise => { + headStudioImage: async (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('headStudioImage', 'name', name) // verify required parameter 'imageType' is not null or undefined @@ -3389,14 +2979,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['fillHeight'] = fillHeight; } - if (cropWhitespace !== undefined) { - localVarQueryParameter['cropWhitespace'] = cropWhitespace; - } - - if (addPlayedIndicator !== undefined) { - localVarQueryParameter['addPlayedIndicator'] = addPlayedIndicator; - } - if (blur !== undefined) { localVarQueryParameter['blur'] = blur; } @@ -3441,15 +3023,13 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headStudioImageByIndex: async (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { + headStudioImageByIndex: async (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('headStudioImageByIndex', 'name', name) // verify required parameter 'imageType' is not null or undefined @@ -3515,14 +3095,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['fillHeight'] = fillHeight; } - if (cropWhitespace !== undefined) { - localVarQueryParameter['cropWhitespace'] = cropWhitespace; - } - - if (addPlayedIndicator !== undefined) { - localVarQueryParameter['addPlayedIndicator'] = addPlayedIndicator; - } - if (blur !== undefined) { localVarQueryParameter['blur'] = blur; } @@ -3549,8 +3121,7 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration /** * * @summary Get user profile image. - * @param {string} userId User id. - * @param {ImageType} imageType Image type. + * @param {string} [userId] User id. * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers. * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png. * @param {number} [maxWidth] The maximum image width to return. @@ -3562,8 +3133,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -3571,14 +3140,8 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headUserImage: async (userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('headUserImage', 'userId', userId) - // verify required parameter 'imageType' is not null or undefined - assertParamExists('headUserImage', 'imageType', imageType) - const localVarPath = `/Users/{userId}/Images/{imageType}` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))) - .replace(`{${"imageType"}}`, encodeURIComponent(String(imageType))); + headUserImage: async (userId?: string, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options: AxiosRequestConfig = {}): Promise => { + const localVarPath = `/UserImage`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -3590,6 +3153,10 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; + if (userId !== undefined) { + localVarQueryParameter['userId'] = userId; + } + if (tag !== undefined) { localVarQueryParameter['tag'] = tag; } @@ -3634,14 +3201,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['fillHeight'] = fillHeight; } - if (cropWhitespace !== undefined) { - localVarQueryParameter['cropWhitespace'] = cropWhitespace; - } - - if (addPlayedIndicator !== undefined) { - localVarQueryParameter['addPlayedIndicator'] = addPlayedIndicator; - } - if (blur !== undefined) { localVarQueryParameter['blur'] = blur; } @@ -3660,128 +3219,6 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * - * @summary Get user profile image. - * @param {string} userId User id. - * @param {ImageType} imageType Image type. - * @param {number} imageIndex Image index. - * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers. - * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png. - * @param {number} [maxWidth] The maximum image width to return. - * @param {number} [maxHeight] The maximum image height to return. - * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay. - * @param {number} [unplayedCount] Optional. Unplayed count overlay to render. - * @param {number} [width] The fixed image width to return. - * @param {number} [height] The fixed image height to return. - * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - * @param {number} [fillWidth] Width of box to fill. - * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. - * @param {number} [blur] Optional. Blur image. - * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. - * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - headUserImageByIndex: async (userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('headUserImageByIndex', 'userId', userId) - // verify required parameter 'imageType' is not null or undefined - assertParamExists('headUserImageByIndex', 'imageType', imageType) - // verify required parameter 'imageIndex' is not null or undefined - assertParamExists('headUserImageByIndex', 'imageIndex', imageIndex) - const localVarPath = `/Users/{userId}/Images/{imageType}/{imageIndex}` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))) - .replace(`{${"imageType"}}`, encodeURIComponent(String(imageType))) - .replace(`{${"imageIndex"}}`, encodeURIComponent(String(imageIndex))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'HEAD', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (tag !== undefined) { - localVarQueryParameter['tag'] = tag; - } - - if (format !== undefined) { - localVarQueryParameter['format'] = format; - } - - if (maxWidth !== undefined) { - localVarQueryParameter['maxWidth'] = maxWidth; - } - - if (maxHeight !== undefined) { - localVarQueryParameter['maxHeight'] = maxHeight; - } - - if (percentPlayed !== undefined) { - localVarQueryParameter['percentPlayed'] = percentPlayed; - } - - if (unplayedCount !== undefined) { - localVarQueryParameter['unplayedCount'] = unplayedCount; - } - - if (width !== undefined) { - localVarQueryParameter['width'] = width; - } - - if (height !== undefined) { - localVarQueryParameter['height'] = height; - } - - if (quality !== undefined) { - localVarQueryParameter['quality'] = quality; - } - - if (fillWidth !== undefined) { - localVarQueryParameter['fillWidth'] = fillWidth; - } - - if (fillHeight !== undefined) { - localVarQueryParameter['fillHeight'] = fillHeight; - } - - if (cropWhitespace !== undefined) { - localVarQueryParameter['cropWhitespace'] = cropWhitespace; - } - - if (addPlayedIndicator !== undefined) { - localVarQueryParameter['addPlayedIndicator'] = addPlayedIndicator; - } - - if (blur !== undefined) { - localVarQueryParameter['blur'] = blur; - } - - if (backgroundColor !== undefined) { - localVarQueryParameter['backgroundColor'] = backgroundColor; - } - - if (foregroundLayer !== undefined) { - localVarQueryParameter['foregroundLayer'] = foregroundLayer; - } - - - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -3794,21 +3231,13 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration /** * * @summary Sets the user image. - * @param {string} userId User Id. - * @param {ImageType} imageType (Unused) Image type. - * @param {number} [index] (Unused) Image index. + * @param {string} [userId] User Id. * @param {any} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - postUserImage: async (userId: string, imageType: ImageType, index?: number, body?: any, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('postUserImage', 'userId', userId) - // verify required parameter 'imageType' is not null or undefined - assertParamExists('postUserImage', 'imageType', imageType) - const localVarPath = `/Users/{userId}/Images/{imageType}` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))) - .replace(`{${"imageType"}}`, encodeURIComponent(String(imageType))); + postUserImage: async (userId?: string, body?: any, options: AxiosRequestConfig = {}): Promise => { + const localVarPath = `/UserImage`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -3823,61 +3252,12 @@ export const ImageApiAxiosParamCreator = function (configuration?: Configuration // authentication CustomAuthentication required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - if (index !== undefined) { - localVarQueryParameter['index'] = index; + if (userId !== undefined) { + localVarQueryParameter['userId'] = userId; } - localVarHeaderParameter['Content-Type'] = 'image/_*'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * - * @summary Sets the user image. - * @param {string} userId User Id. - * @param {ImageType} imageType (Unused) Image type. - * @param {number} index (Unused) Image index. - * @param {any} [body] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - postUserImageByIndex: async (userId: string, imageType: ImageType, index: number, body?: any, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('postUserImageByIndex', 'userId', userId) - // verify required parameter 'imageType' is not null or undefined - assertParamExists('postUserImageByIndex', 'imageType', imageType) - // verify required parameter 'index' is not null or undefined - assertParamExists('postUserImageByIndex', 'index', index) - const localVarPath = `/Users/{userId}/Images/{imageType}/{index}` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))) - .replace(`{${"imageType"}}`, encodeURIComponent(String(imageType))) - .replace(`{${"index"}}`, encodeURIComponent(String(index))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication CustomAuthentication required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - - - localVarHeaderParameter['Content-Type'] = 'image/_*'; setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -4122,27 +3502,12 @@ export const ImageApiFp = function(configuration?: Configuration) { /** * * @summary Delete the user\'s image. - * @param {string} userId User Id. - * @param {ImageType} imageType (Unused) Image type. - * @param {number} [index] (Unused) Image index. + * @param {string} [userId] User Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async deleteUserImage(userId: string, imageType: ImageType, index?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteUserImage(userId, imageType, index, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * - * @summary Delete the user\'s image. - * @param {string} userId User Id. - * @param {ImageType} imageType (Unused) Image type. - * @param {number} index (Unused) Image index. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async deleteUserImageByIndex(userId: string, imageType: ImageType, index: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteUserImageByIndex(userId, imageType, index, options); + async deleteUserImage(userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteUserImage(userId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -4162,16 +3527,14 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getArtistImage(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getArtistImage(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, options); + async getArtistImage(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getArtistImage(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -4190,8 +3553,6 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -4199,8 +3560,8 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getGenreImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, options); + async getGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getGenreImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -4220,16 +3581,14 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getGenreImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, options); + async getGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getGenreImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -4245,9 +3604,7 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. * @param {ImageFormat} [format] Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay. * @param {number} [unplayedCount] Optional. Unplayed count overlay to render. * @param {number} [blur] Optional. Blur image. @@ -4257,8 +3614,8 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getItemImage(itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getItemImage(itemId, imageType, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, cropWhitespace, format, addPlayedIndicator, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, imageIndex, options); + async getItemImage(itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, format?: ImageFormat, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getItemImage(itemId, imageType, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, imageIndex, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -4278,16 +3635,14 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getItemImage2(itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getItemImage2(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, options); + async getItemImage2(itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getItemImage2(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -4304,9 +3659,7 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. * @param {ImageFormat} [format] Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay. * @param {number} [unplayedCount] Optional. Unplayed count overlay to render. * @param {number} [blur] Optional. Blur image. @@ -4315,8 +3668,8 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getItemImageByIndex(itemId, imageType, imageIndex, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, cropWhitespace, format, addPlayedIndicator, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, options); + async getItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, format?: ImageFormat, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getItemImageByIndex(itemId, imageType, imageIndex, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -4346,8 +3699,6 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -4355,8 +3706,8 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getMusicGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMusicGenreImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, options); + async getMusicGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getMusicGenreImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -4376,16 +3727,14 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getMusicGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMusicGenreImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, options); + async getMusicGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getMusicGenreImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -4404,8 +3753,6 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -4413,8 +3760,8 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getPersonImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPersonImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, options); + async getPersonImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPersonImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -4434,16 +3781,14 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getPersonImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPersonImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, options); + async getPersonImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPersonImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -4484,8 +3829,6 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -4493,8 +3836,8 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getStudioImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getStudioImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, options); + async getStudioImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getStudioImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -4514,23 +3857,20 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getStudioImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getStudioImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, options); + async getStudioImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getStudioImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * * @summary Get user profile image. - * @param {string} userId User id. - * @param {ImageType} imageType Image type. + * @param {string} [userId] User id. * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers. * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png. * @param {number} [maxWidth] The maximum image width to return. @@ -4542,8 +3882,6 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -4551,37 +3889,8 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getUserImage(userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getUserImage(userId, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * - * @summary Get user profile image. - * @param {string} userId User id. - * @param {ImageType} imageType Image type. - * @param {number} imageIndex Image index. - * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers. - * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png. - * @param {number} [maxWidth] The maximum image width to return. - * @param {number} [maxHeight] The maximum image height to return. - * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay. - * @param {number} [unplayedCount] Optional. Unplayed count overlay to render. - * @param {number} [width] The fixed image width to return. - * @param {number} [height] The fixed image height to return. - * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - * @param {number} [fillWidth] Width of box to fill. - * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. - * @param {number} [blur] Optional. Blur image. - * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. - * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getUserImageByIndex(userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getUserImageByIndex(userId, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, options); + async getUserImage(userId?: string, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getUserImage(userId, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -4601,16 +3910,14 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async headArtistImage(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.headArtistImage(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, options); + async headArtistImage(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.headArtistImage(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -4629,8 +3936,6 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -4638,8 +3943,8 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async headGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.headGenreImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, options); + async headGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.headGenreImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -4659,16 +3964,14 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async headGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.headGenreImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, options); + async headGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.headGenreImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -4684,9 +3987,7 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. * @param {ImageFormat} [format] Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay. * @param {number} [unplayedCount] Optional. Unplayed count overlay to render. * @param {number} [blur] Optional. Blur image. @@ -4696,8 +3997,8 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async headItemImage(itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.headItemImage(itemId, imageType, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, cropWhitespace, format, addPlayedIndicator, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, imageIndex, options); + async headItemImage(itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, format?: ImageFormat, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.headItemImage(itemId, imageType, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, imageIndex, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -4717,16 +4018,14 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async headItemImage2(itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.headItemImage2(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, options); + async headItemImage2(itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.headItemImage2(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -4743,9 +4042,7 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. * @param {ImageFormat} [format] Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay. * @param {number} [unplayedCount] Optional. Unplayed count overlay to render. * @param {number} [blur] Optional. Blur image. @@ -4754,8 +4051,8 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async headItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.headItemImageByIndex(itemId, imageType, imageIndex, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, cropWhitespace, format, addPlayedIndicator, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, options); + async headItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, format?: ImageFormat, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.headItemImageByIndex(itemId, imageType, imageIndex, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -4774,8 +4071,6 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -4783,8 +4078,8 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async headMusicGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.headMusicGenreImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, options); + async headMusicGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.headMusicGenreImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -4804,16 +4099,14 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async headMusicGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.headMusicGenreImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, options); + async headMusicGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.headMusicGenreImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -4832,8 +4125,6 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -4841,8 +4132,8 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async headPersonImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.headPersonImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, options); + async headPersonImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.headPersonImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -4862,16 +4153,14 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async headPersonImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.headPersonImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, options); + async headPersonImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.headPersonImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -4890,8 +4179,6 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -4899,8 +4186,8 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async headStudioImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.headStudioImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, options); + async headStudioImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.headStudioImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -4920,23 +4207,20 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async headStudioImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.headStudioImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, options); + async headStudioImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.headStudioImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * * @summary Get user profile image. - * @param {string} userId User id. - * @param {ImageType} imageType Image type. + * @param {string} [userId] User id. * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers. * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png. * @param {number} [maxWidth] The maximum image width to return. @@ -4948,8 +4232,6 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -4957,65 +4239,20 @@ export const ImageApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async headUserImage(userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.headUserImage(userId, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * - * @summary Get user profile image. - * @param {string} userId User id. - * @param {ImageType} imageType Image type. - * @param {number} imageIndex Image index. - * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers. - * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png. - * @param {number} [maxWidth] The maximum image width to return. - * @param {number} [maxHeight] The maximum image height to return. - * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay. - * @param {number} [unplayedCount] Optional. Unplayed count overlay to render. - * @param {number} [width] The fixed image width to return. - * @param {number} [height] The fixed image height to return. - * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - * @param {number} [fillWidth] Width of box to fill. - * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. - * @param {number} [blur] Optional. Blur image. - * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. - * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async headUserImageByIndex(userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.headUserImageByIndex(userId, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, options); + async headUserImage(userId?: string, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.headUserImage(userId, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * * @summary Sets the user image. - * @param {string} userId User Id. - * @param {ImageType} imageType (Unused) Image type. - * @param {number} [index] (Unused) Image index. + * @param {string} [userId] User Id. * @param {any} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async postUserImage(userId: string, imageType: ImageType, index?: number, body?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.postUserImage(userId, imageType, index, body, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * - * @summary Sets the user image. - * @param {string} userId User Id. - * @param {ImageType} imageType (Unused) Image type. - * @param {number} index (Unused) Image index. - * @param {any} [body] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async postUserImageByIndex(userId: string, imageType: ImageType, index: number, body?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.postUserImageByIndex(userId, imageType, index, body, options); + async postUserImage(userId?: string, body?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.postUserImage(userId, body, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -5116,26 +4353,12 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath /** * * @summary Delete the user\'s image. - * @param {string} userId User Id. - * @param {ImageType} imageType (Unused) Image type. - * @param {number} [index] (Unused) Image index. + * @param {string} [userId] User Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deleteUserImage(userId: string, imageType: ImageType, index?: number, options?: any): AxiosPromise { - return localVarFp.deleteUserImage(userId, imageType, index, options).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Delete the user\'s image. - * @param {string} userId User Id. - * @param {ImageType} imageType (Unused) Image type. - * @param {number} index (Unused) Image index. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - deleteUserImageByIndex(userId: string, imageType: ImageType, index: number, options?: any): AxiosPromise { - return localVarFp.deleteUserImageByIndex(userId, imageType, index, options).then((request) => request(axios, basePath)); + deleteUserImage(userId?: string, options?: any): AxiosPromise { + return localVarFp.deleteUserImage(userId, options).then((request) => request(axios, basePath)); }, /** * @@ -5154,16 +4377,14 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getArtistImage(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { - return localVarFp.getArtistImage(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); + getArtistImage(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { + return localVarFp.getArtistImage(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); }, /** * @@ -5181,8 +4402,6 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -5190,8 +4409,8 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise { - return localVarFp.getGenreImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, options).then((request) => request(axios, basePath)); + getGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise { + return localVarFp.getGenreImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, options).then((request) => request(axios, basePath)); }, /** * @@ -5210,16 +4429,14 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { - return localVarFp.getGenreImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); + getGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { + return localVarFp.getGenreImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); }, /** * @@ -5234,9 +4451,7 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. * @param {ImageFormat} [format] Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay. * @param {number} [unplayedCount] Optional. Unplayed count overlay to render. * @param {number} [blur] Optional. Blur image. @@ -5246,8 +4461,8 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getItemImage(itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise { - return localVarFp.getItemImage(itemId, imageType, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, cropWhitespace, format, addPlayedIndicator, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, imageIndex, options).then((request) => request(axios, basePath)); + getItemImage(itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, format?: ImageFormat, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise { + return localVarFp.getItemImage(itemId, imageType, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, imageIndex, options).then((request) => request(axios, basePath)); }, /** * @@ -5266,16 +4481,14 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getItemImage2(itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { - return localVarFp.getItemImage2(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); + getItemImage2(itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { + return localVarFp.getItemImage2(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); }, /** * @@ -5291,9 +4504,7 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. * @param {ImageFormat} [format] Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay. * @param {number} [unplayedCount] Optional. Unplayed count overlay to render. * @param {number} [blur] Optional. Blur image. @@ -5302,8 +4513,8 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { - return localVarFp.getItemImageByIndex(itemId, imageType, imageIndex, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, cropWhitespace, format, addPlayedIndicator, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); + getItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, format?: ImageFormat, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { + return localVarFp.getItemImageByIndex(itemId, imageType, imageIndex, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); }, /** * @@ -5331,8 +4542,6 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -5340,8 +4549,8 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getMusicGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise { - return localVarFp.getMusicGenreImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, options).then((request) => request(axios, basePath)); + getMusicGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise { + return localVarFp.getMusicGenreImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, options).then((request) => request(axios, basePath)); }, /** * @@ -5360,16 +4569,14 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getMusicGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { - return localVarFp.getMusicGenreImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); + getMusicGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { + return localVarFp.getMusicGenreImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); }, /** * @@ -5387,8 +4594,6 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -5396,8 +4601,8 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getPersonImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise { - return localVarFp.getPersonImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, options).then((request) => request(axios, basePath)); + getPersonImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise { + return localVarFp.getPersonImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, options).then((request) => request(axios, basePath)); }, /** * @@ -5416,16 +4621,14 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getPersonImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { - return localVarFp.getPersonImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); + getPersonImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { + return localVarFp.getPersonImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); }, /** * @@ -5464,8 +4667,6 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -5473,8 +4674,8 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getStudioImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise { - return localVarFp.getStudioImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, options).then((request) => request(axios, basePath)); + getStudioImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise { + return localVarFp.getStudioImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, options).then((request) => request(axios, basePath)); }, /** * @@ -5493,22 +4694,19 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getStudioImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { - return localVarFp.getStudioImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); + getStudioImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { + return localVarFp.getStudioImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); }, /** * * @summary Get user profile image. - * @param {string} userId User id. - * @param {ImageType} imageType Image type. + * @param {string} [userId] User id. * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers. * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png. * @param {number} [maxWidth] The maximum image width to return. @@ -5520,8 +4718,6 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -5529,36 +4725,8 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getUserImage(userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise { - return localVarFp.getUserImage(userId, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, options).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Get user profile image. - * @param {string} userId User id. - * @param {ImageType} imageType Image type. - * @param {number} imageIndex Image index. - * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers. - * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png. - * @param {number} [maxWidth] The maximum image width to return. - * @param {number} [maxHeight] The maximum image height to return. - * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay. - * @param {number} [unplayedCount] Optional. Unplayed count overlay to render. - * @param {number} [width] The fixed image width to return. - * @param {number} [height] The fixed image height to return. - * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - * @param {number} [fillWidth] Width of box to fill. - * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. - * @param {number} [blur] Optional. Blur image. - * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. - * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getUserImageByIndex(userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { - return localVarFp.getUserImageByIndex(userId, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); + getUserImage(userId?: string, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise { + return localVarFp.getUserImage(userId, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, options).then((request) => request(axios, basePath)); }, /** * @@ -5577,16 +4745,14 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headArtistImage(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { - return localVarFp.headArtistImage(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); + headArtistImage(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { + return localVarFp.headArtistImage(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); }, /** * @@ -5604,8 +4770,6 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -5613,8 +4777,8 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise { - return localVarFp.headGenreImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, options).then((request) => request(axios, basePath)); + headGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise { + return localVarFp.headGenreImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, options).then((request) => request(axios, basePath)); }, /** * @@ -5633,16 +4797,14 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { - return localVarFp.headGenreImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); + headGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { + return localVarFp.headGenreImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); }, /** * @@ -5657,9 +4819,7 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. * @param {ImageFormat} [format] Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay. * @param {number} [unplayedCount] Optional. Unplayed count overlay to render. * @param {number} [blur] Optional. Blur image. @@ -5669,8 +4829,8 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headItemImage(itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise { - return localVarFp.headItemImage(itemId, imageType, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, cropWhitespace, format, addPlayedIndicator, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, imageIndex, options).then((request) => request(axios, basePath)); + headItemImage(itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, format?: ImageFormat, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise { + return localVarFp.headItemImage(itemId, imageType, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, imageIndex, options).then((request) => request(axios, basePath)); }, /** * @@ -5689,16 +4849,14 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headItemImage2(itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { - return localVarFp.headItemImage2(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); + headItemImage2(itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { + return localVarFp.headItemImage2(itemId, imageType, maxWidth, maxHeight, tag, format, percentPlayed, unplayedCount, imageIndex, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); }, /** * @@ -5714,9 +4872,7 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. * @param {ImageFormat} [format] Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay. * @param {number} [unplayedCount] Optional. Unplayed count overlay to render. * @param {number} [blur] Optional. Blur image. @@ -5725,8 +4881,8 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { - return localVarFp.headItemImageByIndex(itemId, imageType, imageIndex, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, cropWhitespace, format, addPlayedIndicator, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); + headItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, format?: ImageFormat, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { + return localVarFp.headItemImageByIndex(itemId, imageType, imageIndex, maxWidth, maxHeight, width, height, quality, fillWidth, fillHeight, tag, format, percentPlayed, unplayedCount, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); }, /** * @@ -5744,8 +4900,6 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -5753,8 +4907,8 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headMusicGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise { - return localVarFp.headMusicGenreImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, options).then((request) => request(axios, basePath)); + headMusicGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise { + return localVarFp.headMusicGenreImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, options).then((request) => request(axios, basePath)); }, /** * @@ -5773,16 +4927,14 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headMusicGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { - return localVarFp.headMusicGenreImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); + headMusicGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { + return localVarFp.headMusicGenreImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); }, /** * @@ -5800,8 +4952,6 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -5809,8 +4959,8 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headPersonImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise { - return localVarFp.headPersonImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, options).then((request) => request(axios, basePath)); + headPersonImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise { + return localVarFp.headPersonImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, options).then((request) => request(axios, basePath)); }, /** * @@ -5829,16 +4979,14 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headPersonImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { - return localVarFp.headPersonImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); + headPersonImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { + return localVarFp.headPersonImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); }, /** * @@ -5856,8 +5004,6 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -5865,8 +5011,8 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headStudioImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise { - return localVarFp.headStudioImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, options).then((request) => request(axios, basePath)); + headStudioImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise { + return localVarFp.headStudioImage(name, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, options).then((request) => request(axios, basePath)); }, /** * @@ -5885,22 +5031,19 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headStudioImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { - return localVarFp.headStudioImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); + headStudioImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { + return localVarFp.headStudioImageByIndex(name, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); }, /** * * @summary Get user profile image. - * @param {string} userId User id. - * @param {ImageType} imageType Image type. + * @param {string} [userId] User id. * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers. * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png. * @param {number} [maxWidth] The maximum image width to return. @@ -5912,8 +5055,6 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. * @param {number} [fillWidth] Width of box to fill. * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. * @param {number} [blur] Optional. Blur image. * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. @@ -5921,62 +5062,19 @@ export const ImageApiFactory = function (configuration?: Configuration, basePath * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headUserImage(userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise { - return localVarFp.headUserImage(userId, imageType, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, imageIndex, options).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Get user profile image. - * @param {string} userId User id. - * @param {ImageType} imageType Image type. - * @param {number} imageIndex Image index. - * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers. - * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png. - * @param {number} [maxWidth] The maximum image width to return. - * @param {number} [maxHeight] The maximum image height to return. - * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay. - * @param {number} [unplayedCount] Optional. Unplayed count overlay to render. - * @param {number} [width] The fixed image width to return. - * @param {number} [height] The fixed image height to return. - * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - * @param {number} [fillWidth] Width of box to fill. - * @param {number} [fillHeight] Height of box to fill. - * @param {boolean} [cropWhitespace] Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @param {boolean} [addPlayedIndicator] Optional. Add a played indicator. - * @param {number} [blur] Optional. Blur image. - * @param {string} [backgroundColor] Optional. Apply a background color for transparent images. - * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - headUserImageByIndex(userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise { - return localVarFp.headUserImageByIndex(userId, imageType, imageIndex, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, cropWhitespace, addPlayedIndicator, blur, backgroundColor, foregroundLayer, options).then((request) => request(axios, basePath)); + headUserImage(userId?: string, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise { + return localVarFp.headUserImage(userId, tag, format, maxWidth, maxHeight, percentPlayed, unplayedCount, width, height, quality, fillWidth, fillHeight, blur, backgroundColor, foregroundLayer, imageIndex, options).then((request) => request(axios, basePath)); }, /** * * @summary Sets the user image. - * @param {string} userId User Id. - * @param {ImageType} imageType (Unused) Image type. - * @param {number} [index] (Unused) Image index. + * @param {string} [userId] User Id. * @param {any} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - postUserImage(userId: string, imageType: ImageType, index?: number, body?: any, options?: any): AxiosPromise { - return localVarFp.postUserImage(userId, imageType, index, body, options).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Sets the user image. - * @param {string} userId User Id. - * @param {ImageType} imageType (Unused) Image type. - * @param {number} index (Unused) Image index. - * @param {any} [body] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - postUserImageByIndex(userId: string, imageType: ImageType, index: number, body?: any, options?: any): AxiosPromise { - return localVarFp.postUserImageByIndex(userId, imageType, index, body, options).then((request) => request(axios, basePath)); + postUserImage(userId?: string, body?: any, options?: any): AxiosPromise { + return localVarFp.postUserImage(userId, body, options).then((request) => request(axios, basePath)); }, /** * @@ -6096,49 +5194,7 @@ export interface ImageApiDeleteUserImageRequest { * @type {string} * @memberof ImageApiDeleteUserImage */ - readonly userId: string - - /** - * (Unused) Image type. - * @type {ImageType} - * @memberof ImageApiDeleteUserImage - */ - readonly imageType: ImageType - - /** - * (Unused) Image index. - * @type {number} - * @memberof ImageApiDeleteUserImage - */ - readonly index?: number -} - -/** - * Request parameters for deleteUserImageByIndex operation in ImageApi. - * @export - * @interface ImageApiDeleteUserImageByIndexRequest - */ -export interface ImageApiDeleteUserImageByIndexRequest { - /** - * User Id. - * @type {string} - * @memberof ImageApiDeleteUserImageByIndex - */ - readonly userId: string - - /** - * (Unused) Image type. - * @type {ImageType} - * @memberof ImageApiDeleteUserImageByIndex - */ - readonly imageType: ImageType - - /** - * (Unused) Image index. - * @type {number} - * @memberof ImageApiDeleteUserImageByIndex - */ - readonly index: number + readonly userId?: string } /** @@ -6245,20 +5301,6 @@ export interface ImageApiGetArtistImageRequest { */ readonly fillHeight?: number - /** - * Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @type {boolean} - * @memberof ImageApiGetArtistImage - */ - readonly cropWhitespace?: boolean - - /** - * Optional. Add a played indicator. - * @type {boolean} - * @memberof ImageApiGetArtistImage - */ - readonly addPlayedIndicator?: boolean - /** * Optional. Blur image. * @type {number} @@ -6378,20 +5420,6 @@ export interface ImageApiGetGenreImageRequest { */ readonly fillHeight?: number - /** - * Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @type {boolean} - * @memberof ImageApiGetGenreImage - */ - readonly cropWhitespace?: boolean - - /** - * Optional. Add a played indicator. - * @type {boolean} - * @memberof ImageApiGetGenreImage - */ - readonly addPlayedIndicator?: boolean - /** * Optional. Blur image. * @type {number} @@ -6525,20 +5553,6 @@ export interface ImageApiGetGenreImageByIndexRequest { */ readonly fillHeight?: number - /** - * Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @type {boolean} - * @memberof ImageApiGetGenreImageByIndex - */ - readonly cropWhitespace?: boolean - - /** - * Optional. Add a played indicator. - * @type {boolean} - * @memberof ImageApiGetGenreImageByIndex - */ - readonly addPlayedIndicator?: boolean - /** * Optional. Blur image. * @type {number} @@ -6637,13 +5651,6 @@ export interface ImageApiGetItemImageRequest { */ readonly tag?: string - /** - * Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @type {boolean} - * @memberof ImageApiGetItemImage - */ - readonly cropWhitespace?: boolean - /** * Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. * @type {ImageFormat} @@ -6651,13 +5658,6 @@ export interface ImageApiGetItemImageRequest { */ readonly format?: ImageFormat - /** - * Optional. Add a played indicator. - * @type {boolean} - * @memberof ImageApiGetItemImage - */ - readonly addPlayedIndicator?: boolean - /** * Optional. Percent to render for the percent played overlay. * @type {number} @@ -6805,20 +5805,6 @@ export interface ImageApiGetItemImage2Request { */ readonly fillHeight?: number - /** - * Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @type {boolean} - * @memberof ImageApiGetItemImage2 - */ - readonly cropWhitespace?: boolean - - /** - * Optional. Add a played indicator. - * @type {boolean} - * @memberof ImageApiGetItemImage2 - */ - readonly addPlayedIndicator?: boolean - /** * Optional. Blur image. * @type {number} @@ -6924,13 +5910,6 @@ export interface ImageApiGetItemImageByIndexRequest { */ readonly tag?: string - /** - * Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @type {boolean} - * @memberof ImageApiGetItemImageByIndex - */ - readonly cropWhitespace?: boolean - /** * Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. * @type {ImageFormat} @@ -6938,13 +5917,6 @@ export interface ImageApiGetItemImageByIndexRequest { */ readonly format?: ImageFormat - /** - * Optional. Add a played indicator. - * @type {boolean} - * @memberof ImageApiGetItemImageByIndex - */ - readonly addPlayedIndicator?: boolean - /** * Optional. Percent to render for the percent played overlay. * @type {number} @@ -7092,20 +6064,6 @@ export interface ImageApiGetMusicGenreImageRequest { */ readonly fillHeight?: number - /** - * Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @type {boolean} - * @memberof ImageApiGetMusicGenreImage - */ - readonly cropWhitespace?: boolean - - /** - * Optional. Add a played indicator. - * @type {boolean} - * @memberof ImageApiGetMusicGenreImage - */ - readonly addPlayedIndicator?: boolean - /** * Optional. Blur image. * @type {number} @@ -7239,20 +6197,6 @@ export interface ImageApiGetMusicGenreImageByIndexRequest { */ readonly fillHeight?: number - /** - * Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @type {boolean} - * @memberof ImageApiGetMusicGenreImageByIndex - */ - readonly cropWhitespace?: boolean - - /** - * Optional. Add a played indicator. - * @type {boolean} - * @memberof ImageApiGetMusicGenreImageByIndex - */ - readonly addPlayedIndicator?: boolean - /** * Optional. Blur image. * @type {number} @@ -7372,20 +6316,6 @@ export interface ImageApiGetPersonImageRequest { */ readonly fillHeight?: number - /** - * Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @type {boolean} - * @memberof ImageApiGetPersonImage - */ - readonly cropWhitespace?: boolean - - /** - * Optional. Add a played indicator. - * @type {boolean} - * @memberof ImageApiGetPersonImage - */ - readonly addPlayedIndicator?: boolean - /** * Optional. Blur image. * @type {number} @@ -7519,20 +6449,6 @@ export interface ImageApiGetPersonImageByIndexRequest { */ readonly fillHeight?: number - /** - * Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @type {boolean} - * @memberof ImageApiGetPersonImageByIndex - */ - readonly cropWhitespace?: boolean - - /** - * Optional. Add a played indicator. - * @type {boolean} - * @memberof ImageApiGetPersonImageByIndex - */ - readonly addPlayedIndicator?: boolean - /** * Optional. Blur image. * @type {number} @@ -7743,20 +6659,6 @@ export interface ImageApiGetStudioImageRequest { */ readonly fillHeight?: number - /** - * Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @type {boolean} - * @memberof ImageApiGetStudioImage - */ - readonly cropWhitespace?: boolean - - /** - * Optional. Add a played indicator. - * @type {boolean} - * @memberof ImageApiGetStudioImage - */ - readonly addPlayedIndicator?: boolean - /** * Optional. Blur image. * @type {number} @@ -7890,20 +6792,6 @@ export interface ImageApiGetStudioImageByIndexRequest { */ readonly fillHeight?: number - /** - * Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @type {boolean} - * @memberof ImageApiGetStudioImageByIndex - */ - readonly cropWhitespace?: boolean - - /** - * Optional. Add a played indicator. - * @type {boolean} - * @memberof ImageApiGetStudioImageByIndex - */ - readonly addPlayedIndicator?: boolean - /** * Optional. Blur image. * @type {number} @@ -7937,14 +6825,7 @@ export interface ImageApiGetUserImageRequest { * @type {string} * @memberof ImageApiGetUserImage */ - readonly userId: string - - /** - * Image type. - * @type {ImageType} - * @memberof ImageApiGetUserImage - */ - readonly imageType: ImageType + readonly userId?: string /** * Optional. Supply the cache tag from the item object to receive strong caching headers. @@ -8023,20 +6904,6 @@ export interface ImageApiGetUserImageRequest { */ readonly fillHeight?: number - /** - * Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @type {boolean} - * @memberof ImageApiGetUserImage - */ - readonly cropWhitespace?: boolean - - /** - * Optional. Add a played indicator. - * @type {boolean} - * @memberof ImageApiGetUserImage - */ - readonly addPlayedIndicator?: boolean - /** * Optional. Blur image. * @type {number} @@ -8066,146 +6933,6 @@ export interface ImageApiGetUserImageRequest { readonly imageIndex?: number } -/** - * Request parameters for getUserImageByIndex operation in ImageApi. - * @export - * @interface ImageApiGetUserImageByIndexRequest - */ -export interface ImageApiGetUserImageByIndexRequest { - /** - * User id. - * @type {string} - * @memberof ImageApiGetUserImageByIndex - */ - readonly userId: string - - /** - * Image type. - * @type {ImageType} - * @memberof ImageApiGetUserImageByIndex - */ - readonly imageType: ImageType - - /** - * Image index. - * @type {number} - * @memberof ImageApiGetUserImageByIndex - */ - readonly imageIndex: number - - /** - * Optional. Supply the cache tag from the item object to receive strong caching headers. - * @type {string} - * @memberof ImageApiGetUserImageByIndex - */ - readonly tag?: string - - /** - * Determines the output format of the image - original,gif,jpg,png. - * @type {ImageFormat} - * @memberof ImageApiGetUserImageByIndex - */ - readonly format?: ImageFormat - - /** - * The maximum image width to return. - * @type {number} - * @memberof ImageApiGetUserImageByIndex - */ - readonly maxWidth?: number - - /** - * The maximum image height to return. - * @type {number} - * @memberof ImageApiGetUserImageByIndex - */ - readonly maxHeight?: number - - /** - * Optional. Percent to render for the percent played overlay. - * @type {number} - * @memberof ImageApiGetUserImageByIndex - */ - readonly percentPlayed?: number - - /** - * Optional. Unplayed count overlay to render. - * @type {number} - * @memberof ImageApiGetUserImageByIndex - */ - readonly unplayedCount?: number - - /** - * The fixed image width to return. - * @type {number} - * @memberof ImageApiGetUserImageByIndex - */ - readonly width?: number - - /** - * The fixed image height to return. - * @type {number} - * @memberof ImageApiGetUserImageByIndex - */ - readonly height?: number - - /** - * Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - * @type {number} - * @memberof ImageApiGetUserImageByIndex - */ - readonly quality?: number - - /** - * Width of box to fill. - * @type {number} - * @memberof ImageApiGetUserImageByIndex - */ - readonly fillWidth?: number - - /** - * Height of box to fill. - * @type {number} - * @memberof ImageApiGetUserImageByIndex - */ - readonly fillHeight?: number - - /** - * Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @type {boolean} - * @memberof ImageApiGetUserImageByIndex - */ - readonly cropWhitespace?: boolean - - /** - * Optional. Add a played indicator. - * @type {boolean} - * @memberof ImageApiGetUserImageByIndex - */ - readonly addPlayedIndicator?: boolean - - /** - * Optional. Blur image. - * @type {number} - * @memberof ImageApiGetUserImageByIndex - */ - readonly blur?: number - - /** - * Optional. Apply a background color for transparent images. - * @type {string} - * @memberof ImageApiGetUserImageByIndex - */ - readonly backgroundColor?: string - - /** - * Optional. Apply a foreground layer on top of the image. - * @type {string} - * @memberof ImageApiGetUserImageByIndex - */ - readonly foregroundLayer?: string -} - /** * Request parameters for headArtistImage operation in ImageApi. * @export @@ -8310,20 +7037,6 @@ export interface ImageApiHeadArtistImageRequest { */ readonly fillHeight?: number - /** - * Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @type {boolean} - * @memberof ImageApiHeadArtistImage - */ - readonly cropWhitespace?: boolean - - /** - * Optional. Add a played indicator. - * @type {boolean} - * @memberof ImageApiHeadArtistImage - */ - readonly addPlayedIndicator?: boolean - /** * Optional. Blur image. * @type {number} @@ -8443,20 +7156,6 @@ export interface ImageApiHeadGenreImageRequest { */ readonly fillHeight?: number - /** - * Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @type {boolean} - * @memberof ImageApiHeadGenreImage - */ - readonly cropWhitespace?: boolean - - /** - * Optional. Add a played indicator. - * @type {boolean} - * @memberof ImageApiHeadGenreImage - */ - readonly addPlayedIndicator?: boolean - /** * Optional. Blur image. * @type {number} @@ -8590,20 +7289,6 @@ export interface ImageApiHeadGenreImageByIndexRequest { */ readonly fillHeight?: number - /** - * Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @type {boolean} - * @memberof ImageApiHeadGenreImageByIndex - */ - readonly cropWhitespace?: boolean - - /** - * Optional. Add a played indicator. - * @type {boolean} - * @memberof ImageApiHeadGenreImageByIndex - */ - readonly addPlayedIndicator?: boolean - /** * Optional. Blur image. * @type {number} @@ -8702,13 +7387,6 @@ export interface ImageApiHeadItemImageRequest { */ readonly tag?: string - /** - * Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @type {boolean} - * @memberof ImageApiHeadItemImage - */ - readonly cropWhitespace?: boolean - /** * Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. * @type {ImageFormat} @@ -8716,13 +7394,6 @@ export interface ImageApiHeadItemImageRequest { */ readonly format?: ImageFormat - /** - * Optional. Add a played indicator. - * @type {boolean} - * @memberof ImageApiHeadItemImage - */ - readonly addPlayedIndicator?: boolean - /** * Optional. Percent to render for the percent played overlay. * @type {number} @@ -8870,20 +7541,6 @@ export interface ImageApiHeadItemImage2Request { */ readonly fillHeight?: number - /** - * Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @type {boolean} - * @memberof ImageApiHeadItemImage2 - */ - readonly cropWhitespace?: boolean - - /** - * Optional. Add a played indicator. - * @type {boolean} - * @memberof ImageApiHeadItemImage2 - */ - readonly addPlayedIndicator?: boolean - /** * Optional. Blur image. * @type {number} @@ -8989,13 +7646,6 @@ export interface ImageApiHeadItemImageByIndexRequest { */ readonly tag?: string - /** - * Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @type {boolean} - * @memberof ImageApiHeadItemImageByIndex - */ - readonly cropWhitespace?: boolean - /** * Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image. * @type {ImageFormat} @@ -9003,13 +7653,6 @@ export interface ImageApiHeadItemImageByIndexRequest { */ readonly format?: ImageFormat - /** - * Optional. Add a played indicator. - * @type {boolean} - * @memberof ImageApiHeadItemImageByIndex - */ - readonly addPlayedIndicator?: boolean - /** * Optional. Percent to render for the percent played overlay. * @type {number} @@ -9143,20 +7786,6 @@ export interface ImageApiHeadMusicGenreImageRequest { */ readonly fillHeight?: number - /** - * Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @type {boolean} - * @memberof ImageApiHeadMusicGenreImage - */ - readonly cropWhitespace?: boolean - - /** - * Optional. Add a played indicator. - * @type {boolean} - * @memberof ImageApiHeadMusicGenreImage - */ - readonly addPlayedIndicator?: boolean - /** * Optional. Blur image. * @type {number} @@ -9290,20 +7919,6 @@ export interface ImageApiHeadMusicGenreImageByIndexRequest { */ readonly fillHeight?: number - /** - * Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @type {boolean} - * @memberof ImageApiHeadMusicGenreImageByIndex - */ - readonly cropWhitespace?: boolean - - /** - * Optional. Add a played indicator. - * @type {boolean} - * @memberof ImageApiHeadMusicGenreImageByIndex - */ - readonly addPlayedIndicator?: boolean - /** * Optional. Blur image. * @type {number} @@ -9423,20 +8038,6 @@ export interface ImageApiHeadPersonImageRequest { */ readonly fillHeight?: number - /** - * Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @type {boolean} - * @memberof ImageApiHeadPersonImage - */ - readonly cropWhitespace?: boolean - - /** - * Optional. Add a played indicator. - * @type {boolean} - * @memberof ImageApiHeadPersonImage - */ - readonly addPlayedIndicator?: boolean - /** * Optional. Blur image. * @type {number} @@ -9570,20 +8171,6 @@ export interface ImageApiHeadPersonImageByIndexRequest { */ readonly fillHeight?: number - /** - * Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @type {boolean} - * @memberof ImageApiHeadPersonImageByIndex - */ - readonly cropWhitespace?: boolean - - /** - * Optional. Add a played indicator. - * @type {boolean} - * @memberof ImageApiHeadPersonImageByIndex - */ - readonly addPlayedIndicator?: boolean - /** * Optional. Blur image. * @type {number} @@ -9703,20 +8290,6 @@ export interface ImageApiHeadStudioImageRequest { */ readonly fillHeight?: number - /** - * Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @type {boolean} - * @memberof ImageApiHeadStudioImage - */ - readonly cropWhitespace?: boolean - - /** - * Optional. Add a played indicator. - * @type {boolean} - * @memberof ImageApiHeadStudioImage - */ - readonly addPlayedIndicator?: boolean - /** * Optional. Blur image. * @type {number} @@ -9850,20 +8423,6 @@ export interface ImageApiHeadStudioImageByIndexRequest { */ readonly fillHeight?: number - /** - * Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @type {boolean} - * @memberof ImageApiHeadStudioImageByIndex - */ - readonly cropWhitespace?: boolean - - /** - * Optional. Add a played indicator. - * @type {boolean} - * @memberof ImageApiHeadStudioImageByIndex - */ - readonly addPlayedIndicator?: boolean - /** * Optional. Blur image. * @type {number} @@ -9897,14 +8456,7 @@ export interface ImageApiHeadUserImageRequest { * @type {string} * @memberof ImageApiHeadUserImage */ - readonly userId: string - - /** - * Image type. - * @type {ImageType} - * @memberof ImageApiHeadUserImage - */ - readonly imageType: ImageType + readonly userId?: string /** * Optional. Supply the cache tag from the item object to receive strong caching headers. @@ -9983,20 +8535,6 @@ export interface ImageApiHeadUserImageRequest { */ readonly fillHeight?: number - /** - * Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @type {boolean} - * @memberof ImageApiHeadUserImage - */ - readonly cropWhitespace?: boolean - - /** - * Optional. Add a played indicator. - * @type {boolean} - * @memberof ImageApiHeadUserImage - */ - readonly addPlayedIndicator?: boolean - /** * Optional. Blur image. * @type {number} @@ -10026,146 +8564,6 @@ export interface ImageApiHeadUserImageRequest { readonly imageIndex?: number } -/** - * Request parameters for headUserImageByIndex operation in ImageApi. - * @export - * @interface ImageApiHeadUserImageByIndexRequest - */ -export interface ImageApiHeadUserImageByIndexRequest { - /** - * User id. - * @type {string} - * @memberof ImageApiHeadUserImageByIndex - */ - readonly userId: string - - /** - * Image type. - * @type {ImageType} - * @memberof ImageApiHeadUserImageByIndex - */ - readonly imageType: ImageType - - /** - * Image index. - * @type {number} - * @memberof ImageApiHeadUserImageByIndex - */ - readonly imageIndex: number - - /** - * Optional. Supply the cache tag from the item object to receive strong caching headers. - * @type {string} - * @memberof ImageApiHeadUserImageByIndex - */ - readonly tag?: string - - /** - * Determines the output format of the image - original,gif,jpg,png. - * @type {ImageFormat} - * @memberof ImageApiHeadUserImageByIndex - */ - readonly format?: ImageFormat - - /** - * The maximum image width to return. - * @type {number} - * @memberof ImageApiHeadUserImageByIndex - */ - readonly maxWidth?: number - - /** - * The maximum image height to return. - * @type {number} - * @memberof ImageApiHeadUserImageByIndex - */ - readonly maxHeight?: number - - /** - * Optional. Percent to render for the percent played overlay. - * @type {number} - * @memberof ImageApiHeadUserImageByIndex - */ - readonly percentPlayed?: number - - /** - * Optional. Unplayed count overlay to render. - * @type {number} - * @memberof ImageApiHeadUserImageByIndex - */ - readonly unplayedCount?: number - - /** - * The fixed image width to return. - * @type {number} - * @memberof ImageApiHeadUserImageByIndex - */ - readonly width?: number - - /** - * The fixed image height to return. - * @type {number} - * @memberof ImageApiHeadUserImageByIndex - */ - readonly height?: number - - /** - * Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases. - * @type {number} - * @memberof ImageApiHeadUserImageByIndex - */ - readonly quality?: number - - /** - * Width of box to fill. - * @type {number} - * @memberof ImageApiHeadUserImageByIndex - */ - readonly fillWidth?: number - - /** - * Height of box to fill. - * @type {number} - * @memberof ImageApiHeadUserImageByIndex - */ - readonly fillHeight?: number - - /** - * Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art. - * @type {boolean} - * @memberof ImageApiHeadUserImageByIndex - */ - readonly cropWhitespace?: boolean - - /** - * Optional. Add a played indicator. - * @type {boolean} - * @memberof ImageApiHeadUserImageByIndex - */ - readonly addPlayedIndicator?: boolean - - /** - * Optional. Blur image. - * @type {number} - * @memberof ImageApiHeadUserImageByIndex - */ - readonly blur?: number - - /** - * Optional. Apply a background color for transparent images. - * @type {string} - * @memberof ImageApiHeadUserImageByIndex - */ - readonly backgroundColor?: string - - /** - * Optional. Apply a foreground layer on top of the image. - * @type {string} - * @memberof ImageApiHeadUserImageByIndex - */ - readonly foregroundLayer?: string -} - /** * Request parameters for postUserImage operation in ImageApi. * @export @@ -10177,21 +8575,7 @@ export interface ImageApiPostUserImageRequest { * @type {string} * @memberof ImageApiPostUserImage */ - readonly userId: string - - /** - * (Unused) Image type. - * @type {ImageType} - * @memberof ImageApiPostUserImage - */ - readonly imageType: ImageType - - /** - * (Unused) Image index. - * @type {number} - * @memberof ImageApiPostUserImage - */ - readonly index?: number + readonly userId?: string /** * @@ -10201,41 +8585,6 @@ export interface ImageApiPostUserImageRequest { readonly body?: any } -/** - * Request parameters for postUserImageByIndex operation in ImageApi. - * @export - * @interface ImageApiPostUserImageByIndexRequest - */ -export interface ImageApiPostUserImageByIndexRequest { - /** - * User Id. - * @type {string} - * @memberof ImageApiPostUserImageByIndex - */ - readonly userId: string - - /** - * (Unused) Image type. - * @type {ImageType} - * @memberof ImageApiPostUserImageByIndex - */ - readonly imageType: ImageType - - /** - * (Unused) Image index. - * @type {number} - * @memberof ImageApiPostUserImageByIndex - */ - readonly index: number - - /** - * - * @type {any} - * @memberof ImageApiPostUserImageByIndex - */ - readonly body?: any -} - /** * Request parameters for setItemImage operation in ImageApi. * @export @@ -10398,20 +8747,8 @@ export class ImageApi extends BaseAPI { * @throws {RequiredError} * @memberof ImageApi */ - public deleteUserImage(requestParameters: ImageApiDeleteUserImageRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).deleteUserImage(requestParameters.userId, requestParameters.imageType, requestParameters.index, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Delete the user\'s image. - * @param {ImageApiDeleteUserImageByIndexRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ImageApi - */ - public deleteUserImageByIndex(requestParameters: ImageApiDeleteUserImageByIndexRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).deleteUserImageByIndex(requestParameters.userId, requestParameters.imageType, requestParameters.index, options).then((request) => request(this.axios, this.basePath)); + public deleteUserImage(requestParameters: ImageApiDeleteUserImageRequest = {}, options?: AxiosRequestConfig) { + return ImageApiFp(this.configuration).deleteUserImage(requestParameters.userId, options).then((request) => request(this.axios, this.basePath)); } /** @@ -10423,7 +8760,7 @@ export class ImageApi extends BaseAPI { * @memberof ImageApi */ public getArtistImage(requestParameters: ImageApiGetArtistImageRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).getArtistImage(requestParameters.name, requestParameters.imageType, requestParameters.imageIndex, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.cropWhitespace, requestParameters.addPlayedIndicator, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); + return ImageApiFp(this.configuration).getArtistImage(requestParameters.name, requestParameters.imageType, requestParameters.imageIndex, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); } /** @@ -10435,7 +8772,7 @@ export class ImageApi extends BaseAPI { * @memberof ImageApi */ public getGenreImage(requestParameters: ImageApiGetGenreImageRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).getGenreImage(requestParameters.name, requestParameters.imageType, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.cropWhitespace, requestParameters.addPlayedIndicator, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, requestParameters.imageIndex, options).then((request) => request(this.axios, this.basePath)); + return ImageApiFp(this.configuration).getGenreImage(requestParameters.name, requestParameters.imageType, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, requestParameters.imageIndex, options).then((request) => request(this.axios, this.basePath)); } /** @@ -10447,7 +8784,7 @@ export class ImageApi extends BaseAPI { * @memberof ImageApi */ public getGenreImageByIndex(requestParameters: ImageApiGetGenreImageByIndexRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).getGenreImageByIndex(requestParameters.name, requestParameters.imageType, requestParameters.imageIndex, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.cropWhitespace, requestParameters.addPlayedIndicator, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); + return ImageApiFp(this.configuration).getGenreImageByIndex(requestParameters.name, requestParameters.imageType, requestParameters.imageIndex, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); } /** @@ -10459,7 +8796,7 @@ export class ImageApi extends BaseAPI { * @memberof ImageApi */ public getItemImage(requestParameters: ImageApiGetItemImageRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).getItemImage(requestParameters.itemId, requestParameters.imageType, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.tag, requestParameters.cropWhitespace, requestParameters.format, requestParameters.addPlayedIndicator, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, requestParameters.imageIndex, options).then((request) => request(this.axios, this.basePath)); + return ImageApiFp(this.configuration).getItemImage(requestParameters.itemId, requestParameters.imageType, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.tag, requestParameters.format, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, requestParameters.imageIndex, options).then((request) => request(this.axios, this.basePath)); } /** @@ -10471,7 +8808,7 @@ export class ImageApi extends BaseAPI { * @memberof ImageApi */ public getItemImage2(requestParameters: ImageApiGetItemImage2Request, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).getItemImage2(requestParameters.itemId, requestParameters.imageType, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.tag, requestParameters.format, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.imageIndex, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.cropWhitespace, requestParameters.addPlayedIndicator, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); + return ImageApiFp(this.configuration).getItemImage2(requestParameters.itemId, requestParameters.imageType, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.tag, requestParameters.format, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.imageIndex, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); } /** @@ -10483,7 +8820,7 @@ export class ImageApi extends BaseAPI { * @memberof ImageApi */ public getItemImageByIndex(requestParameters: ImageApiGetItemImageByIndexRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).getItemImageByIndex(requestParameters.itemId, requestParameters.imageType, requestParameters.imageIndex, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.tag, requestParameters.cropWhitespace, requestParameters.format, requestParameters.addPlayedIndicator, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); + return ImageApiFp(this.configuration).getItemImageByIndex(requestParameters.itemId, requestParameters.imageType, requestParameters.imageIndex, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.tag, requestParameters.format, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); } /** @@ -10507,7 +8844,7 @@ export class ImageApi extends BaseAPI { * @memberof ImageApi */ public getMusicGenreImage(requestParameters: ImageApiGetMusicGenreImageRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).getMusicGenreImage(requestParameters.name, requestParameters.imageType, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.cropWhitespace, requestParameters.addPlayedIndicator, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, requestParameters.imageIndex, options).then((request) => request(this.axios, this.basePath)); + return ImageApiFp(this.configuration).getMusicGenreImage(requestParameters.name, requestParameters.imageType, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, requestParameters.imageIndex, options).then((request) => request(this.axios, this.basePath)); } /** @@ -10519,7 +8856,7 @@ export class ImageApi extends BaseAPI { * @memberof ImageApi */ public getMusicGenreImageByIndex(requestParameters: ImageApiGetMusicGenreImageByIndexRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).getMusicGenreImageByIndex(requestParameters.name, requestParameters.imageType, requestParameters.imageIndex, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.cropWhitespace, requestParameters.addPlayedIndicator, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); + return ImageApiFp(this.configuration).getMusicGenreImageByIndex(requestParameters.name, requestParameters.imageType, requestParameters.imageIndex, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); } /** @@ -10531,7 +8868,7 @@ export class ImageApi extends BaseAPI { * @memberof ImageApi */ public getPersonImage(requestParameters: ImageApiGetPersonImageRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).getPersonImage(requestParameters.name, requestParameters.imageType, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.cropWhitespace, requestParameters.addPlayedIndicator, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, requestParameters.imageIndex, options).then((request) => request(this.axios, this.basePath)); + return ImageApiFp(this.configuration).getPersonImage(requestParameters.name, requestParameters.imageType, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, requestParameters.imageIndex, options).then((request) => request(this.axios, this.basePath)); } /** @@ -10543,7 +8880,7 @@ export class ImageApi extends BaseAPI { * @memberof ImageApi */ public getPersonImageByIndex(requestParameters: ImageApiGetPersonImageByIndexRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).getPersonImageByIndex(requestParameters.name, requestParameters.imageType, requestParameters.imageIndex, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.cropWhitespace, requestParameters.addPlayedIndicator, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); + return ImageApiFp(this.configuration).getPersonImageByIndex(requestParameters.name, requestParameters.imageType, requestParameters.imageIndex, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); } /** @@ -10567,7 +8904,7 @@ export class ImageApi extends BaseAPI { * @memberof ImageApi */ public getStudioImage(requestParameters: ImageApiGetStudioImageRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).getStudioImage(requestParameters.name, requestParameters.imageType, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.cropWhitespace, requestParameters.addPlayedIndicator, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, requestParameters.imageIndex, options).then((request) => request(this.axios, this.basePath)); + return ImageApiFp(this.configuration).getStudioImage(requestParameters.name, requestParameters.imageType, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, requestParameters.imageIndex, options).then((request) => request(this.axios, this.basePath)); } /** @@ -10579,7 +8916,7 @@ export class ImageApi extends BaseAPI { * @memberof ImageApi */ public getStudioImageByIndex(requestParameters: ImageApiGetStudioImageByIndexRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).getStudioImageByIndex(requestParameters.name, requestParameters.imageType, requestParameters.imageIndex, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.cropWhitespace, requestParameters.addPlayedIndicator, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); + return ImageApiFp(this.configuration).getStudioImageByIndex(requestParameters.name, requestParameters.imageType, requestParameters.imageIndex, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); } /** @@ -10590,20 +8927,8 @@ export class ImageApi extends BaseAPI { * @throws {RequiredError} * @memberof ImageApi */ - public getUserImage(requestParameters: ImageApiGetUserImageRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).getUserImage(requestParameters.userId, requestParameters.imageType, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.cropWhitespace, requestParameters.addPlayedIndicator, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, requestParameters.imageIndex, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Get user profile image. - * @param {ImageApiGetUserImageByIndexRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ImageApi - */ - public getUserImageByIndex(requestParameters: ImageApiGetUserImageByIndexRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).getUserImageByIndex(requestParameters.userId, requestParameters.imageType, requestParameters.imageIndex, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.cropWhitespace, requestParameters.addPlayedIndicator, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); + public getUserImage(requestParameters: ImageApiGetUserImageRequest = {}, options?: AxiosRequestConfig) { + return ImageApiFp(this.configuration).getUserImage(requestParameters.userId, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, requestParameters.imageIndex, options).then((request) => request(this.axios, this.basePath)); } /** @@ -10615,7 +8940,7 @@ export class ImageApi extends BaseAPI { * @memberof ImageApi */ public headArtistImage(requestParameters: ImageApiHeadArtistImageRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).headArtistImage(requestParameters.name, requestParameters.imageType, requestParameters.imageIndex, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.cropWhitespace, requestParameters.addPlayedIndicator, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); + return ImageApiFp(this.configuration).headArtistImage(requestParameters.name, requestParameters.imageType, requestParameters.imageIndex, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); } /** @@ -10627,7 +8952,7 @@ export class ImageApi extends BaseAPI { * @memberof ImageApi */ public headGenreImage(requestParameters: ImageApiHeadGenreImageRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).headGenreImage(requestParameters.name, requestParameters.imageType, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.cropWhitespace, requestParameters.addPlayedIndicator, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, requestParameters.imageIndex, options).then((request) => request(this.axios, this.basePath)); + return ImageApiFp(this.configuration).headGenreImage(requestParameters.name, requestParameters.imageType, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, requestParameters.imageIndex, options).then((request) => request(this.axios, this.basePath)); } /** @@ -10639,7 +8964,7 @@ export class ImageApi extends BaseAPI { * @memberof ImageApi */ public headGenreImageByIndex(requestParameters: ImageApiHeadGenreImageByIndexRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).headGenreImageByIndex(requestParameters.name, requestParameters.imageType, requestParameters.imageIndex, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.cropWhitespace, requestParameters.addPlayedIndicator, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); + return ImageApiFp(this.configuration).headGenreImageByIndex(requestParameters.name, requestParameters.imageType, requestParameters.imageIndex, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); } /** @@ -10651,7 +8976,7 @@ export class ImageApi extends BaseAPI { * @memberof ImageApi */ public headItemImage(requestParameters: ImageApiHeadItemImageRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).headItemImage(requestParameters.itemId, requestParameters.imageType, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.tag, requestParameters.cropWhitespace, requestParameters.format, requestParameters.addPlayedIndicator, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, requestParameters.imageIndex, options).then((request) => request(this.axios, this.basePath)); + return ImageApiFp(this.configuration).headItemImage(requestParameters.itemId, requestParameters.imageType, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.tag, requestParameters.format, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, requestParameters.imageIndex, options).then((request) => request(this.axios, this.basePath)); } /** @@ -10663,7 +8988,7 @@ export class ImageApi extends BaseAPI { * @memberof ImageApi */ public headItemImage2(requestParameters: ImageApiHeadItemImage2Request, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).headItemImage2(requestParameters.itemId, requestParameters.imageType, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.tag, requestParameters.format, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.imageIndex, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.cropWhitespace, requestParameters.addPlayedIndicator, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); + return ImageApiFp(this.configuration).headItemImage2(requestParameters.itemId, requestParameters.imageType, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.tag, requestParameters.format, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.imageIndex, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); } /** @@ -10675,7 +9000,7 @@ export class ImageApi extends BaseAPI { * @memberof ImageApi */ public headItemImageByIndex(requestParameters: ImageApiHeadItemImageByIndexRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).headItemImageByIndex(requestParameters.itemId, requestParameters.imageType, requestParameters.imageIndex, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.tag, requestParameters.cropWhitespace, requestParameters.format, requestParameters.addPlayedIndicator, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); + return ImageApiFp(this.configuration).headItemImageByIndex(requestParameters.itemId, requestParameters.imageType, requestParameters.imageIndex, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.tag, requestParameters.format, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); } /** @@ -10687,7 +9012,7 @@ export class ImageApi extends BaseAPI { * @memberof ImageApi */ public headMusicGenreImage(requestParameters: ImageApiHeadMusicGenreImageRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).headMusicGenreImage(requestParameters.name, requestParameters.imageType, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.cropWhitespace, requestParameters.addPlayedIndicator, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, requestParameters.imageIndex, options).then((request) => request(this.axios, this.basePath)); + return ImageApiFp(this.configuration).headMusicGenreImage(requestParameters.name, requestParameters.imageType, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, requestParameters.imageIndex, options).then((request) => request(this.axios, this.basePath)); } /** @@ -10699,7 +9024,7 @@ export class ImageApi extends BaseAPI { * @memberof ImageApi */ public headMusicGenreImageByIndex(requestParameters: ImageApiHeadMusicGenreImageByIndexRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).headMusicGenreImageByIndex(requestParameters.name, requestParameters.imageType, requestParameters.imageIndex, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.cropWhitespace, requestParameters.addPlayedIndicator, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); + return ImageApiFp(this.configuration).headMusicGenreImageByIndex(requestParameters.name, requestParameters.imageType, requestParameters.imageIndex, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); } /** @@ -10711,7 +9036,7 @@ export class ImageApi extends BaseAPI { * @memberof ImageApi */ public headPersonImage(requestParameters: ImageApiHeadPersonImageRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).headPersonImage(requestParameters.name, requestParameters.imageType, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.cropWhitespace, requestParameters.addPlayedIndicator, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, requestParameters.imageIndex, options).then((request) => request(this.axios, this.basePath)); + return ImageApiFp(this.configuration).headPersonImage(requestParameters.name, requestParameters.imageType, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, requestParameters.imageIndex, options).then((request) => request(this.axios, this.basePath)); } /** @@ -10723,7 +9048,7 @@ export class ImageApi extends BaseAPI { * @memberof ImageApi */ public headPersonImageByIndex(requestParameters: ImageApiHeadPersonImageByIndexRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).headPersonImageByIndex(requestParameters.name, requestParameters.imageType, requestParameters.imageIndex, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.cropWhitespace, requestParameters.addPlayedIndicator, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); + return ImageApiFp(this.configuration).headPersonImageByIndex(requestParameters.name, requestParameters.imageType, requestParameters.imageIndex, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); } /** @@ -10735,7 +9060,7 @@ export class ImageApi extends BaseAPI { * @memberof ImageApi */ public headStudioImage(requestParameters: ImageApiHeadStudioImageRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).headStudioImage(requestParameters.name, requestParameters.imageType, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.cropWhitespace, requestParameters.addPlayedIndicator, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, requestParameters.imageIndex, options).then((request) => request(this.axios, this.basePath)); + return ImageApiFp(this.configuration).headStudioImage(requestParameters.name, requestParameters.imageType, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, requestParameters.imageIndex, options).then((request) => request(this.axios, this.basePath)); } /** @@ -10747,7 +9072,7 @@ export class ImageApi extends BaseAPI { * @memberof ImageApi */ public headStudioImageByIndex(requestParameters: ImageApiHeadStudioImageByIndexRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).headStudioImageByIndex(requestParameters.name, requestParameters.imageType, requestParameters.imageIndex, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.cropWhitespace, requestParameters.addPlayedIndicator, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); + return ImageApiFp(this.configuration).headStudioImageByIndex(requestParameters.name, requestParameters.imageType, requestParameters.imageIndex, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); } /** @@ -10758,20 +9083,8 @@ export class ImageApi extends BaseAPI { * @throws {RequiredError} * @memberof ImageApi */ - public headUserImage(requestParameters: ImageApiHeadUserImageRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).headUserImage(requestParameters.userId, requestParameters.imageType, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.cropWhitespace, requestParameters.addPlayedIndicator, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, requestParameters.imageIndex, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Get user profile image. - * @param {ImageApiHeadUserImageByIndexRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ImageApi - */ - public headUserImageByIndex(requestParameters: ImageApiHeadUserImageByIndexRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).headUserImageByIndex(requestParameters.userId, requestParameters.imageType, requestParameters.imageIndex, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.cropWhitespace, requestParameters.addPlayedIndicator, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, options).then((request) => request(this.axios, this.basePath)); + public headUserImage(requestParameters: ImageApiHeadUserImageRequest = {}, options?: AxiosRequestConfig) { + return ImageApiFp(this.configuration).headUserImage(requestParameters.userId, requestParameters.tag, requestParameters.format, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.percentPlayed, requestParameters.unplayedCount, requestParameters.width, requestParameters.height, requestParameters.quality, requestParameters.fillWidth, requestParameters.fillHeight, requestParameters.blur, requestParameters.backgroundColor, requestParameters.foregroundLayer, requestParameters.imageIndex, options).then((request) => request(this.axios, this.basePath)); } /** @@ -10782,20 +9095,8 @@ export class ImageApi extends BaseAPI { * @throws {RequiredError} * @memberof ImageApi */ - public postUserImage(requestParameters: ImageApiPostUserImageRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).postUserImage(requestParameters.userId, requestParameters.imageType, requestParameters.index, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Sets the user image. - * @param {ImageApiPostUserImageByIndexRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ImageApi - */ - public postUserImageByIndex(requestParameters: ImageApiPostUserImageByIndexRequest, options?: AxiosRequestConfig) { - return ImageApiFp(this.configuration).postUserImageByIndex(requestParameters.userId, requestParameters.imageType, requestParameters.index, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); + public postUserImage(requestParameters: ImageApiPostUserImageRequest = {}, options?: AxiosRequestConfig) { + return ImageApiFp(this.configuration).postUserImage(requestParameters.userId, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); } /** diff --git a/src/generated-client/api/instant-mix-api.ts b/src/generated-client/api/instant-mix-api.ts index 14645639..a9d1ef4f 100644 --- a/src/generated-client/api/instant-mix-api.ts +++ b/src/generated-client/api/instant-mix-api.ts @@ -25,6 +25,8 @@ import { BaseItemDtoQueryResult } from '../models'; import { ImageType } from '../models'; // @ts-ignore import { ItemFields } from '../models'; +// @ts-ignore +import { ProblemDetails } from '../models'; /** * InstantMixApi - axios parameter creator * @export @@ -34,7 +36,7 @@ export const InstantMixApiAxiosParamCreator = function (configuration?: Configur /** * * @summary Creates an instant playlist based on a given album. - * @param {string} id The item id. + * @param {string} itemId The item id. * @param {string} [userId] Optional. Filter by user id, and attach user data. * @param {number} [limit] Optional. The maximum number of records to return. * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. @@ -45,11 +47,11 @@ export const InstantMixApiAxiosParamCreator = function (configuration?: Configur * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getInstantMixFromAlbum: async (id: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getInstantMixFromAlbum', 'id', id) - const localVarPath = `/Albums/{id}/InstantMix` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); + getInstantMixFromAlbum: async (itemId: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'itemId' is not null or undefined + assertParamExists('getInstantMixFromAlbum', 'itemId', itemId) + const localVarPath = `/Albums/{itemId}/InstantMix` + .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -106,7 +108,7 @@ export const InstantMixApiAxiosParamCreator = function (configuration?: Configur /** * * @summary Creates an instant playlist based on a given artist. - * @param {string} id The item id. + * @param {string} itemId The item id. * @param {string} [userId] Optional. Filter by user id, and attach user data. * @param {number} [limit] Optional. The maximum number of records to return. * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. @@ -117,11 +119,11 @@ export const InstantMixApiAxiosParamCreator = function (configuration?: Configur * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getInstantMixFromArtists: async (id: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getInstantMixFromArtists', 'id', id) - const localVarPath = `/Artists/{id}/InstantMix` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); + getInstantMixFromArtists: async (itemId: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'itemId' is not null or undefined + assertParamExists('getInstantMixFromArtists', 'itemId', itemId) + const localVarPath = `/Artists/{itemId}/InstantMix` + .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -254,7 +256,7 @@ export const InstantMixApiAxiosParamCreator = function (configuration?: Configur /** * * @summary Creates an instant playlist based on a given item. - * @param {string} id The item id. + * @param {string} itemId The item id. * @param {string} [userId] Optional. Filter by user id, and attach user data. * @param {number} [limit] Optional. The maximum number of records to return. * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. @@ -265,11 +267,11 @@ export const InstantMixApiAxiosParamCreator = function (configuration?: Configur * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getInstantMixFromItem: async (id: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getInstantMixFromItem', 'id', id) - const localVarPath = `/Items/{id}/InstantMix` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); + getInstantMixFromItem: async (itemId: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'itemId' is not null or undefined + assertParamExists('getInstantMixFromItem', 'itemId', itemId) + const localVarPath = `/Items/{itemId}/InstantMix` + .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -473,7 +475,7 @@ export const InstantMixApiAxiosParamCreator = function (configuration?: Configur /** * * @summary Creates an instant playlist based on a given playlist. - * @param {string} id The item id. + * @param {string} itemId The item id. * @param {string} [userId] Optional. Filter by user id, and attach user data. * @param {number} [limit] Optional. The maximum number of records to return. * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. @@ -484,11 +486,11 @@ export const InstantMixApiAxiosParamCreator = function (configuration?: Configur * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getInstantMixFromPlaylist: async (id: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getInstantMixFromPlaylist', 'id', id) - const localVarPath = `/Playlists/{id}/InstantMix` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); + getInstantMixFromPlaylist: async (itemId: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'itemId' is not null or undefined + assertParamExists('getInstantMixFromPlaylist', 'itemId', itemId) + const localVarPath = `/Playlists/{itemId}/InstantMix` + .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -545,7 +547,7 @@ export const InstantMixApiAxiosParamCreator = function (configuration?: Configur /** * * @summary Creates an instant playlist based on a given song. - * @param {string} id The item id. + * @param {string} itemId The item id. * @param {string} [userId] Optional. Filter by user id, and attach user data. * @param {number} [limit] Optional. The maximum number of records to return. * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. @@ -556,11 +558,11 @@ export const InstantMixApiAxiosParamCreator = function (configuration?: Configur * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getInstantMixFromSong: async (id: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getInstantMixFromSong', 'id', id) - const localVarPath = `/Songs/{id}/InstantMix` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); + getInstantMixFromSong: async (itemId: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'itemId' is not null or undefined + assertParamExists('getInstantMixFromSong', 'itemId', itemId) + const localVarPath = `/Songs/{itemId}/InstantMix` + .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -627,7 +629,7 @@ export const InstantMixApiFp = function(configuration?: Configuration) { /** * * @summary Creates an instant playlist based on a given album. - * @param {string} id The item id. + * @param {string} itemId The item id. * @param {string} [userId] Optional. Filter by user id, and attach user data. * @param {number} [limit] Optional. The maximum number of records to return. * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. @@ -638,14 +640,14 @@ export const InstantMixApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getInstantMixFromAlbum(id: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getInstantMixFromAlbum(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options); + async getInstantMixFromAlbum(itemId: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getInstantMixFromAlbum(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * * @summary Creates an instant playlist based on a given artist. - * @param {string} id The item id. + * @param {string} itemId The item id. * @param {string} [userId] Optional. Filter by user id, and attach user data. * @param {number} [limit] Optional. The maximum number of records to return. * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. @@ -656,8 +658,8 @@ export const InstantMixApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getInstantMixFromArtists(id: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getInstantMixFromArtists(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options); + async getInstantMixFromArtists(itemId: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getInstantMixFromArtists(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -682,7 +684,7 @@ export const InstantMixApiFp = function(configuration?: Configuration) { /** * * @summary Creates an instant playlist based on a given item. - * @param {string} id The item id. + * @param {string} itemId The item id. * @param {string} [userId] Optional. Filter by user id, and attach user data. * @param {number} [limit] Optional. The maximum number of records to return. * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. @@ -693,8 +695,8 @@ export const InstantMixApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getInstantMixFromItem(id: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getInstantMixFromItem(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options); + async getInstantMixFromItem(itemId: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getInstantMixFromItem(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -736,7 +738,7 @@ export const InstantMixApiFp = function(configuration?: Configuration) { /** * * @summary Creates an instant playlist based on a given playlist. - * @param {string} id The item id. + * @param {string} itemId The item id. * @param {string} [userId] Optional. Filter by user id, and attach user data. * @param {number} [limit] Optional. The maximum number of records to return. * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. @@ -747,14 +749,14 @@ export const InstantMixApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getInstantMixFromPlaylist(id: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getInstantMixFromPlaylist(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options); + async getInstantMixFromPlaylist(itemId: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getInstantMixFromPlaylist(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * * @summary Creates an instant playlist based on a given song. - * @param {string} id The item id. + * @param {string} itemId The item id. * @param {string} [userId] Optional. Filter by user id, and attach user data. * @param {number} [limit] Optional. The maximum number of records to return. * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. @@ -765,8 +767,8 @@ export const InstantMixApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getInstantMixFromSong(id: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getInstantMixFromSong(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options); + async getInstantMixFromSong(itemId: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getInstantMixFromSong(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, } @@ -782,7 +784,7 @@ export const InstantMixApiFactory = function (configuration?: Configuration, bas /** * * @summary Creates an instant playlist based on a given album. - * @param {string} id The item id. + * @param {string} itemId The item id. * @param {string} [userId] Optional. Filter by user id, and attach user data. * @param {number} [limit] Optional. The maximum number of records to return. * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. @@ -793,13 +795,13 @@ export const InstantMixApiFactory = function (configuration?: Configuration, bas * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getInstantMixFromAlbum(id: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options?: any): AxiosPromise { - return localVarFp.getInstantMixFromAlbum(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options).then((request) => request(axios, basePath)); + getInstantMixFromAlbum(itemId: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options?: any): AxiosPromise { + return localVarFp.getInstantMixFromAlbum(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options).then((request) => request(axios, basePath)); }, /** * * @summary Creates an instant playlist based on a given artist. - * @param {string} id The item id. + * @param {string} itemId The item id. * @param {string} [userId] Optional. Filter by user id, and attach user data. * @param {number} [limit] Optional. The maximum number of records to return. * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. @@ -810,8 +812,8 @@ export const InstantMixApiFactory = function (configuration?: Configuration, bas * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getInstantMixFromArtists(id: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options?: any): AxiosPromise { - return localVarFp.getInstantMixFromArtists(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options).then((request) => request(axios, basePath)); + getInstantMixFromArtists(itemId: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options?: any): AxiosPromise { + return localVarFp.getInstantMixFromArtists(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options).then((request) => request(axios, basePath)); }, /** * @@ -834,7 +836,7 @@ export const InstantMixApiFactory = function (configuration?: Configuration, bas /** * * @summary Creates an instant playlist based on a given item. - * @param {string} id The item id. + * @param {string} itemId The item id. * @param {string} [userId] Optional. Filter by user id, and attach user data. * @param {number} [limit] Optional. The maximum number of records to return. * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. @@ -845,8 +847,8 @@ export const InstantMixApiFactory = function (configuration?: Configuration, bas * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getInstantMixFromItem(id: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options?: any): AxiosPromise { - return localVarFp.getInstantMixFromItem(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options).then((request) => request(axios, basePath)); + getInstantMixFromItem(itemId: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options?: any): AxiosPromise { + return localVarFp.getInstantMixFromItem(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options).then((request) => request(axios, basePath)); }, /** * @@ -885,7 +887,7 @@ export const InstantMixApiFactory = function (configuration?: Configuration, bas /** * * @summary Creates an instant playlist based on a given playlist. - * @param {string} id The item id. + * @param {string} itemId The item id. * @param {string} [userId] Optional. Filter by user id, and attach user data. * @param {number} [limit] Optional. The maximum number of records to return. * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. @@ -896,13 +898,13 @@ export const InstantMixApiFactory = function (configuration?: Configuration, bas * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getInstantMixFromPlaylist(id: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options?: any): AxiosPromise { - return localVarFp.getInstantMixFromPlaylist(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options).then((request) => request(axios, basePath)); + getInstantMixFromPlaylist(itemId: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options?: any): AxiosPromise { + return localVarFp.getInstantMixFromPlaylist(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options).then((request) => request(axios, basePath)); }, /** * * @summary Creates an instant playlist based on a given song. - * @param {string} id The item id. + * @param {string} itemId The item id. * @param {string} [userId] Optional. Filter by user id, and attach user data. * @param {number} [limit] Optional. The maximum number of records to return. * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. @@ -913,8 +915,8 @@ export const InstantMixApiFactory = function (configuration?: Configuration, bas * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getInstantMixFromSong(id: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options?: any): AxiosPromise { - return localVarFp.getInstantMixFromSong(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options).then((request) => request(axios, basePath)); + getInstantMixFromSong(itemId: string, userId?: string, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options?: any): AxiosPromise { + return localVarFp.getInstantMixFromSong(itemId, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options).then((request) => request(axios, basePath)); }, }; }; @@ -930,7 +932,7 @@ export interface InstantMixApiGetInstantMixFromAlbumRequest { * @type {string} * @memberof InstantMixApiGetInstantMixFromAlbum */ - readonly id: string + readonly itemId: string /** * Optional. Filter by user id, and attach user data. @@ -993,7 +995,7 @@ export interface InstantMixApiGetInstantMixFromArtistsRequest { * @type {string} * @memberof InstantMixApiGetInstantMixFromArtists */ - readonly id: string + readonly itemId: string /** * Optional. Filter by user id, and attach user data. @@ -1119,7 +1121,7 @@ export interface InstantMixApiGetInstantMixFromItemRequest { * @type {string} * @memberof InstantMixApiGetInstantMixFromItem */ - readonly id: string + readonly itemId: string /** * Optional. Filter by user id, and attach user data. @@ -1308,7 +1310,7 @@ export interface InstantMixApiGetInstantMixFromPlaylistRequest { * @type {string} * @memberof InstantMixApiGetInstantMixFromPlaylist */ - readonly id: string + readonly itemId: string /** * Optional. Filter by user id, and attach user data. @@ -1371,7 +1373,7 @@ export interface InstantMixApiGetInstantMixFromSongRequest { * @type {string} * @memberof InstantMixApiGetInstantMixFromSong */ - readonly id: string + readonly itemId: string /** * Optional. Filter by user id, and attach user data. @@ -1439,7 +1441,7 @@ export class InstantMixApi extends BaseAPI { * @memberof InstantMixApi */ public getInstantMixFromAlbum(requestParameters: InstantMixApiGetInstantMixFromAlbumRequest, options?: AxiosRequestConfig) { - return InstantMixApiFp(this.configuration).getInstantMixFromAlbum(requestParameters.id, requestParameters.userId, requestParameters.limit, requestParameters.fields, requestParameters.enableImages, requestParameters.enableUserData, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, options).then((request) => request(this.axios, this.basePath)); + return InstantMixApiFp(this.configuration).getInstantMixFromAlbum(requestParameters.itemId, requestParameters.userId, requestParameters.limit, requestParameters.fields, requestParameters.enableImages, requestParameters.enableUserData, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, options).then((request) => request(this.axios, this.basePath)); } /** @@ -1451,7 +1453,7 @@ export class InstantMixApi extends BaseAPI { * @memberof InstantMixApi */ public getInstantMixFromArtists(requestParameters: InstantMixApiGetInstantMixFromArtistsRequest, options?: AxiosRequestConfig) { - return InstantMixApiFp(this.configuration).getInstantMixFromArtists(requestParameters.id, requestParameters.userId, requestParameters.limit, requestParameters.fields, requestParameters.enableImages, requestParameters.enableUserData, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, options).then((request) => request(this.axios, this.basePath)); + return InstantMixApiFp(this.configuration).getInstantMixFromArtists(requestParameters.itemId, requestParameters.userId, requestParameters.limit, requestParameters.fields, requestParameters.enableImages, requestParameters.enableUserData, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, options).then((request) => request(this.axios, this.basePath)); } /** @@ -1476,7 +1478,7 @@ export class InstantMixApi extends BaseAPI { * @memberof InstantMixApi */ public getInstantMixFromItem(requestParameters: InstantMixApiGetInstantMixFromItemRequest, options?: AxiosRequestConfig) { - return InstantMixApiFp(this.configuration).getInstantMixFromItem(requestParameters.id, requestParameters.userId, requestParameters.limit, requestParameters.fields, requestParameters.enableImages, requestParameters.enableUserData, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, options).then((request) => request(this.axios, this.basePath)); + return InstantMixApiFp(this.configuration).getInstantMixFromItem(requestParameters.itemId, requestParameters.userId, requestParameters.limit, requestParameters.fields, requestParameters.enableImages, requestParameters.enableUserData, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, options).then((request) => request(this.axios, this.basePath)); } /** @@ -1512,7 +1514,7 @@ export class InstantMixApi extends BaseAPI { * @memberof InstantMixApi */ public getInstantMixFromPlaylist(requestParameters: InstantMixApiGetInstantMixFromPlaylistRequest, options?: AxiosRequestConfig) { - return InstantMixApiFp(this.configuration).getInstantMixFromPlaylist(requestParameters.id, requestParameters.userId, requestParameters.limit, requestParameters.fields, requestParameters.enableImages, requestParameters.enableUserData, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, options).then((request) => request(this.axios, this.basePath)); + return InstantMixApiFp(this.configuration).getInstantMixFromPlaylist(requestParameters.itemId, requestParameters.userId, requestParameters.limit, requestParameters.fields, requestParameters.enableImages, requestParameters.enableUserData, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, options).then((request) => request(this.axios, this.basePath)); } /** @@ -1524,6 +1526,6 @@ export class InstantMixApi extends BaseAPI { * @memberof InstantMixApi */ public getInstantMixFromSong(requestParameters: InstantMixApiGetInstantMixFromSongRequest, options?: AxiosRequestConfig) { - return InstantMixApiFp(this.configuration).getInstantMixFromSong(requestParameters.id, requestParameters.userId, requestParameters.limit, requestParameters.fields, requestParameters.enableImages, requestParameters.enableUserData, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, options).then((request) => request(this.axios, this.basePath)); + return InstantMixApiFp(this.configuration).getInstantMixFromSong(requestParameters.itemId, requestParameters.userId, requestParameters.limit, requestParameters.fields, requestParameters.enableImages, requestParameters.enableUserData, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/generated-client/api/items-api.ts b/src/generated-client/api/items-api.ts index 6eb47715..5095fed6 100644 --- a/src/generated-client/api/items-api.ts +++ b/src/generated-client/api/items-api.ts @@ -30,12 +30,22 @@ import { ItemFields } from '../models'; // @ts-ignore import { ItemFilter } from '../models'; // @ts-ignore +import { ItemSortBy } from '../models'; +// @ts-ignore import { LocationType } from '../models'; // @ts-ignore +import { MediaType } from '../models'; +// @ts-ignore +import { ProblemDetails } from '../models'; +// @ts-ignore import { SeriesStatus } from '../models'; // @ts-ignore import { SortOrder } from '../models'; // @ts-ignore +import { UpdateUserItemDataDto } from '../models'; +// @ts-ignore +import { UserItemDataDto } from '../models'; +// @ts-ignore import { VideoType } from '../models'; /** * ItemsApi - axios parameter creator @@ -43,10 +53,52 @@ import { VideoType } from '../models'; */ export const ItemsApiAxiosParamCreator = function (configuration?: Configuration) { return { + /** + * + * @summary Get Item User Data. + * @param {string} itemId The item id. + * @param {string} [userId] The user id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getItemUserData: async (itemId: string, userId?: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'itemId' is not null or undefined + assertParamExists('getItemUserData', 'itemId', itemId) + const localVarPath = `/UserItems/{itemId}/UserData` + .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication CustomAuthentication required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + if (userId !== undefined) { + localVarQueryParameter['userId'] = userId; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, /** * * @summary Gets items based on a query. - * @param {string} [userId] The user id supplied as query parameter. + * @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key. * @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc). * @param {boolean} [hasThemeSong] Optional filter by items with theme songs. * @param {boolean} [hasThemeVideo] Optional filter by items with theme videos. @@ -69,9 +121,9 @@ export const ItemsApiAxiosParamCreator = function (configuration?: Configuration * @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO. * @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO. * @param {boolean} [hasOverview] Optional filter by items that have an overview or not. - * @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not. - * @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not. - * @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not. + * @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not. + * @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not. + * @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not. * @param {boolean} [isMovie] Optional filter for live tv movies. * @param {boolean} [isSeries] Optional filter for live tv series. * @param {boolean} [isNews] Optional filter for live tv news. @@ -82,16 +134,16 @@ export const ItemsApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [limit] Optional. The maximum number of records to return. * @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false. * @param {string} [searchTerm] Optional. Filter based on a search term. - * @param {Array} [sortOrder] Sort Order - Ascending,Descending. + * @param {Array} [sortOrder] Sort Order - Ascending, Descending. * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root. * @param {Array} [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. * @param {Array} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. * @param {Array} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited. * @param {Array} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes. * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not. - * @param {Array} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited. + * @param {Array} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited. * @param {Array} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited. - * @param {Array} [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. + * @param {Array} [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. * @param {boolean} [isPlayed] Optional filter by items that are played, or not. * @param {Array} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. * @param {Array} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. @@ -134,7 +186,7 @@ export const ItemsApiAxiosParamCreator = function (configuration?: Configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getItems: async (userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array, excludeLocationTypes?: Array, 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, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, filters?: Array, isFavorite?: boolean, mediaTypes?: Array, imageTypes?: Array, sortBy?: Array, isPlayed?: boolean, genres?: Array, officialRatings?: Array, tags?: Array, years?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, person?: string, personIds?: Array, personTypes?: Array, studios?: Array, artists?: Array, excludeArtistIds?: Array, artistIds?: Array, albumArtistIds?: Array, contributingArtistIds?: Array, albums?: Array, albumIds?: Array, ids?: Array, videoTypes?: Array, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array, genreIds?: Array, enableTotalRecordCount?: boolean, enableImages?: boolean, options: AxiosRequestConfig = {}): Promise => { + getItems: async (userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array, excludeLocationTypes?: Array, 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, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, filters?: Array, isFavorite?: boolean, mediaTypes?: Array, imageTypes?: Array, sortBy?: Array, isPlayed?: boolean, genres?: Array, officialRatings?: Array, tags?: Array, years?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, person?: string, personIds?: Array, personTypes?: Array, studios?: Array, artists?: Array, excludeArtistIds?: Array, artistIds?: Array, albumArtistIds?: Array, contributingArtistIds?: Array, albums?: Array, albumIds?: Array, ids?: Array, videoTypes?: Array, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array, genreIds?: Array, enableTotalRecordCount?: boolean, enableImages?: boolean, options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/Items`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -512,478 +564,13 @@ export const ItemsApiAxiosParamCreator = function (configuration?: Configuration /** * * @summary Gets items based on a query. - * @param {string} userId The user id supplied as query parameter. - * @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc). - * @param {boolean} [hasThemeSong] Optional filter by items with theme songs. - * @param {boolean} [hasThemeVideo] Optional filter by items with theme videos. - * @param {boolean} [hasSubtitles] Optional filter by items with subtitles. - * @param {boolean} [hasSpecialFeature] Optional filter by items with special features. - * @param {boolean} [hasTrailer] Optional filter by items with trailers. - * @param {string} [adjacentTo] Optional. Return items that are siblings of a supplied item. - * @param {number} [parentIndexNumber] Optional filter by parent index number. - * @param {boolean} [hasParentalRating] Optional filter by items that have or do not have a parental rating. - * @param {boolean} [isHd] Optional filter by items that are HD or not. - * @param {boolean} [is4K] Optional filter by items that are 4K or not. - * @param {Array} [locationTypes] Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited. - * @param {Array} [excludeLocationTypes] Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited. - * @param {boolean} [isMissing] Optional filter by items that are missing episodes or not. - * @param {boolean} [isUnaired] Optional filter by items that are unaired episodes or not. - * @param {number} [minCommunityRating] Optional filter by minimum community rating. - * @param {number} [minCriticRating] Optional filter by minimum critic rating. - * @param {string} [minPremiereDate] Optional. The minimum premiere date. Format = ISO. - * @param {string} [minDateLastSaved] Optional. The minimum last saved date. Format = ISO. - * @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO. - * @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO. - * @param {boolean} [hasOverview] Optional filter by items that have an overview or not. - * @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not. - * @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not. - * @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not. - * @param {boolean} [isMovie] Optional filter for live tv movies. - * @param {boolean} [isSeries] Optional filter for live tv series. - * @param {boolean} [isNews] Optional filter for live tv news. - * @param {boolean} [isKids] Optional filter for live tv kids. - * @param {boolean} [isSports] Optional filter for live tv sports. - * @param {Array} [excludeItemIds] Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited. - * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results. - * @param {number} [limit] Optional. The maximum number of records to return. - * @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false. - * @param {string} [searchTerm] Optional. Filter based on a search term. - * @param {Array} [sortOrder] Sort Order - Ascending,Descending. - * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root. - * @param {Array} [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. - * @param {Array} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. - * @param {Array} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited. - * @param {Array} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes. - * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not. - * @param {Array} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited. - * @param {Array} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited. - * @param {Array} [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. - * @param {boolean} [isPlayed] Optional filter by items that are played, or not. - * @param {Array} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. - * @param {Array} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. - * @param {Array} [tags] Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited. - * @param {Array} [years] Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited. - * @param {boolean} [enableUserData] Optional, include user data. - * @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type. - * @param {Array} [enableImageTypes] Optional. The image types to include in the output. - * @param {string} [person] Optional. If specified, results will be filtered to include only those containing the specified person. - * @param {Array} [personIds] Optional. If specified, results will be filtered to include only those containing the specified person id. - * @param {Array} [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. - * @param {Array} [studios] Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited. - * @param {Array} [artists] Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited. - * @param {Array} [excludeArtistIds] Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited. - * @param {Array} [artistIds] Optional. If specified, results will be filtered to include only those containing the specified artist id. - * @param {Array} [albumArtistIds] Optional. If specified, results will be filtered to include only those containing the specified album artist id. - * @param {Array} [contributingArtistIds] Optional. If specified, results will be filtered to include only those containing the specified contributing artist id. - * @param {Array} [albums] Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited. - * @param {Array} [albumIds] Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited. - * @param {Array} [ids] Optional. If specific items are needed, specify a list of item id\'s to retrieve. This allows multiple, comma delimited. - * @param {Array} [videoTypes] Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited. - * @param {string} [minOfficialRating] Optional filter by minimum official rating (PG, PG-13, TV-MA, etc). - * @param {boolean} [isLocked] Optional filter by items that are locked. - * @param {boolean} [isPlaceHolder] Optional filter by items that are placeholders. - * @param {boolean} [hasOfficialRating] Optional filter by items that have official ratings. - * @param {boolean} [collapseBoxSetItems] Whether or not to hide items behind their boxsets. - * @param {number} [minWidth] Optional. Filter by the minimum width of the item. - * @param {number} [minHeight] Optional. Filter by the minimum height of the item. - * @param {number} [maxWidth] Optional. Filter by the maximum width of the item. - * @param {number} [maxHeight] Optional. Filter by the maximum height of the item. - * @param {boolean} [is3D] Optional filter by items that are 3D, or not. - * @param {Array} [seriesStatus] Optional filter by Series Status. Allows multiple, comma delimited. - * @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string. - * @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string. - * @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string. - * @param {Array} [studioIds] Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited. - * @param {Array} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. - * @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count. - * @param {boolean} [enableImages] Optional, include image information in output. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getItemsByUserId: async (userId: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array, excludeLocationTypes?: Array, 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, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, filters?: Array, isFavorite?: boolean, mediaTypes?: Array, imageTypes?: Array, sortBy?: Array, isPlayed?: boolean, genres?: Array, officialRatings?: Array, tags?: Array, years?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, person?: string, personIds?: Array, personTypes?: Array, studios?: Array, artists?: Array, excludeArtistIds?: Array, artistIds?: Array, albumArtistIds?: Array, contributingArtistIds?: Array, albums?: Array, albumIds?: Array, ids?: Array, videoTypes?: Array, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array, genreIds?: Array, enableTotalRecordCount?: boolean, enableImages?: boolean, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('getItemsByUserId', 'userId', userId) - const localVarPath = `/Users/{userId}/Items` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication CustomAuthentication required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - - if (maxOfficialRating !== undefined) { - localVarQueryParameter['maxOfficialRating'] = maxOfficialRating; - } - - if (hasThemeSong !== undefined) { - localVarQueryParameter['hasThemeSong'] = hasThemeSong; - } - - if (hasThemeVideo !== undefined) { - localVarQueryParameter['hasThemeVideo'] = hasThemeVideo; - } - - if (hasSubtitles !== undefined) { - localVarQueryParameter['hasSubtitles'] = hasSubtitles; - } - - if (hasSpecialFeature !== undefined) { - localVarQueryParameter['hasSpecialFeature'] = hasSpecialFeature; - } - - if (hasTrailer !== undefined) { - localVarQueryParameter['hasTrailer'] = hasTrailer; - } - - if (adjacentTo !== undefined) { - localVarQueryParameter['adjacentTo'] = adjacentTo; - } - - if (parentIndexNumber !== undefined) { - localVarQueryParameter['parentIndexNumber'] = parentIndexNumber; - } - - if (hasParentalRating !== undefined) { - localVarQueryParameter['hasParentalRating'] = hasParentalRating; - } - - if (isHd !== undefined) { - localVarQueryParameter['isHd'] = isHd; - } - - if (is4K !== undefined) { - localVarQueryParameter['is4K'] = is4K; - } - - if (locationTypes) { - localVarQueryParameter['locationTypes'] = locationTypes; - } - - if (excludeLocationTypes) { - localVarQueryParameter['excludeLocationTypes'] = excludeLocationTypes; - } - - if (isMissing !== undefined) { - localVarQueryParameter['isMissing'] = isMissing; - } - - if (isUnaired !== undefined) { - localVarQueryParameter['isUnaired'] = isUnaired; - } - - if (minCommunityRating !== undefined) { - localVarQueryParameter['minCommunityRating'] = minCommunityRating; - } - - if (minCriticRating !== undefined) { - localVarQueryParameter['minCriticRating'] = minCriticRating; - } - - if (minPremiereDate !== undefined) { - localVarQueryParameter['minPremiereDate'] = (minPremiereDate as any instanceof Date) ? - (minPremiereDate as any).toISOString() : - minPremiereDate; - } - - if (minDateLastSaved !== undefined) { - localVarQueryParameter['minDateLastSaved'] = (minDateLastSaved as any instanceof Date) ? - (minDateLastSaved as any).toISOString() : - minDateLastSaved; - } - - if (minDateLastSavedForUser !== undefined) { - localVarQueryParameter['minDateLastSavedForUser'] = (minDateLastSavedForUser as any instanceof Date) ? - (minDateLastSavedForUser as any).toISOString() : - minDateLastSavedForUser; - } - - if (maxPremiereDate !== undefined) { - localVarQueryParameter['maxPremiereDate'] = (maxPremiereDate as any instanceof Date) ? - (maxPremiereDate as any).toISOString() : - maxPremiereDate; - } - - if (hasOverview !== undefined) { - localVarQueryParameter['hasOverview'] = hasOverview; - } - - if (hasImdbId !== undefined) { - localVarQueryParameter['hasImdbId'] = hasImdbId; - } - - if (hasTmdbId !== undefined) { - localVarQueryParameter['hasTmdbId'] = hasTmdbId; - } - - if (hasTvdbId !== undefined) { - localVarQueryParameter['hasTvdbId'] = hasTvdbId; - } - - if (isMovie !== undefined) { - localVarQueryParameter['isMovie'] = isMovie; - } - - if (isSeries !== undefined) { - localVarQueryParameter['isSeries'] = isSeries; - } - - if (isNews !== undefined) { - localVarQueryParameter['isNews'] = isNews; - } - - if (isKids !== undefined) { - localVarQueryParameter['isKids'] = isKids; - } - - if (isSports !== undefined) { - localVarQueryParameter['isSports'] = isSports; - } - - if (excludeItemIds) { - localVarQueryParameter['excludeItemIds'] = excludeItemIds; - } - - if (startIndex !== undefined) { - localVarQueryParameter['startIndex'] = startIndex; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (recursive !== undefined) { - localVarQueryParameter['recursive'] = recursive; - } - - if (searchTerm !== undefined) { - localVarQueryParameter['searchTerm'] = searchTerm; - } - - if (sortOrder) { - localVarQueryParameter['sortOrder'] = sortOrder; - } - - if (parentId !== undefined) { - localVarQueryParameter['parentId'] = parentId; - } - - if (fields) { - localVarQueryParameter['fields'] = fields; - } - - if (excludeItemTypes) { - localVarQueryParameter['excludeItemTypes'] = excludeItemTypes; - } - - if (includeItemTypes) { - localVarQueryParameter['includeItemTypes'] = includeItemTypes; - } - - if (filters) { - localVarQueryParameter['filters'] = filters; - } - - if (isFavorite !== undefined) { - localVarQueryParameter['isFavorite'] = isFavorite; - } - - if (mediaTypes) { - localVarQueryParameter['mediaTypes'] = mediaTypes; - } - - if (imageTypes) { - localVarQueryParameter['imageTypes'] = imageTypes; - } - - if (sortBy) { - localVarQueryParameter['sortBy'] = sortBy; - } - - if (isPlayed !== undefined) { - localVarQueryParameter['isPlayed'] = isPlayed; - } - - if (genres) { - localVarQueryParameter['genres'] = genres; - } - - if (officialRatings) { - localVarQueryParameter['officialRatings'] = officialRatings; - } - - if (tags) { - localVarQueryParameter['tags'] = tags; - } - - if (years) { - localVarQueryParameter['years'] = years; - } - - if (enableUserData !== undefined) { - localVarQueryParameter['enableUserData'] = enableUserData; - } - - if (imageTypeLimit !== undefined) { - localVarQueryParameter['imageTypeLimit'] = imageTypeLimit; - } - - if (enableImageTypes) { - localVarQueryParameter['enableImageTypes'] = enableImageTypes; - } - - if (person !== undefined) { - localVarQueryParameter['person'] = person; - } - - if (personIds) { - localVarQueryParameter['personIds'] = personIds; - } - - if (personTypes) { - localVarQueryParameter['personTypes'] = personTypes; - } - - if (studios) { - localVarQueryParameter['studios'] = studios; - } - - if (artists) { - localVarQueryParameter['artists'] = artists; - } - - if (excludeArtistIds) { - localVarQueryParameter['excludeArtistIds'] = excludeArtistIds; - } - - if (artistIds) { - localVarQueryParameter['artistIds'] = artistIds; - } - - if (albumArtistIds) { - localVarQueryParameter['albumArtistIds'] = albumArtistIds; - } - - if (contributingArtistIds) { - localVarQueryParameter['contributingArtistIds'] = contributingArtistIds; - } - - if (albums) { - localVarQueryParameter['albums'] = albums; - } - - if (albumIds) { - localVarQueryParameter['albumIds'] = albumIds; - } - - if (ids) { - localVarQueryParameter['ids'] = ids; - } - - if (videoTypes) { - localVarQueryParameter['videoTypes'] = videoTypes; - } - - if (minOfficialRating !== undefined) { - localVarQueryParameter['minOfficialRating'] = minOfficialRating; - } - - if (isLocked !== undefined) { - localVarQueryParameter['isLocked'] = isLocked; - } - - if (isPlaceHolder !== undefined) { - localVarQueryParameter['isPlaceHolder'] = isPlaceHolder; - } - - if (hasOfficialRating !== undefined) { - localVarQueryParameter['hasOfficialRating'] = hasOfficialRating; - } - - if (collapseBoxSetItems !== undefined) { - localVarQueryParameter['collapseBoxSetItems'] = collapseBoxSetItems; - } - - if (minWidth !== undefined) { - localVarQueryParameter['minWidth'] = minWidth; - } - - if (minHeight !== undefined) { - localVarQueryParameter['minHeight'] = minHeight; - } - - if (maxWidth !== undefined) { - localVarQueryParameter['maxWidth'] = maxWidth; - } - - if (maxHeight !== undefined) { - localVarQueryParameter['maxHeight'] = maxHeight; - } - - if (is3D !== undefined) { - localVarQueryParameter['is3D'] = is3D; - } - - if (seriesStatus) { - localVarQueryParameter['seriesStatus'] = seriesStatus; - } - - if (nameStartsWithOrGreater !== undefined) { - localVarQueryParameter['nameStartsWithOrGreater'] = nameStartsWithOrGreater; - } - - if (nameStartsWith !== undefined) { - localVarQueryParameter['nameStartsWith'] = nameStartsWith; - } - - if (nameLessThan !== undefined) { - localVarQueryParameter['nameLessThan'] = nameLessThan; - } - - if (studioIds) { - localVarQueryParameter['studioIds'] = studioIds; - } - - if (genreIds) { - localVarQueryParameter['genreIds'] = genreIds; - } - - if (enableTotalRecordCount !== undefined) { - localVarQueryParameter['enableTotalRecordCount'] = enableTotalRecordCount; - } - - if (enableImages !== undefined) { - localVarQueryParameter['enableImages'] = enableImages; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * - * @summary Gets items based on a query. - * @param {string} userId The user id. + * @param {string} [userId] The user id. * @param {number} [startIndex] The start index. * @param {number} [limit] The item limit. * @param {string} [searchTerm] The search term. * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root. * @param {Array} [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. - * @param {Array} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited. + * @param {Array} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited. * @param {boolean} [enableUserData] Optional. Include user data. * @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type. * @param {Array} [enableImageTypes] Optional. The image types to include in the output. @@ -995,11 +582,8 @@ export const ItemsApiAxiosParamCreator = function (configuration?: Configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getResumeItems: async (userId: string, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, mediaTypes?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, enableTotalRecordCount?: boolean, enableImages?: boolean, excludeActiveSessions?: boolean, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('getResumeItems', 'userId', userId) - const localVarPath = `/Users/{userId}/Items/Resume` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))); + getResumeItems: async (userId?: string, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, mediaTypes?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, enableTotalRecordCount?: boolean, enableImages?: boolean, excludeActiveSessions?: boolean, options: AxiosRequestConfig = {}): Promise => { + const localVarPath = `/UserItems/Resume`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -1014,6 +598,10 @@ export const ItemsApiAxiosParamCreator = function (configuration?: Configuration // authentication CustomAuthentication required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (userId !== undefined) { + localVarQueryParameter['userId'] = userId; + } + if (startIndex !== undefined) { localVarQueryParameter['startIndex'] = startIndex; } @@ -1076,6 +664,54 @@ export const ItemsApiAxiosParamCreator = function (configuration?: Configuration let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Update Item User Data. + * @param {string} itemId The item id. + * @param {UpdateUserItemDataDto} updateUserItemDataDto New user data object. + * @param {string} [userId] The user id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateItemUserData: async (itemId: string, updateUserItemDataDto: UpdateUserItemDataDto, userId?: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'itemId' is not null or undefined + assertParamExists('updateItemUserData', 'itemId', itemId) + // verify required parameter 'updateUserItemDataDto' is not null or undefined + assertParamExists('updateItemUserData', 'updateUserItemDataDto', updateUserItemDataDto) + const localVarPath = `/UserItems/{itemId}/UserData` + .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication CustomAuthentication required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + if (userId !== undefined) { + localVarQueryParameter['userId'] = userId; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(updateUserItemDataDto, localVarRequestOptions, configuration) + return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, @@ -1091,10 +727,22 @@ export const ItemsApiAxiosParamCreator = function (configuration?: Configuration export const ItemsApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = ItemsApiAxiosParamCreator(configuration) return { + /** + * + * @summary Get Item User Data. + * @param {string} itemId The item id. + * @param {string} [userId] The user id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getItemUserData(itemId: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getItemUserData(itemId, userId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, /** * * @summary Gets items based on a query. - * @param {string} [userId] The user id supplied as query parameter. + * @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key. * @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc). * @param {boolean} [hasThemeSong] Optional filter by items with theme songs. * @param {boolean} [hasThemeVideo] Optional filter by items with theme videos. @@ -1117,9 +765,9 @@ export const ItemsApiFp = function(configuration?: Configuration) { * @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO. * @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO. * @param {boolean} [hasOverview] Optional filter by items that have an overview or not. - * @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not. - * @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not. - * @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not. + * @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not. + * @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not. + * @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not. * @param {boolean} [isMovie] Optional filter for live tv movies. * @param {boolean} [isSeries] Optional filter for live tv series. * @param {boolean} [isNews] Optional filter for live tv news. @@ -1130,16 +778,16 @@ export const ItemsApiFp = function(configuration?: Configuration) { * @param {number} [limit] Optional. The maximum number of records to return. * @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false. * @param {string} [searchTerm] Optional. Filter based on a search term. - * @param {Array} [sortOrder] Sort Order - Ascending,Descending. + * @param {Array} [sortOrder] Sort Order - Ascending, Descending. * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root. * @param {Array} [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. * @param {Array} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. * @param {Array} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited. * @param {Array} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes. * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not. - * @param {Array} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited. + * @param {Array} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited. * @param {Array} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited. - * @param {Array} [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. + * @param {Array} [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. * @param {boolean} [isPlayed] Optional filter by items that are played, or not. * @param {Array} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. * @param {Array} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. @@ -1182,115 +830,20 @@ export const ItemsApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getItems(userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array, excludeLocationTypes?: Array, 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, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, filters?: Array, isFavorite?: boolean, mediaTypes?: Array, imageTypes?: Array, sortBy?: Array, isPlayed?: boolean, genres?: Array, officialRatings?: Array, tags?: Array, years?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, person?: string, personIds?: Array, personTypes?: Array, studios?: Array, artists?: Array, excludeArtistIds?: Array, artistIds?: Array, albumArtistIds?: Array, contributingArtistIds?: Array, albums?: Array, albumIds?: Array, ids?: Array, videoTypes?: Array, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array, genreIds?: Array, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getItems(userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array, excludeLocationTypes?: Array, 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, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, filters?: Array, isFavorite?: boolean, mediaTypes?: Array, imageTypes?: Array, sortBy?: Array, isPlayed?: boolean, genres?: Array, officialRatings?: Array, tags?: Array, years?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, person?: string, personIds?: Array, personTypes?: Array, studios?: Array, artists?: Array, excludeArtistIds?: Array, artistIds?: Array, albumArtistIds?: Array, contributingArtistIds?: Array, albums?: Array, albumIds?: Array, ids?: Array, videoTypes?: Array, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array, genreIds?: Array, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getItems(userId, maxOfficialRating, hasThemeSong, hasThemeVideo, hasSubtitles, hasSpecialFeature, hasTrailer, adjacentTo, parentIndexNumber, hasParentalRating, isHd, is4K, locationTypes, excludeLocationTypes, isMissing, isUnaired, minCommunityRating, minCriticRating, minPremiereDate, minDateLastSaved, minDateLastSavedForUser, maxPremiereDate, hasOverview, hasImdbId, hasTmdbId, hasTvdbId, isMovie, isSeries, isNews, isKids, isSports, excludeItemIds, startIndex, limit, recursive, searchTerm, sortOrder, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, imageTypes, sortBy, isPlayed, genres, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, artists, excludeArtistIds, artistIds, albumArtistIds, contributingArtistIds, albums, albumIds, ids, videoTypes, minOfficialRating, isLocked, isPlaceHolder, hasOfficialRating, collapseBoxSetItems, minWidth, minHeight, maxWidth, maxHeight, is3D, seriesStatus, nameStartsWithOrGreater, nameStartsWith, nameLessThan, studioIds, genreIds, enableTotalRecordCount, enableImages, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * * @summary Gets items based on a query. - * @param {string} userId The user id supplied as query parameter. - * @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc). - * @param {boolean} [hasThemeSong] Optional filter by items with theme songs. - * @param {boolean} [hasThemeVideo] Optional filter by items with theme videos. - * @param {boolean} [hasSubtitles] Optional filter by items with subtitles. - * @param {boolean} [hasSpecialFeature] Optional filter by items with special features. - * @param {boolean} [hasTrailer] Optional filter by items with trailers. - * @param {string} [adjacentTo] Optional. Return items that are siblings of a supplied item. - * @param {number} [parentIndexNumber] Optional filter by parent index number. - * @param {boolean} [hasParentalRating] Optional filter by items that have or do not have a parental rating. - * @param {boolean} [isHd] Optional filter by items that are HD or not. - * @param {boolean} [is4K] Optional filter by items that are 4K or not. - * @param {Array} [locationTypes] Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited. - * @param {Array} [excludeLocationTypes] Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited. - * @param {boolean} [isMissing] Optional filter by items that are missing episodes or not. - * @param {boolean} [isUnaired] Optional filter by items that are unaired episodes or not. - * @param {number} [minCommunityRating] Optional filter by minimum community rating. - * @param {number} [minCriticRating] Optional filter by minimum critic rating. - * @param {string} [minPremiereDate] Optional. The minimum premiere date. Format = ISO. - * @param {string} [minDateLastSaved] Optional. The minimum last saved date. Format = ISO. - * @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO. - * @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO. - * @param {boolean} [hasOverview] Optional filter by items that have an overview or not. - * @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not. - * @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not. - * @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not. - * @param {boolean} [isMovie] Optional filter for live tv movies. - * @param {boolean} [isSeries] Optional filter for live tv series. - * @param {boolean} [isNews] Optional filter for live tv news. - * @param {boolean} [isKids] Optional filter for live tv kids. - * @param {boolean} [isSports] Optional filter for live tv sports. - * @param {Array} [excludeItemIds] Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited. - * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results. - * @param {number} [limit] Optional. The maximum number of records to return. - * @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false. - * @param {string} [searchTerm] Optional. Filter based on a search term. - * @param {Array} [sortOrder] Sort Order - Ascending,Descending. - * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root. - * @param {Array} [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. - * @param {Array} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. - * @param {Array} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited. - * @param {Array} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes. - * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not. - * @param {Array} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited. - * @param {Array} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited. - * @param {Array} [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. - * @param {boolean} [isPlayed] Optional filter by items that are played, or not. - * @param {Array} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. - * @param {Array} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. - * @param {Array} [tags] Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited. - * @param {Array} [years] Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited. - * @param {boolean} [enableUserData] Optional, include user data. - * @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type. - * @param {Array} [enableImageTypes] Optional. The image types to include in the output. - * @param {string} [person] Optional. If specified, results will be filtered to include only those containing the specified person. - * @param {Array} [personIds] Optional. If specified, results will be filtered to include only those containing the specified person id. - * @param {Array} [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. - * @param {Array} [studios] Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited. - * @param {Array} [artists] Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited. - * @param {Array} [excludeArtistIds] Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited. - * @param {Array} [artistIds] Optional. If specified, results will be filtered to include only those containing the specified artist id. - * @param {Array} [albumArtistIds] Optional. If specified, results will be filtered to include only those containing the specified album artist id. - * @param {Array} [contributingArtistIds] Optional. If specified, results will be filtered to include only those containing the specified contributing artist id. - * @param {Array} [albums] Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited. - * @param {Array} [albumIds] Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited. - * @param {Array} [ids] Optional. If specific items are needed, specify a list of item id\'s to retrieve. This allows multiple, comma delimited. - * @param {Array} [videoTypes] Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited. - * @param {string} [minOfficialRating] Optional filter by minimum official rating (PG, PG-13, TV-MA, etc). - * @param {boolean} [isLocked] Optional filter by items that are locked. - * @param {boolean} [isPlaceHolder] Optional filter by items that are placeholders. - * @param {boolean} [hasOfficialRating] Optional filter by items that have official ratings. - * @param {boolean} [collapseBoxSetItems] Whether or not to hide items behind their boxsets. - * @param {number} [minWidth] Optional. Filter by the minimum width of the item. - * @param {number} [minHeight] Optional. Filter by the minimum height of the item. - * @param {number} [maxWidth] Optional. Filter by the maximum width of the item. - * @param {number} [maxHeight] Optional. Filter by the maximum height of the item. - * @param {boolean} [is3D] Optional filter by items that are 3D, or not. - * @param {Array} [seriesStatus] Optional filter by Series Status. Allows multiple, comma delimited. - * @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string. - * @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string. - * @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string. - * @param {Array} [studioIds] Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited. - * @param {Array} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. - * @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count. - * @param {boolean} [enableImages] Optional, include image information in output. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getItemsByUserId(userId: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array, excludeLocationTypes?: Array, 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, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, filters?: Array, isFavorite?: boolean, mediaTypes?: Array, imageTypes?: Array, sortBy?: Array, isPlayed?: boolean, genres?: Array, officialRatings?: Array, tags?: Array, years?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, person?: string, personIds?: Array, personTypes?: Array, studios?: Array, artists?: Array, excludeArtistIds?: Array, artistIds?: Array, albumArtistIds?: Array, contributingArtistIds?: Array, albums?: Array, albumIds?: Array, ids?: Array, videoTypes?: Array, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array, genreIds?: Array, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getItemsByUserId(userId, maxOfficialRating, hasThemeSong, hasThemeVideo, hasSubtitles, hasSpecialFeature, hasTrailer, adjacentTo, parentIndexNumber, hasParentalRating, isHd, is4K, locationTypes, excludeLocationTypes, isMissing, isUnaired, minCommunityRating, minCriticRating, minPremiereDate, minDateLastSaved, minDateLastSavedForUser, maxPremiereDate, hasOverview, hasImdbId, hasTmdbId, hasTvdbId, isMovie, isSeries, isNews, isKids, isSports, excludeItemIds, startIndex, limit, recursive, searchTerm, sortOrder, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, imageTypes, sortBy, isPlayed, genres, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, artists, excludeArtistIds, artistIds, albumArtistIds, contributingArtistIds, albums, albumIds, ids, videoTypes, minOfficialRating, isLocked, isPlaceHolder, hasOfficialRating, collapseBoxSetItems, minWidth, minHeight, maxWidth, maxHeight, is3D, seriesStatus, nameStartsWithOrGreater, nameStartsWith, nameLessThan, studioIds, genreIds, enableTotalRecordCount, enableImages, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * - * @summary Gets items based on a query. - * @param {string} userId The user id. + * @param {string} [userId] The user id. * @param {number} [startIndex] The start index. * @param {number} [limit] The item limit. * @param {string} [searchTerm] The search term. * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root. * @param {Array} [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. - * @param {Array} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited. + * @param {Array} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited. * @param {boolean} [enableUserData] Optional. Include user data. * @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type. * @param {Array} [enableImageTypes] Optional. The image types to include in the output. @@ -1302,10 +855,23 @@ export const ItemsApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getResumeItems(userId: string, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, mediaTypes?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, enableTotalRecordCount?: boolean, enableImages?: boolean, excludeActiveSessions?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getResumeItems(userId?: string, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, mediaTypes?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, enableTotalRecordCount?: boolean, enableImages?: boolean, excludeActiveSessions?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getResumeItems(userId, startIndex, limit, searchTerm, parentId, fields, mediaTypes, enableUserData, imageTypeLimit, enableImageTypes, excludeItemTypes, includeItemTypes, enableTotalRecordCount, enableImages, excludeActiveSessions, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * + * @summary Update Item User Data. + * @param {string} itemId The item id. + * @param {UpdateUserItemDataDto} updateUserItemDataDto New user data object. + * @param {string} [userId] The user id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async updateItemUserData(itemId: string, updateUserItemDataDto: UpdateUserItemDataDto, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateItemUserData(itemId, updateUserItemDataDto, userId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, } }; @@ -1316,10 +882,21 @@ export const ItemsApiFp = function(configuration?: Configuration) { export const ItemsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = ItemsApiFp(configuration) return { + /** + * + * @summary Get Item User Data. + * @param {string} itemId The item id. + * @param {string} [userId] The user id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getItemUserData(itemId: string, userId?: string, options?: any): AxiosPromise { + return localVarFp.getItemUserData(itemId, userId, options).then((request) => request(axios, basePath)); + }, /** * * @summary Gets items based on a query. - * @param {string} [userId] The user id supplied as query parameter. + * @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key. * @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc). * @param {boolean} [hasThemeSong] Optional filter by items with theme songs. * @param {boolean} [hasThemeVideo] Optional filter by items with theme videos. @@ -1342,9 +919,9 @@ export const ItemsApiFactory = function (configuration?: Configuration, basePath * @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO. * @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO. * @param {boolean} [hasOverview] Optional filter by items that have an overview or not. - * @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not. - * @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not. - * @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not. + * @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not. + * @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not. + * @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not. * @param {boolean} [isMovie] Optional filter for live tv movies. * @param {boolean} [isSeries] Optional filter for live tv series. * @param {boolean} [isNews] Optional filter for live tv news. @@ -1355,16 +932,16 @@ export const ItemsApiFactory = function (configuration?: Configuration, basePath * @param {number} [limit] Optional. The maximum number of records to return. * @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false. * @param {string} [searchTerm] Optional. Filter based on a search term. - * @param {Array} [sortOrder] Sort Order - Ascending,Descending. + * @param {Array} [sortOrder] Sort Order - Ascending, Descending. * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root. * @param {Array} [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. * @param {Array} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. * @param {Array} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited. * @param {Array} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes. * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not. - * @param {Array} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited. + * @param {Array} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited. * @param {Array} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited. - * @param {Array} [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. + * @param {Array} [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. * @param {boolean} [isPlayed] Optional filter by items that are played, or not. * @param {Array} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. * @param {Array} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. @@ -1407,113 +984,19 @@ export const ItemsApiFactory = function (configuration?: Configuration, basePath * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getItems(userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array, excludeLocationTypes?: Array, 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, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, filters?: Array, isFavorite?: boolean, mediaTypes?: Array, imageTypes?: Array, sortBy?: Array, isPlayed?: boolean, genres?: Array, officialRatings?: Array, tags?: Array, years?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, person?: string, personIds?: Array, personTypes?: Array, studios?: Array, artists?: Array, excludeArtistIds?: Array, artistIds?: Array, albumArtistIds?: Array, contributingArtistIds?: Array, albums?: Array, albumIds?: Array, ids?: Array, videoTypes?: Array, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array, genreIds?: Array, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): AxiosPromise { + getItems(userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array, excludeLocationTypes?: Array, 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, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, filters?: Array, isFavorite?: boolean, mediaTypes?: Array, imageTypes?: Array, sortBy?: Array, isPlayed?: boolean, genres?: Array, officialRatings?: Array, tags?: Array, years?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, person?: string, personIds?: Array, personTypes?: Array, studios?: Array, artists?: Array, excludeArtistIds?: Array, artistIds?: Array, albumArtistIds?: Array, contributingArtistIds?: Array, albums?: Array, albumIds?: Array, ids?: Array, videoTypes?: Array, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array, genreIds?: Array, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): AxiosPromise { return localVarFp.getItems(userId, maxOfficialRating, hasThemeSong, hasThemeVideo, hasSubtitles, hasSpecialFeature, hasTrailer, adjacentTo, parentIndexNumber, hasParentalRating, isHd, is4K, locationTypes, excludeLocationTypes, isMissing, isUnaired, minCommunityRating, minCriticRating, minPremiereDate, minDateLastSaved, minDateLastSavedForUser, maxPremiereDate, hasOverview, hasImdbId, hasTmdbId, hasTvdbId, isMovie, isSeries, isNews, isKids, isSports, excludeItemIds, startIndex, limit, recursive, searchTerm, sortOrder, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, imageTypes, sortBy, isPlayed, genres, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, artists, excludeArtistIds, artistIds, albumArtistIds, contributingArtistIds, albums, albumIds, ids, videoTypes, minOfficialRating, isLocked, isPlaceHolder, hasOfficialRating, collapseBoxSetItems, minWidth, minHeight, maxWidth, maxHeight, is3D, seriesStatus, nameStartsWithOrGreater, nameStartsWith, nameLessThan, studioIds, genreIds, enableTotalRecordCount, enableImages, options).then((request) => request(axios, basePath)); }, /** * * @summary Gets items based on a query. - * @param {string} userId The user id supplied as query parameter. - * @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc). - * @param {boolean} [hasThemeSong] Optional filter by items with theme songs. - * @param {boolean} [hasThemeVideo] Optional filter by items with theme videos. - * @param {boolean} [hasSubtitles] Optional filter by items with subtitles. - * @param {boolean} [hasSpecialFeature] Optional filter by items with special features. - * @param {boolean} [hasTrailer] Optional filter by items with trailers. - * @param {string} [adjacentTo] Optional. Return items that are siblings of a supplied item. - * @param {number} [parentIndexNumber] Optional filter by parent index number. - * @param {boolean} [hasParentalRating] Optional filter by items that have or do not have a parental rating. - * @param {boolean} [isHd] Optional filter by items that are HD or not. - * @param {boolean} [is4K] Optional filter by items that are 4K or not. - * @param {Array} [locationTypes] Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited. - * @param {Array} [excludeLocationTypes] Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited. - * @param {boolean} [isMissing] Optional filter by items that are missing episodes or not. - * @param {boolean} [isUnaired] Optional filter by items that are unaired episodes or not. - * @param {number} [minCommunityRating] Optional filter by minimum community rating. - * @param {number} [minCriticRating] Optional filter by minimum critic rating. - * @param {string} [minPremiereDate] Optional. The minimum premiere date. Format = ISO. - * @param {string} [minDateLastSaved] Optional. The minimum last saved date. Format = ISO. - * @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO. - * @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO. - * @param {boolean} [hasOverview] Optional filter by items that have an overview or not. - * @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not. - * @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not. - * @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not. - * @param {boolean} [isMovie] Optional filter for live tv movies. - * @param {boolean} [isSeries] Optional filter for live tv series. - * @param {boolean} [isNews] Optional filter for live tv news. - * @param {boolean} [isKids] Optional filter for live tv kids. - * @param {boolean} [isSports] Optional filter for live tv sports. - * @param {Array} [excludeItemIds] Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited. - * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results. - * @param {number} [limit] Optional. The maximum number of records to return. - * @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false. - * @param {string} [searchTerm] Optional. Filter based on a search term. - * @param {Array} [sortOrder] Sort Order - Ascending,Descending. - * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root. - * @param {Array} [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. - * @param {Array} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. - * @param {Array} [includeItemTypes] Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited. - * @param {Array} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes. - * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not. - * @param {Array} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited. - * @param {Array} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited. - * @param {Array} [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. - * @param {boolean} [isPlayed] Optional filter by items that are played, or not. - * @param {Array} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. - * @param {Array} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. - * @param {Array} [tags] Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited. - * @param {Array} [years] Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited. - * @param {boolean} [enableUserData] Optional, include user data. - * @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type. - * @param {Array} [enableImageTypes] Optional. The image types to include in the output. - * @param {string} [person] Optional. If specified, results will be filtered to include only those containing the specified person. - * @param {Array} [personIds] Optional. If specified, results will be filtered to include only those containing the specified person id. - * @param {Array} [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. - * @param {Array} [studios] Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited. - * @param {Array} [artists] Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited. - * @param {Array} [excludeArtistIds] Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited. - * @param {Array} [artistIds] Optional. If specified, results will be filtered to include only those containing the specified artist id. - * @param {Array} [albumArtistIds] Optional. If specified, results will be filtered to include only those containing the specified album artist id. - * @param {Array} [contributingArtistIds] Optional. If specified, results will be filtered to include only those containing the specified contributing artist id. - * @param {Array} [albums] Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited. - * @param {Array} [albumIds] Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited. - * @param {Array} [ids] Optional. If specific items are needed, specify a list of item id\'s to retrieve. This allows multiple, comma delimited. - * @param {Array} [videoTypes] Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited. - * @param {string} [minOfficialRating] Optional filter by minimum official rating (PG, PG-13, TV-MA, etc). - * @param {boolean} [isLocked] Optional filter by items that are locked. - * @param {boolean} [isPlaceHolder] Optional filter by items that are placeholders. - * @param {boolean} [hasOfficialRating] Optional filter by items that have official ratings. - * @param {boolean} [collapseBoxSetItems] Whether or not to hide items behind their boxsets. - * @param {number} [minWidth] Optional. Filter by the minimum width of the item. - * @param {number} [minHeight] Optional. Filter by the minimum height of the item. - * @param {number} [maxWidth] Optional. Filter by the maximum width of the item. - * @param {number} [maxHeight] Optional. Filter by the maximum height of the item. - * @param {boolean} [is3D] Optional filter by items that are 3D, or not. - * @param {Array} [seriesStatus] Optional filter by Series Status. Allows multiple, comma delimited. - * @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string. - * @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string. - * @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string. - * @param {Array} [studioIds] Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited. - * @param {Array} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. - * @param {boolean} [enableTotalRecordCount] Optional. Enable the total record count. - * @param {boolean} [enableImages] Optional, include image information in output. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getItemsByUserId(userId: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array, excludeLocationTypes?: Array, 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, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, filters?: Array, isFavorite?: boolean, mediaTypes?: Array, imageTypes?: Array, sortBy?: Array, isPlayed?: boolean, genres?: Array, officialRatings?: Array, tags?: Array, years?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, person?: string, personIds?: Array, personTypes?: Array, studios?: Array, artists?: Array, excludeArtistIds?: Array, artistIds?: Array, albumArtistIds?: Array, contributingArtistIds?: Array, albums?: Array, albumIds?: Array, ids?: Array, videoTypes?: Array, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array, genreIds?: Array, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): AxiosPromise { - return localVarFp.getItemsByUserId(userId, maxOfficialRating, hasThemeSong, hasThemeVideo, hasSubtitles, hasSpecialFeature, hasTrailer, adjacentTo, parentIndexNumber, hasParentalRating, isHd, is4K, locationTypes, excludeLocationTypes, isMissing, isUnaired, minCommunityRating, minCriticRating, minPremiereDate, minDateLastSaved, minDateLastSavedForUser, maxPremiereDate, hasOverview, hasImdbId, hasTmdbId, hasTvdbId, isMovie, isSeries, isNews, isKids, isSports, excludeItemIds, startIndex, limit, recursive, searchTerm, sortOrder, parentId, fields, excludeItemTypes, includeItemTypes, filters, isFavorite, mediaTypes, imageTypes, sortBy, isPlayed, genres, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, artists, excludeArtistIds, artistIds, albumArtistIds, contributingArtistIds, albums, albumIds, ids, videoTypes, minOfficialRating, isLocked, isPlaceHolder, hasOfficialRating, collapseBoxSetItems, minWidth, minHeight, maxWidth, maxHeight, is3D, seriesStatus, nameStartsWithOrGreater, nameStartsWith, nameLessThan, studioIds, genreIds, enableTotalRecordCount, enableImages, options).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Gets items based on a query. - * @param {string} userId The user id. + * @param {string} [userId] The user id. * @param {number} [startIndex] The start index. * @param {number} [limit] The item limit. * @param {string} [searchTerm] The search term. * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root. * @param {Array} [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. - * @param {Array} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited. + * @param {Array} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited. * @param {boolean} [enableUserData] Optional. Include user data. * @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type. * @param {Array} [enableImageTypes] Optional. The image types to include in the output. @@ -1525,12 +1008,45 @@ export const ItemsApiFactory = function (configuration?: Configuration, basePath * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getResumeItems(userId: string, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, mediaTypes?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, enableTotalRecordCount?: boolean, enableImages?: boolean, excludeActiveSessions?: boolean, options?: any): AxiosPromise { + getResumeItems(userId?: string, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, mediaTypes?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, enableTotalRecordCount?: boolean, enableImages?: boolean, excludeActiveSessions?: boolean, options?: any): AxiosPromise { return localVarFp.getResumeItems(userId, startIndex, limit, searchTerm, parentId, fields, mediaTypes, enableUserData, imageTypeLimit, enableImageTypes, excludeItemTypes, includeItemTypes, enableTotalRecordCount, enableImages, excludeActiveSessions, options).then((request) => request(axios, basePath)); }, + /** + * + * @summary Update Item User Data. + * @param {string} itemId The item id. + * @param {UpdateUserItemDataDto} updateUserItemDataDto New user data object. + * @param {string} [userId] The user id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateItemUserData(itemId: string, updateUserItemDataDto: UpdateUserItemDataDto, userId?: string, options?: any): AxiosPromise { + return localVarFp.updateItemUserData(itemId, updateUserItemDataDto, userId, options).then((request) => request(axios, basePath)); + }, }; }; +/** + * Request parameters for getItemUserData operation in ItemsApi. + * @export + * @interface ItemsApiGetItemUserDataRequest + */ +export interface ItemsApiGetItemUserDataRequest { + /** + * The item id. + * @type {string} + * @memberof ItemsApiGetItemUserData + */ + readonly itemId: string + + /** + * The user id. + * @type {string} + * @memberof ItemsApiGetItemUserData + */ + readonly userId?: string +} + /** * Request parameters for getItems operation in ItemsApi. * @export @@ -1538,7 +1054,7 @@ export const ItemsApiFactory = function (configuration?: Configuration, basePath */ export interface ItemsApiGetItemsRequest { /** - * The user id supplied as query parameter. + * The user id supplied as query parameter; this is required when not using an API key. * @type {string} * @memberof ItemsApiGetItems */ @@ -1699,21 +1215,21 @@ export interface ItemsApiGetItemsRequest { readonly hasOverview?: boolean /** - * Optional filter by items that have an imdb id or not. + * Optional filter by items that have an IMDb id or not. * @type {boolean} * @memberof ItemsApiGetItems */ readonly hasImdbId?: boolean /** - * Optional filter by items that have a tmdb id or not. + * Optional filter by items that have a TMDb id or not. * @type {boolean} * @memberof ItemsApiGetItems */ readonly hasTmdbId?: boolean /** - * Optional filter by items that have a tvdb id or not. + * Optional filter by items that have a TVDb id or not. * @type {boolean} * @memberof ItemsApiGetItems */ @@ -1790,7 +1306,7 @@ export interface ItemsApiGetItemsRequest { readonly searchTerm?: string /** - * Sort Order - Ascending,Descending. + * Sort Order - Ascending, Descending. * @type {Array} * @memberof ItemsApiGetItems */ @@ -1840,10 +1356,10 @@ export interface ItemsApiGetItemsRequest { /** * Optional filter by MediaType. Allows multiple, comma delimited. - * @type {Array} + * @type {Array} * @memberof ItemsApiGetItems */ - readonly mediaTypes?: Array + readonly mediaTypes?: Array /** * Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited. @@ -1854,10 +1370,10 @@ export interface ItemsApiGetItemsRequest { /** * 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. - * @type {Array} + * @type {Array} * @memberof ItemsApiGetItems */ - readonly sortBy?: Array + readonly sortBy?: Array /** * Optional filter by items that are played, or not. @@ -2133,608 +1649,6 @@ export interface ItemsApiGetItemsRequest { readonly enableImages?: boolean } -/** - * Request parameters for getItemsByUserId operation in ItemsApi. - * @export - * @interface ItemsApiGetItemsByUserIdRequest - */ -export interface ItemsApiGetItemsByUserIdRequest { - /** - * The user id supplied as query parameter. - * @type {string} - * @memberof ItemsApiGetItemsByUserId - */ - readonly userId: string - - /** - * Optional filter by maximum official rating (PG, PG-13, TV-MA, etc). - * @type {string} - * @memberof ItemsApiGetItemsByUserId - */ - readonly maxOfficialRating?: string - - /** - * Optional filter by items with theme songs. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly hasThemeSong?: boolean - - /** - * Optional filter by items with theme videos. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly hasThemeVideo?: boolean - - /** - * Optional filter by items with subtitles. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly hasSubtitles?: boolean - - /** - * Optional filter by items with special features. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly hasSpecialFeature?: boolean - - /** - * Optional filter by items with trailers. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly hasTrailer?: boolean - - /** - * Optional. Return items that are siblings of a supplied item. - * @type {string} - * @memberof ItemsApiGetItemsByUserId - */ - readonly adjacentTo?: string - - /** - * Optional filter by parent index number. - * @type {number} - * @memberof ItemsApiGetItemsByUserId - */ - readonly parentIndexNumber?: number - - /** - * Optional filter by items that have or do not have a parental rating. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly hasParentalRating?: boolean - - /** - * Optional filter by items that are HD or not. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly isHd?: boolean - - /** - * Optional filter by items that are 4K or not. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly is4K?: boolean - - /** - * Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly locationTypes?: Array - - /** - * Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly excludeLocationTypes?: Array - - /** - * Optional filter by items that are missing episodes or not. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly isMissing?: boolean - - /** - * Optional filter by items that are unaired episodes or not. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly isUnaired?: boolean - - /** - * Optional filter by minimum community rating. - * @type {number} - * @memberof ItemsApiGetItemsByUserId - */ - readonly minCommunityRating?: number - - /** - * Optional filter by minimum critic rating. - * @type {number} - * @memberof ItemsApiGetItemsByUserId - */ - readonly minCriticRating?: number - - /** - * Optional. The minimum premiere date. Format = ISO. - * @type {string} - * @memberof ItemsApiGetItemsByUserId - */ - readonly minPremiereDate?: string - - /** - * Optional. The minimum last saved date. Format = ISO. - * @type {string} - * @memberof ItemsApiGetItemsByUserId - */ - readonly minDateLastSaved?: string - - /** - * Optional. The minimum last saved date for the current user. Format = ISO. - * @type {string} - * @memberof ItemsApiGetItemsByUserId - */ - readonly minDateLastSavedForUser?: string - - /** - * Optional. The maximum premiere date. Format = ISO. - * @type {string} - * @memberof ItemsApiGetItemsByUserId - */ - readonly maxPremiereDate?: string - - /** - * Optional filter by items that have an overview or not. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly hasOverview?: boolean - - /** - * Optional filter by items that have an imdb id or not. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly hasImdbId?: boolean - - /** - * Optional filter by items that have a tmdb id or not. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly hasTmdbId?: boolean - - /** - * Optional filter by items that have a tvdb id or not. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly hasTvdbId?: boolean - - /** - * Optional filter for live tv movies. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly isMovie?: boolean - - /** - * Optional filter for live tv series. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly isSeries?: boolean - - /** - * Optional filter for live tv news. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly isNews?: boolean - - /** - * Optional filter for live tv kids. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly isKids?: boolean - - /** - * Optional filter for live tv sports. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly isSports?: boolean - - /** - * Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly excludeItemIds?: Array - - /** - * Optional. The record index to start at. All items with a lower index will be dropped from the results. - * @type {number} - * @memberof ItemsApiGetItemsByUserId - */ - readonly startIndex?: number - - /** - * Optional. The maximum number of records to return. - * @type {number} - * @memberof ItemsApiGetItemsByUserId - */ - readonly limit?: number - - /** - * When searching within folders, this determines whether or not the search will be recursive. true/false. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly recursive?: boolean - - /** - * Optional. Filter based on a search term. - * @type {string} - * @memberof ItemsApiGetItemsByUserId - */ - readonly searchTerm?: string - - /** - * Sort Order - Ascending,Descending. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly sortOrder?: Array - - /** - * Specify this to localize the search to a specific item or folder. Omit to use the root. - * @type {string} - * @memberof ItemsApiGetItemsByUserId - */ - readonly parentId?: string - - /** - * 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. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly fields?: Array - - /** - * Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly excludeItemTypes?: Array - - /** - * Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly includeItemTypes?: Array - - /** - * Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly filters?: Array - - /** - * Optional filter by items that are marked as favorite, or not. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly isFavorite?: boolean - - /** - * Optional filter by MediaType. Allows multiple, comma delimited. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly mediaTypes?: Array - - /** - * Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly imageTypes?: Array - - /** - * 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. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly sortBy?: Array - - /** - * Optional filter by items that are played, or not. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly isPlayed?: boolean - - /** - * Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly genres?: Array - - /** - * Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly officialRatings?: Array - - /** - * Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly tags?: Array - - /** - * Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly years?: Array - - /** - * Optional, include user data. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly enableUserData?: boolean - - /** - * Optional, the max number of images to return, per image type. - * @type {number} - * @memberof ItemsApiGetItemsByUserId - */ - readonly imageTypeLimit?: number - - /** - * Optional. The image types to include in the output. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly enableImageTypes?: Array - - /** - * Optional. If specified, results will be filtered to include only those containing the specified person. - * @type {string} - * @memberof ItemsApiGetItemsByUserId - */ - readonly person?: string - - /** - * Optional. If specified, results will be filtered to include only those containing the specified person id. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly personIds?: Array - - /** - * Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly personTypes?: Array - - /** - * Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly studios?: Array - - /** - * Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly artists?: Array - - /** - * Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly excludeArtistIds?: Array - - /** - * Optional. If specified, results will be filtered to include only those containing the specified artist id. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly artistIds?: Array - - /** - * Optional. If specified, results will be filtered to include only those containing the specified album artist id. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly albumArtistIds?: Array - - /** - * Optional. If specified, results will be filtered to include only those containing the specified contributing artist id. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly contributingArtistIds?: Array - - /** - * Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly albums?: Array - - /** - * Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly albumIds?: Array - - /** - * Optional. If specific items are needed, specify a list of item id\'s to retrieve. This allows multiple, comma delimited. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly ids?: Array - - /** - * Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly videoTypes?: Array - - /** - * Optional filter by minimum official rating (PG, PG-13, TV-MA, etc). - * @type {string} - * @memberof ItemsApiGetItemsByUserId - */ - readonly minOfficialRating?: string - - /** - * Optional filter by items that are locked. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly isLocked?: boolean - - /** - * Optional filter by items that are placeholders. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly isPlaceHolder?: boolean - - /** - * Optional filter by items that have official ratings. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly hasOfficialRating?: boolean - - /** - * Whether or not to hide items behind their boxsets. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly collapseBoxSetItems?: boolean - - /** - * Optional. Filter by the minimum width of the item. - * @type {number} - * @memberof ItemsApiGetItemsByUserId - */ - readonly minWidth?: number - - /** - * Optional. Filter by the minimum height of the item. - * @type {number} - * @memberof ItemsApiGetItemsByUserId - */ - readonly minHeight?: number - - /** - * Optional. Filter by the maximum width of the item. - * @type {number} - * @memberof ItemsApiGetItemsByUserId - */ - readonly maxWidth?: number - - /** - * Optional. Filter by the maximum height of the item. - * @type {number} - * @memberof ItemsApiGetItemsByUserId - */ - readonly maxHeight?: number - - /** - * Optional filter by items that are 3D, or not. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly is3D?: boolean - - /** - * Optional filter by Series Status. Allows multiple, comma delimited. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly seriesStatus?: Array - - /** - * Optional filter by items whose name is sorted equally or greater than a given input string. - * @type {string} - * @memberof ItemsApiGetItemsByUserId - */ - readonly nameStartsWithOrGreater?: string - - /** - * Optional filter by items whose name is sorted equally than a given input string. - * @type {string} - * @memberof ItemsApiGetItemsByUserId - */ - readonly nameStartsWith?: string - - /** - * Optional filter by items whose name is equally or lesser than a given input string. - * @type {string} - * @memberof ItemsApiGetItemsByUserId - */ - readonly nameLessThan?: string - - /** - * Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly studioIds?: Array - - /** - * Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited. - * @type {Array} - * @memberof ItemsApiGetItemsByUserId - */ - readonly genreIds?: Array - - /** - * Optional. Enable the total record count. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly enableTotalRecordCount?: boolean - - /** - * Optional, include image information in output. - * @type {boolean} - * @memberof ItemsApiGetItemsByUserId - */ - readonly enableImages?: boolean -} - /** * Request parameters for getResumeItems operation in ItemsApi. * @export @@ -2746,7 +1660,7 @@ export interface ItemsApiGetResumeItemsRequest { * @type {string} * @memberof ItemsApiGetResumeItems */ - readonly userId: string + readonly userId?: string /** * The start index. @@ -2785,10 +1699,10 @@ export interface ItemsApiGetResumeItemsRequest { /** * Optional. Filter by MediaType. Allows multiple, comma delimited. - * @type {Array} + * @type {Array} * @memberof ItemsApiGetResumeItems */ - readonly mediaTypes?: Array + readonly mediaTypes?: Array /** * Optional. Include user data. @@ -2847,6 +1761,34 @@ export interface ItemsApiGetResumeItemsRequest { readonly excludeActiveSessions?: boolean } +/** + * Request parameters for updateItemUserData operation in ItemsApi. + * @export + * @interface ItemsApiUpdateItemUserDataRequest + */ +export interface ItemsApiUpdateItemUserDataRequest { + /** + * The item id. + * @type {string} + * @memberof ItemsApiUpdateItemUserData + */ + readonly itemId: string + + /** + * New user data object. + * @type {UpdateUserItemDataDto} + * @memberof ItemsApiUpdateItemUserData + */ + readonly updateUserItemDataDto: UpdateUserItemDataDto + + /** + * The user id. + * @type {string} + * @memberof ItemsApiUpdateItemUserData + */ + readonly userId?: string +} + /** * ItemsApi - object-oriented interface * @export @@ -2854,6 +1796,18 @@ export interface ItemsApiGetResumeItemsRequest { * @extends {BaseAPI} */ export class ItemsApi extends BaseAPI { + /** + * + * @summary Get Item User Data. + * @param {ItemsApiGetItemUserDataRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ItemsApi + */ + public getItemUserData(requestParameters: ItemsApiGetItemUserDataRequest, options?: AxiosRequestConfig) { + return ItemsApiFp(this.configuration).getItemUserData(requestParameters.itemId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath)); + } + /** * * @summary Gets items based on a query. @@ -2866,18 +1820,6 @@ export class ItemsApi extends BaseAPI { return ItemsApiFp(this.configuration).getItems(requestParameters.userId, requestParameters.maxOfficialRating, requestParameters.hasThemeSong, requestParameters.hasThemeVideo, requestParameters.hasSubtitles, requestParameters.hasSpecialFeature, requestParameters.hasTrailer, requestParameters.adjacentTo, requestParameters.parentIndexNumber, requestParameters.hasParentalRating, requestParameters.isHd, requestParameters.is4K, requestParameters.locationTypes, requestParameters.excludeLocationTypes, requestParameters.isMissing, requestParameters.isUnaired, requestParameters.minCommunityRating, requestParameters.minCriticRating, requestParameters.minPremiereDate, requestParameters.minDateLastSaved, requestParameters.minDateLastSavedForUser, requestParameters.maxPremiereDate, requestParameters.hasOverview, requestParameters.hasImdbId, requestParameters.hasTmdbId, requestParameters.hasTvdbId, requestParameters.isMovie, requestParameters.isSeries, requestParameters.isNews, requestParameters.isKids, requestParameters.isSports, requestParameters.excludeItemIds, requestParameters.startIndex, requestParameters.limit, requestParameters.recursive, requestParameters.searchTerm, requestParameters.sortOrder, requestParameters.parentId, requestParameters.fields, requestParameters.excludeItemTypes, requestParameters.includeItemTypes, requestParameters.filters, requestParameters.isFavorite, requestParameters.mediaTypes, requestParameters.imageTypes, requestParameters.sortBy, requestParameters.isPlayed, requestParameters.genres, requestParameters.officialRatings, requestParameters.tags, requestParameters.years, requestParameters.enableUserData, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, requestParameters.person, requestParameters.personIds, requestParameters.personTypes, requestParameters.studios, requestParameters.artists, requestParameters.excludeArtistIds, requestParameters.artistIds, requestParameters.albumArtistIds, requestParameters.contributingArtistIds, requestParameters.albums, requestParameters.albumIds, requestParameters.ids, requestParameters.videoTypes, requestParameters.minOfficialRating, requestParameters.isLocked, requestParameters.isPlaceHolder, requestParameters.hasOfficialRating, requestParameters.collapseBoxSetItems, requestParameters.minWidth, requestParameters.minHeight, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.is3D, requestParameters.seriesStatus, requestParameters.nameStartsWithOrGreater, requestParameters.nameStartsWith, requestParameters.nameLessThan, requestParameters.studioIds, requestParameters.genreIds, requestParameters.enableTotalRecordCount, requestParameters.enableImages, options).then((request) => request(this.axios, this.basePath)); } - /** - * - * @summary Gets items based on a query. - * @param {ItemsApiGetItemsByUserIdRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ItemsApi - */ - public getItemsByUserId(requestParameters: ItemsApiGetItemsByUserIdRequest, options?: AxiosRequestConfig) { - return ItemsApiFp(this.configuration).getItemsByUserId(requestParameters.userId, requestParameters.maxOfficialRating, requestParameters.hasThemeSong, requestParameters.hasThemeVideo, requestParameters.hasSubtitles, requestParameters.hasSpecialFeature, requestParameters.hasTrailer, requestParameters.adjacentTo, requestParameters.parentIndexNumber, requestParameters.hasParentalRating, requestParameters.isHd, requestParameters.is4K, requestParameters.locationTypes, requestParameters.excludeLocationTypes, requestParameters.isMissing, requestParameters.isUnaired, requestParameters.minCommunityRating, requestParameters.minCriticRating, requestParameters.minPremiereDate, requestParameters.minDateLastSaved, requestParameters.minDateLastSavedForUser, requestParameters.maxPremiereDate, requestParameters.hasOverview, requestParameters.hasImdbId, requestParameters.hasTmdbId, requestParameters.hasTvdbId, requestParameters.isMovie, requestParameters.isSeries, requestParameters.isNews, requestParameters.isKids, requestParameters.isSports, requestParameters.excludeItemIds, requestParameters.startIndex, requestParameters.limit, requestParameters.recursive, requestParameters.searchTerm, requestParameters.sortOrder, requestParameters.parentId, requestParameters.fields, requestParameters.excludeItemTypes, requestParameters.includeItemTypes, requestParameters.filters, requestParameters.isFavorite, requestParameters.mediaTypes, requestParameters.imageTypes, requestParameters.sortBy, requestParameters.isPlayed, requestParameters.genres, requestParameters.officialRatings, requestParameters.tags, requestParameters.years, requestParameters.enableUserData, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, requestParameters.person, requestParameters.personIds, requestParameters.personTypes, requestParameters.studios, requestParameters.artists, requestParameters.excludeArtistIds, requestParameters.artistIds, requestParameters.albumArtistIds, requestParameters.contributingArtistIds, requestParameters.albums, requestParameters.albumIds, requestParameters.ids, requestParameters.videoTypes, requestParameters.minOfficialRating, requestParameters.isLocked, requestParameters.isPlaceHolder, requestParameters.hasOfficialRating, requestParameters.collapseBoxSetItems, requestParameters.minWidth, requestParameters.minHeight, requestParameters.maxWidth, requestParameters.maxHeight, requestParameters.is3D, requestParameters.seriesStatus, requestParameters.nameStartsWithOrGreater, requestParameters.nameStartsWith, requestParameters.nameLessThan, requestParameters.studioIds, requestParameters.genreIds, requestParameters.enableTotalRecordCount, requestParameters.enableImages, options).then((request) => request(this.axios, this.basePath)); - } - /** * * @summary Gets items based on a query. @@ -2886,7 +1828,19 @@ export class ItemsApi extends BaseAPI { * @throws {RequiredError} * @memberof ItemsApi */ - public getResumeItems(requestParameters: ItemsApiGetResumeItemsRequest, options?: AxiosRequestConfig) { + public getResumeItems(requestParameters: ItemsApiGetResumeItemsRequest = {}, options?: AxiosRequestConfig) { return ItemsApiFp(this.configuration).getResumeItems(requestParameters.userId, requestParameters.startIndex, requestParameters.limit, requestParameters.searchTerm, requestParameters.parentId, requestParameters.fields, requestParameters.mediaTypes, requestParameters.enableUserData, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, requestParameters.excludeItemTypes, requestParameters.includeItemTypes, requestParameters.enableTotalRecordCount, requestParameters.enableImages, requestParameters.excludeActiveSessions, options).then((request) => request(this.axios, this.basePath)); } + + /** + * + * @summary Update Item User Data. + * @param {ItemsApiUpdateItemUserDataRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ItemsApi + */ + public updateItemUserData(requestParameters: ItemsApiUpdateItemUserDataRequest, options?: AxiosRequestConfig) { + return ItemsApiFp(this.configuration).updateItemUserData(requestParameters.itemId, requestParameters.updateUserItemDataDto, requestParameters.userId, options).then((request) => request(this.axios, this.basePath)); + } } diff --git a/src/generated-client/api/library-api.ts b/src/generated-client/api/library-api.ts index 278ea411..797e59d1 100644 --- a/src/generated-client/api/library-api.ts +++ b/src/generated-client/api/library-api.ts @@ -26,6 +26,8 @@ import { BaseItemDto } from '../models'; // @ts-ignore import { BaseItemDtoQueryResult } from '../models'; // @ts-ignore +import { CollectionType } from '../models'; +// @ts-ignore import { ItemCounts } from '../models'; // @ts-ignore import { ItemFields } from '../models'; @@ -318,12 +320,12 @@ export const LibraryApiAxiosParamCreator = function (configuration?: Configurati /** * * @summary Gets the library options info. - * @param {string} [libraryContentType] Library content type. + * @param {CollectionType} [libraryContentType] Library content type. * @param {boolean} [isNewLibrary] Whether this is a new library. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getLibraryOptionsInfo: async (libraryContentType?: string, isNewLibrary?: boolean, options: AxiosRequestConfig = {}): Promise => { + getLibraryOptionsInfo: async (libraryContentType?: CollectionType, isNewLibrary?: boolean, options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/Libraries/AvailableOptions`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -1239,12 +1241,12 @@ export const LibraryApiFp = function(configuration?: Configuration) { /** * * @summary Gets the library options info. - * @param {string} [libraryContentType] Library content type. + * @param {CollectionType} [libraryContentType] Library content type. * @param {boolean} [isNewLibrary] Whether this is a new library. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getLibraryOptionsInfo(libraryContentType?: string, isNewLibrary?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getLibraryOptionsInfo(libraryContentType?: CollectionType, isNewLibrary?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getLibraryOptionsInfo(libraryContentType, isNewLibrary, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -1551,12 +1553,12 @@ export const LibraryApiFactory = function (configuration?: Configuration, basePa /** * * @summary Gets the library options info. - * @param {string} [libraryContentType] Library content type. + * @param {CollectionType} [libraryContentType] Library content type. * @param {boolean} [isNewLibrary] Whether this is a new library. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getLibraryOptionsInfo(libraryContentType?: string, isNewLibrary?: boolean, options?: any): AxiosPromise { + getLibraryOptionsInfo(libraryContentType?: CollectionType, isNewLibrary?: boolean, options?: any): AxiosPromise { return localVarFp.getLibraryOptionsInfo(libraryContentType, isNewLibrary, options).then((request) => request(axios, basePath)); }, /** @@ -1882,10 +1884,10 @@ export interface LibraryApiGetItemCountsRequest { export interface LibraryApiGetLibraryOptionsInfoRequest { /** * Library content type. - * @type {string} + * @type {CollectionType} * @memberof LibraryApiGetLibraryOptionsInfo */ - readonly libraryContentType?: string + readonly libraryContentType?: CollectionType /** * Whether this is a new library. diff --git a/src/generated-client/api/live-tv-api.ts b/src/generated-client/api/live-tv-api.ts index 7b62e481..c8d537c3 100644 --- a/src/generated-client/api/live-tv-api.ts +++ b/src/generated-client/api/live-tv-api.ts @@ -36,6 +36,8 @@ import { ImageType } from '../models'; // @ts-ignore import { ItemFields } from '../models'; // @ts-ignore +import { ItemSortBy } from '../models'; +// @ts-ignore import { ListingsProviderInfo } from '../models'; // @ts-ignore import { LiveTvInfo } from '../models'; @@ -822,14 +824,14 @@ export const LiveTvApiAxiosParamCreator = function (configuration?: Configuratio * @param {Array} [enableImageTypes] \"Optional. The image types to include in the output. * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. * @param {boolean} [enableUserData] Optional. Include user data. - * @param {Array} [sortBy] Optional. Key to sort by. + * @param {Array} [sortBy] Optional. Key to sort by. * @param {SortOrder} [sortOrder] Optional. Sort order. * @param {boolean} [enableFavoriteSorting] Optional. Incorporate favorite and like status into channel sorting. * @param {boolean} [addCurrentProgram] Optional. Adds current program info to each channel. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getLiveTvChannels: async (type?: ChannelType, userId?: string, startIndex?: number, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, limit?: number, isFavorite?: boolean, isLiked?: boolean, isDisliked?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, fields?: Array, enableUserData?: boolean, sortBy?: Array, sortOrder?: SortOrder, enableFavoriteSorting?: boolean, addCurrentProgram?: boolean, options: AxiosRequestConfig = {}): Promise => { + getLiveTvChannels: async (type?: ChannelType, userId?: string, startIndex?: number, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, limit?: number, isFavorite?: boolean, isLiked?: boolean, isDisliked?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, fields?: Array, enableUserData?: boolean, sortBy?: Array, sortOrder?: SortOrder, enableFavoriteSorting?: boolean, addCurrentProgram?: boolean, options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/LiveTv/Channels`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -991,7 +993,7 @@ export const LiveTvApiAxiosParamCreator = function (configuration?: Configuratio * @param {boolean} [isSports] Optional. Filter for sports. * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results. * @param {number} [limit] Optional. The maximum number of records to return. - * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate. + * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate. * @param {Array} [sortOrder] Sort Order - Ascending,Descending. * @param {Array} [genres] The genres to return guide information for. * @param {Array} [genreIds] The genre ids to return guide information for. @@ -1006,7 +1008,7 @@ export const LiveTvApiAxiosParamCreator = function (configuration?: Configuratio * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getLiveTvPrograms: async (channelIds?: Array, userId?: string, minStartDate?: string, hasAired?: boolean, isAiring?: boolean, maxStartDate?: string, minEndDate?: string, maxEndDate?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, startIndex?: number, limit?: number, sortBy?: Array, sortOrder?: Array, genres?: Array, genreIds?: Array, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, enableUserData?: boolean, seriesTimerId?: string, librarySeriesId?: string, fields?: Array, enableTotalRecordCount?: boolean, options: AxiosRequestConfig = {}): Promise => { + getLiveTvPrograms: async (channelIds?: Array, userId?: string, minStartDate?: string, hasAired?: boolean, isAiring?: boolean, maxStartDate?: string, minEndDate?: string, maxEndDate?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, startIndex?: number, limit?: number, sortBy?: Array, sortOrder?: Array, genres?: Array, genreIds?: Array, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, enableUserData?: boolean, seriesTimerId?: string, librarySeriesId?: string, fields?: Array, enableTotalRecordCount?: boolean, options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/LiveTv/Programs`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -2369,14 +2371,14 @@ export const LiveTvApiFp = function(configuration?: Configuration) { * @param {Array} [enableImageTypes] \"Optional. The image types to include in the output. * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. * @param {boolean} [enableUserData] Optional. Include user data. - * @param {Array} [sortBy] Optional. Key to sort by. + * @param {Array} [sortBy] Optional. Key to sort by. * @param {SortOrder} [sortOrder] Optional. Sort order. * @param {boolean} [enableFavoriteSorting] Optional. Incorporate favorite and like status into channel sorting. * @param {boolean} [addCurrentProgram] Optional. Adds current program info to each channel. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getLiveTvChannels(type?: ChannelType, userId?: string, startIndex?: number, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, limit?: number, isFavorite?: boolean, isLiked?: boolean, isDisliked?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, fields?: Array, enableUserData?: boolean, sortBy?: Array, sortOrder?: SortOrder, enableFavoriteSorting?: boolean, addCurrentProgram?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getLiveTvChannels(type?: ChannelType, userId?: string, startIndex?: number, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, limit?: number, isFavorite?: boolean, isLiked?: boolean, isDisliked?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, fields?: Array, enableUserData?: boolean, sortBy?: Array, sortOrder?: SortOrder, enableFavoriteSorting?: boolean, addCurrentProgram?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getLiveTvChannels(type, userId, startIndex, isMovie, isSeries, isNews, isKids, isSports, limit, isFavorite, isLiked, isDisliked, enableImages, imageTypeLimit, enableImageTypes, fields, enableUserData, sortBy, sortOrder, enableFavoriteSorting, addCurrentProgram, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -2408,7 +2410,7 @@ export const LiveTvApiFp = function(configuration?: Configuration) { * @param {boolean} [isSports] Optional. Filter for sports. * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results. * @param {number} [limit] Optional. The maximum number of records to return. - * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate. + * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate. * @param {Array} [sortOrder] Sort Order - Ascending,Descending. * @param {Array} [genres] The genres to return guide information for. * @param {Array} [genreIds] The genre ids to return guide information for. @@ -2423,7 +2425,7 @@ export const LiveTvApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getLiveTvPrograms(channelIds?: Array, userId?: string, minStartDate?: string, hasAired?: boolean, isAiring?: boolean, maxStartDate?: string, minEndDate?: string, maxEndDate?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, startIndex?: number, limit?: number, sortBy?: Array, sortOrder?: Array, genres?: Array, genreIds?: Array, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, enableUserData?: boolean, seriesTimerId?: string, librarySeriesId?: string, fields?: Array, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getLiveTvPrograms(channelIds?: Array, userId?: string, minStartDate?: string, hasAired?: boolean, isAiring?: boolean, maxStartDate?: string, minEndDate?: string, maxEndDate?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, startIndex?: number, limit?: number, sortBy?: Array, sortOrder?: Array, genres?: Array, genreIds?: Array, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, enableUserData?: boolean, seriesTimerId?: string, librarySeriesId?: string, fields?: Array, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getLiveTvPrograms(channelIds, userId, minStartDate, hasAired, isAiring, maxStartDate, minEndDate, maxEndDate, isMovie, isSeries, isNews, isKids, isSports, startIndex, limit, sortBy, sortOrder, genres, genreIds, enableImages, imageTypeLimit, enableImageTypes, enableUserData, seriesTimerId, librarySeriesId, fields, enableTotalRecordCount, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -2917,14 +2919,14 @@ export const LiveTvApiFactory = function (configuration?: Configuration, basePat * @param {Array} [enableImageTypes] \"Optional. The image types to include in the output. * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. * @param {boolean} [enableUserData] Optional. Include user data. - * @param {Array} [sortBy] Optional. Key to sort by. + * @param {Array} [sortBy] Optional. Key to sort by. * @param {SortOrder} [sortOrder] Optional. Sort order. * @param {boolean} [enableFavoriteSorting] Optional. Incorporate favorite and like status into channel sorting. * @param {boolean} [addCurrentProgram] Optional. Adds current program info to each channel. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getLiveTvChannels(type?: ChannelType, userId?: string, startIndex?: number, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, limit?: number, isFavorite?: boolean, isLiked?: boolean, isDisliked?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, fields?: Array, enableUserData?: boolean, sortBy?: Array, sortOrder?: SortOrder, enableFavoriteSorting?: boolean, addCurrentProgram?: boolean, options?: any): AxiosPromise { + getLiveTvChannels(type?: ChannelType, userId?: string, startIndex?: number, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, limit?: number, isFavorite?: boolean, isLiked?: boolean, isDisliked?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, fields?: Array, enableUserData?: boolean, sortBy?: Array, sortOrder?: SortOrder, enableFavoriteSorting?: boolean, addCurrentProgram?: boolean, options?: any): AxiosPromise { return localVarFp.getLiveTvChannels(type, userId, startIndex, isMovie, isSeries, isNews, isKids, isSports, limit, isFavorite, isLiked, isDisliked, enableImages, imageTypeLimit, enableImageTypes, fields, enableUserData, sortBy, sortOrder, enableFavoriteSorting, addCurrentProgram, options).then((request) => request(axios, basePath)); }, /** @@ -2954,7 +2956,7 @@ export const LiveTvApiFactory = function (configuration?: Configuration, basePat * @param {boolean} [isSports] Optional. Filter for sports. * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results. * @param {number} [limit] Optional. The maximum number of records to return. - * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate. + * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate. * @param {Array} [sortOrder] Sort Order - Ascending,Descending. * @param {Array} [genres] The genres to return guide information for. * @param {Array} [genreIds] The genre ids to return guide information for. @@ -2969,7 +2971,7 @@ export const LiveTvApiFactory = function (configuration?: Configuration, basePat * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getLiveTvPrograms(channelIds?: Array, userId?: string, minStartDate?: string, hasAired?: boolean, isAiring?: boolean, maxStartDate?: string, minEndDate?: string, maxEndDate?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, startIndex?: number, limit?: number, sortBy?: Array, sortOrder?: Array, genres?: Array, genreIds?: Array, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, enableUserData?: boolean, seriesTimerId?: string, librarySeriesId?: string, fields?: Array, enableTotalRecordCount?: boolean, options?: any): AxiosPromise { + getLiveTvPrograms(channelIds?: Array, userId?: string, minStartDate?: string, hasAired?: boolean, isAiring?: boolean, maxStartDate?: string, minEndDate?: string, maxEndDate?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, startIndex?: number, limit?: number, sortBy?: Array, sortOrder?: Array, genres?: Array, genreIds?: Array, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, enableUserData?: boolean, seriesTimerId?: string, librarySeriesId?: string, fields?: Array, enableTotalRecordCount?: boolean, options?: any): AxiosPromise { return localVarFp.getLiveTvPrograms(channelIds, userId, minStartDate, hasAired, isAiring, maxStartDate, minEndDate, maxEndDate, isMovie, isSeries, isNews, isKids, isSports, startIndex, limit, sortBy, sortOrder, genres, genreIds, enableImages, imageTypeLimit, enableImageTypes, enableUserData, seriesTimerId, librarySeriesId, fields, enableTotalRecordCount, options).then((request) => request(axios, basePath)); }, /** @@ -3641,10 +3643,10 @@ export interface LiveTvApiGetLiveTvChannelsRequest { /** * Optional. Key to sort by. - * @type {Array} + * @type {Array} * @memberof LiveTvApiGetLiveTvChannels */ - readonly sortBy?: Array + readonly sortBy?: Array /** * Optional. Sort order. @@ -3781,10 +3783,10 @@ export interface LiveTvApiGetLiveTvProgramsRequest { /** * Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate. - * @type {Array} + * @type {Array} * @memberof LiveTvApiGetLiveTvPrograms */ - readonly sortBy?: Array + readonly sortBy?: Array /** * Sort Order - Ascending,Descending. diff --git a/src/generated-client/api/lyrics-api.ts b/src/generated-client/api/lyrics-api.ts new file mode 100644 index 00000000..04836687 --- /dev/null +++ b/src/generated-client/api/lyrics-api.ts @@ -0,0 +1,609 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; +import { Configuration } from '../configuration'; +// Some imports not used depending on template conditions +// @ts-ignore +import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common'; +// @ts-ignore +import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base'; +// @ts-ignore +import { LyricDto } from '../models'; +// @ts-ignore +import { ProblemDetails } from '../models'; +// @ts-ignore +import { RemoteLyricInfoDto } from '../models'; +/** + * LyricsApi - axios parameter creator + * @export + */ +export const LyricsApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * + * @summary Deletes an external lyric file. + * @param {string} itemId The item id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteLyrics: async (itemId: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'itemId' is not null or undefined + assertParamExists('deleteLyrics', 'itemId', itemId) + const localVarPath = `/Audio/{itemId}/Lyrics` + .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication CustomAuthentication required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Downloads a remote lyric. + * @param {string} itemId The item id. + * @param {string} lyricId The lyric id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + downloadRemoteLyrics: async (itemId: string, lyricId: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'itemId' is not null or undefined + assertParamExists('downloadRemoteLyrics', 'itemId', itemId) + // verify required parameter 'lyricId' is not null or undefined + assertParamExists('downloadRemoteLyrics', 'lyricId', lyricId) + const localVarPath = `/Audio/{itemId}/RemoteSearch/Lyrics/{lyricId}` + .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))) + .replace(`{${"lyricId"}}`, encodeURIComponent(String(lyricId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication CustomAuthentication required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Gets an item\'s lyrics. + * @param {string} itemId Item id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getLyrics: async (itemId: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'itemId' is not null or undefined + assertParamExists('getLyrics', 'itemId', itemId) + const localVarPath = `/Audio/{itemId}/Lyrics` + .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication CustomAuthentication required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Gets the remote lyrics. + * @param {string} lyricId The remote provider item id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getRemoteLyrics: async (lyricId: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'lyricId' is not null or undefined + assertParamExists('getRemoteLyrics', 'lyricId', lyricId) + const localVarPath = `/Providers/Lyrics/{lyricId}` + .replace(`{${"lyricId"}}`, encodeURIComponent(String(lyricId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication CustomAuthentication required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Search remote lyrics. + * @param {string} itemId The item id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + searchRemoteLyrics: async (itemId: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'itemId' is not null or undefined + assertParamExists('searchRemoteLyrics', 'itemId', itemId) + const localVarPath = `/Audio/{itemId}/RemoteSearch/Lyrics` + .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication CustomAuthentication required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Upload an external lyric file. + * @param {string} itemId The item the lyric belongs to. + * @param {string} fileName Name of the file being uploaded. + * @param {any} [body] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + uploadLyrics: async (itemId: string, fileName: string, body?: any, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'itemId' is not null or undefined + assertParamExists('uploadLyrics', 'itemId', itemId) + // verify required parameter 'fileName' is not null or undefined + assertParamExists('uploadLyrics', 'fileName', fileName) + const localVarPath = `/Audio/{itemId}/Lyrics` + .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication CustomAuthentication required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + if (fileName !== undefined) { + localVarQueryParameter['fileName'] = fileName; + } + + + + localVarHeaderParameter['Content-Type'] = 'text/plain'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * LyricsApi - functional programming interface + * @export + */ +export const LyricsApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = LyricsApiAxiosParamCreator(configuration) + return { + /** + * + * @summary Deletes an external lyric file. + * @param {string} itemId The item id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async deleteLyrics(itemId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteLyrics(itemId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Downloads a remote lyric. + * @param {string} itemId The item id. + * @param {string} lyricId The lyric id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async downloadRemoteLyrics(itemId: string, lyricId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.downloadRemoteLyrics(itemId, lyricId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Gets an item\'s lyrics. + * @param {string} itemId Item id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getLyrics(itemId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getLyrics(itemId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Gets the remote lyrics. + * @param {string} lyricId The remote provider item id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getRemoteLyrics(lyricId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getRemoteLyrics(lyricId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Search remote lyrics. + * @param {string} itemId The item id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async searchRemoteLyrics(itemId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.searchRemoteLyrics(itemId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Upload an external lyric file. + * @param {string} itemId The item the lyric belongs to. + * @param {string} fileName Name of the file being uploaded. + * @param {any} [body] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async uploadLyrics(itemId: string, fileName: string, body?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.uploadLyrics(itemId, fileName, body, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + } +}; + +/** + * LyricsApi - factory interface + * @export + */ +export const LyricsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = LyricsApiFp(configuration) + return { + /** + * + * @summary Deletes an external lyric file. + * @param {string} itemId The item id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteLyrics(itemId: string, options?: any): AxiosPromise { + return localVarFp.deleteLyrics(itemId, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Downloads a remote lyric. + * @param {string} itemId The item id. + * @param {string} lyricId The lyric id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + downloadRemoteLyrics(itemId: string, lyricId: string, options?: any): AxiosPromise { + return localVarFp.downloadRemoteLyrics(itemId, lyricId, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Gets an item\'s lyrics. + * @param {string} itemId Item id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getLyrics(itemId: string, options?: any): AxiosPromise { + return localVarFp.getLyrics(itemId, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Gets the remote lyrics. + * @param {string} lyricId The remote provider item id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getRemoteLyrics(lyricId: string, options?: any): AxiosPromise { + return localVarFp.getRemoteLyrics(lyricId, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Search remote lyrics. + * @param {string} itemId The item id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + searchRemoteLyrics(itemId: string, options?: any): AxiosPromise> { + return localVarFp.searchRemoteLyrics(itemId, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Upload an external lyric file. + * @param {string} itemId The item the lyric belongs to. + * @param {string} fileName Name of the file being uploaded. + * @param {any} [body] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + uploadLyrics(itemId: string, fileName: string, body?: any, options?: any): AxiosPromise { + return localVarFp.uploadLyrics(itemId, fileName, body, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for deleteLyrics operation in LyricsApi. + * @export + * @interface LyricsApiDeleteLyricsRequest + */ +export interface LyricsApiDeleteLyricsRequest { + /** + * The item id. + * @type {string} + * @memberof LyricsApiDeleteLyrics + */ + readonly itemId: string +} + +/** + * Request parameters for downloadRemoteLyrics operation in LyricsApi. + * @export + * @interface LyricsApiDownloadRemoteLyricsRequest + */ +export interface LyricsApiDownloadRemoteLyricsRequest { + /** + * The item id. + * @type {string} + * @memberof LyricsApiDownloadRemoteLyrics + */ + readonly itemId: string + + /** + * The lyric id. + * @type {string} + * @memberof LyricsApiDownloadRemoteLyrics + */ + readonly lyricId: string +} + +/** + * Request parameters for getLyrics operation in LyricsApi. + * @export + * @interface LyricsApiGetLyricsRequest + */ +export interface LyricsApiGetLyricsRequest { + /** + * Item id. + * @type {string} + * @memberof LyricsApiGetLyrics + */ + readonly itemId: string +} + +/** + * Request parameters for getRemoteLyrics operation in LyricsApi. + * @export + * @interface LyricsApiGetRemoteLyricsRequest + */ +export interface LyricsApiGetRemoteLyricsRequest { + /** + * The remote provider item id. + * @type {string} + * @memberof LyricsApiGetRemoteLyrics + */ + readonly lyricId: string +} + +/** + * Request parameters for searchRemoteLyrics operation in LyricsApi. + * @export + * @interface LyricsApiSearchRemoteLyricsRequest + */ +export interface LyricsApiSearchRemoteLyricsRequest { + /** + * The item id. + * @type {string} + * @memberof LyricsApiSearchRemoteLyrics + */ + readonly itemId: string +} + +/** + * Request parameters for uploadLyrics operation in LyricsApi. + * @export + * @interface LyricsApiUploadLyricsRequest + */ +export interface LyricsApiUploadLyricsRequest { + /** + * The item the lyric belongs to. + * @type {string} + * @memberof LyricsApiUploadLyrics + */ + readonly itemId: string + + /** + * Name of the file being uploaded. + * @type {string} + * @memberof LyricsApiUploadLyrics + */ + readonly fileName: string + + /** + * + * @type {any} + * @memberof LyricsApiUploadLyrics + */ + readonly body?: any +} + +/** + * LyricsApi - object-oriented interface + * @export + * @class LyricsApi + * @extends {BaseAPI} + */ +export class LyricsApi extends BaseAPI { + /** + * + * @summary Deletes an external lyric file. + * @param {LyricsApiDeleteLyricsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LyricsApi + */ + public deleteLyrics(requestParameters: LyricsApiDeleteLyricsRequest, options?: AxiosRequestConfig) { + return LyricsApiFp(this.configuration).deleteLyrics(requestParameters.itemId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Downloads a remote lyric. + * @param {LyricsApiDownloadRemoteLyricsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LyricsApi + */ + public downloadRemoteLyrics(requestParameters: LyricsApiDownloadRemoteLyricsRequest, options?: AxiosRequestConfig) { + return LyricsApiFp(this.configuration).downloadRemoteLyrics(requestParameters.itemId, requestParameters.lyricId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Gets an item\'s lyrics. + * @param {LyricsApiGetLyricsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LyricsApi + */ + public getLyrics(requestParameters: LyricsApiGetLyricsRequest, options?: AxiosRequestConfig) { + return LyricsApiFp(this.configuration).getLyrics(requestParameters.itemId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Gets the remote lyrics. + * @param {LyricsApiGetRemoteLyricsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LyricsApi + */ + public getRemoteLyrics(requestParameters: LyricsApiGetRemoteLyricsRequest, options?: AxiosRequestConfig) { + return LyricsApiFp(this.configuration).getRemoteLyrics(requestParameters.lyricId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Search remote lyrics. + * @param {LyricsApiSearchRemoteLyricsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LyricsApi + */ + public searchRemoteLyrics(requestParameters: LyricsApiSearchRemoteLyricsRequest, options?: AxiosRequestConfig) { + return LyricsApiFp(this.configuration).searchRemoteLyrics(requestParameters.itemId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Upload an external lyric file. + * @param {LyricsApiUploadLyricsRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LyricsApi + */ + public uploadLyrics(requestParameters: LyricsApiUploadLyricsRequest, options?: AxiosRequestConfig) { + return LyricsApiFp(this.configuration).uploadLyrics(requestParameters.itemId, requestParameters.fileName, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); + } +} diff --git a/src/generated-client/api/media-info-api.ts b/src/generated-client/api/media-info-api.ts index bbe14325..5e250857 100644 --- a/src/generated-client/api/media-info-api.ts +++ b/src/generated-client/api/media-info-api.ts @@ -27,6 +27,8 @@ import { OpenLiveStreamDto } from '../models'; import { PlaybackInfoDto } from '../models'; // @ts-ignore import { PlaybackInfoResponse } from '../models'; +// @ts-ignore +import { ProblemDetails } from '../models'; /** * MediaInfoApi - axios parameter creator * @export @@ -115,15 +117,13 @@ export const MediaInfoApiAxiosParamCreator = function (configuration?: Configura * * @summary Gets live playback media info for an item. * @param {string} itemId The item id. - * @param {string} userId The user id. + * @param {string} [userId] The user id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getPlaybackInfo: async (itemId: string, userId: string, options: AxiosRequestConfig = {}): Promise => { + getPlaybackInfo: async (itemId: string, userId?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'itemId' is not null or undefined assertParamExists('getPlaybackInfo', 'itemId', itemId) - // verify required parameter 'userId' is not null or undefined - assertParamExists('getPlaybackInfo', 'userId', userId) const localVarPath = `/Items/{itemId}/PlaybackInfo` .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. @@ -394,11 +394,11 @@ export const MediaInfoApiFp = function(configuration?: Configuration) { * * @summary Gets live playback media info for an item. * @param {string} itemId The item id. - * @param {string} userId The user id. + * @param {string} [userId] The user id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getPlaybackInfo(itemId: string, userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getPlaybackInfo(itemId: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getPlaybackInfo(itemId, userId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -484,11 +484,11 @@ export const MediaInfoApiFactory = function (configuration?: Configuration, base * * @summary Gets live playback media info for an item. * @param {string} itemId The item id. - * @param {string} userId The user id. + * @param {string} [userId] The user id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getPlaybackInfo(itemId: string, userId: string, options?: any): AxiosPromise { + getPlaybackInfo(itemId: string, userId?: string, options?: any): AxiosPromise { return localVarFp.getPlaybackInfo(itemId, userId, options).then((request) => request(axios, basePath)); }, /** @@ -586,7 +586,7 @@ export interface MediaInfoApiGetPlaybackInfoRequest { * @type {string} * @memberof MediaInfoApiGetPlaybackInfo */ - readonly userId: string + readonly userId?: string } /** diff --git a/src/generated-client/api/music-genres-api.ts b/src/generated-client/api/music-genres-api.ts index 4fb9c8e2..af76c8ee 100644 --- a/src/generated-client/api/music-genres-api.ts +++ b/src/generated-client/api/music-genres-api.ts @@ -30,6 +30,8 @@ import { ImageType } from '../models'; // @ts-ignore import { ItemFields } from '../models'; // @ts-ignore +import { ItemSortBy } from '../models'; +// @ts-ignore import { SortOrder } from '../models'; /** * MusicGenresApi - axios parameter creator @@ -96,7 +98,7 @@ export const MusicGenresApiAxiosParamCreator = function (configuration?: Configu * @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string. * @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string. * @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string. - * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. + * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. * @param {Array} [sortOrder] Sort Order - Ascending,Descending. * @param {boolean} [enableImages] Optional, include image information in output. * @param {boolean} [enableTotalRecordCount] Optional. Include total record count. @@ -104,7 +106,7 @@ export const MusicGenresApiAxiosParamCreator = function (configuration?: Configu * @deprecated * @throws {RequiredError} */ - getMusicGenres: async (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array, sortOrder?: Array, enableImages?: boolean, enableTotalRecordCount?: boolean, options: AxiosRequestConfig = {}): Promise => { + getMusicGenres: async (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array, sortOrder?: Array, enableImages?: boolean, enableTotalRecordCount?: boolean, options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/MusicGenres`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -242,7 +244,7 @@ export const MusicGenresApiFp = function(configuration?: Configuration) { * @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string. * @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string. * @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string. - * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. + * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. * @param {Array} [sortOrder] Sort Order - Ascending,Descending. * @param {boolean} [enableImages] Optional, include image information in output. * @param {boolean} [enableTotalRecordCount] Optional. Include total record count. @@ -250,7 +252,7 @@ export const MusicGenresApiFp = function(configuration?: Configuration) { * @deprecated * @throws {RequiredError} */ - async getMusicGenres(startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array, sortOrder?: Array, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getMusicGenres(startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array, sortOrder?: Array, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getMusicGenres(startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, isFavorite, imageTypeLimit, enableImageTypes, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -292,7 +294,7 @@ export const MusicGenresApiFactory = function (configuration?: Configuration, ba * @param {string} [nameStartsWithOrGreater] Optional filter by items whose name is sorted equally or greater than a given input string. * @param {string} [nameStartsWith] Optional filter by items whose name is sorted equally than a given input string. * @param {string} [nameLessThan] Optional filter by items whose name is equally or lesser than a given input string. - * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. + * @param {Array} [sortBy] Optional. Specify one or more sort orders, comma delimited. * @param {Array} [sortOrder] Sort Order - Ascending,Descending. * @param {boolean} [enableImages] Optional, include image information in output. * @param {boolean} [enableTotalRecordCount] Optional. Include total record count. @@ -300,7 +302,7 @@ export const MusicGenresApiFactory = function (configuration?: Configuration, ba * @deprecated * @throws {RequiredError} */ - getMusicGenres(startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array, sortOrder?: Array, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise { + getMusicGenres(startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array, sortOrder?: Array, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise { return localVarFp.getMusicGenres(startIndex, limit, searchTerm, parentId, fields, excludeItemTypes, includeItemTypes, isFavorite, imageTypeLimit, enableImageTypes, userId, nameStartsWithOrGreater, nameStartsWith, nameLessThan, sortBy, sortOrder, enableImages, enableTotalRecordCount, options).then((request) => request(axios, basePath)); }, }; @@ -433,10 +435,10 @@ export interface MusicGenresApiGetMusicGenresRequest { /** * Optional. Specify one or more sort orders, comma delimited. - * @type {Array} + * @type {Array} * @memberof MusicGenresApiGetMusicGenres */ - readonly sortBy?: Array + readonly sortBy?: Array /** * Sort Order - Ascending,Descending. diff --git a/src/generated-client/api/playlists-api.ts b/src/generated-client/api/playlists-api.ts index 23ee67e8..6a128928 100644 --- a/src/generated-client/api/playlists-api.ts +++ b/src/generated-client/api/playlists-api.ts @@ -28,7 +28,17 @@ import { ImageType } from '../models'; // @ts-ignore import { ItemFields } from '../models'; // @ts-ignore +import { MediaType } from '../models'; +// @ts-ignore import { PlaylistCreationResult } from '../models'; +// @ts-ignore +import { PlaylistUserPermissions } from '../models'; +// @ts-ignore +import { ProblemDetails } from '../models'; +// @ts-ignore +import { UpdatePlaylistDto } from '../models'; +// @ts-ignore +import { UpdatePlaylistUserDto } from '../models'; /** * PlaylistsApi - axios parameter creator * @export @@ -44,9 +54,9 @@ export const PlaylistsApiAxiosParamCreator = function (configuration?: Configura * @param {*} [options] Override http request option. * @throws {RequiredError} */ - addToPlaylist: async (playlistId: string, ids?: Array, userId?: string, options: AxiosRequestConfig = {}): Promise => { + addItemToPlaylist: async (playlistId: string, ids?: Array, userId?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'playlistId' is not null or undefined - assertParamExists('addToPlaylist', 'playlistId', playlistId) + assertParamExists('addItemToPlaylist', 'playlistId', playlistId) const localVarPath = `/Playlists/{playlistId}/Items` .replace(`{${"playlistId"}}`, encodeURIComponent(String(playlistId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. @@ -88,12 +98,12 @@ export const PlaylistsApiAxiosParamCreator = function (configuration?: Configura * @param {string} [name] The playlist name. * @param {Array} [ids] The item ids. * @param {string} [userId] The user id. - * @param {string} [mediaType] The media type. + * @param {MediaType} [mediaType] The media type. * @param {CreatePlaylistDto} [createPlaylistDto] The create playlist payload. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - createPlaylist: async (name?: string, ids?: Array, userId?: string, mediaType?: string, createPlaylistDto?: CreatePlaylistDto, options: AxiosRequestConfig = {}): Promise => { + createPlaylist: async (name?: string, ids?: Array, userId?: string, mediaType?: MediaType, createPlaylistDto?: CreatePlaylistDto, options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/Playlists`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -143,7 +153,7 @@ export const PlaylistsApiAxiosParamCreator = function (configuration?: Configura * * @summary Gets the original items of a playlist. * @param {string} playlistId The playlist id. - * @param {string} userId User id. + * @param {string} [userId] User id. * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results. * @param {number} [limit] Optional. The maximum number of records to return. * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. @@ -154,11 +164,9 @@ export const PlaylistsApiAxiosParamCreator = function (configuration?: Configura * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getPlaylistItems: async (playlistId: string, userId: string, startIndex?: number, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options: AxiosRequestConfig = {}): Promise => { + getPlaylistItems: async (playlistId: string, userId?: string, startIndex?: number, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'playlistId' is not null or undefined assertParamExists('getPlaylistItems', 'playlistId', playlistId) - // verify required parameter 'userId' is not null or undefined - assertParamExists('getPlaylistItems', 'userId', userId) const localVarPath = `/Playlists/{playlistId}/Items` .replace(`{${"playlistId"}}`, encodeURIComponent(String(playlistId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. @@ -209,6 +217,84 @@ export const PlaylistsApiAxiosParamCreator = function (configuration?: Configura + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Get a playlist user. + * @param {string} playlistId The playlist id. + * @param {string} userId The user id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getPlaylistUser: async (playlistId: string, userId: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'playlistId' is not null or undefined + assertParamExists('getPlaylistUser', 'playlistId', playlistId) + // verify required parameter 'userId' is not null or undefined + assertParamExists('getPlaylistUser', 'userId', userId) + const localVarPath = `/Playlists/{playlistId}/Users/{userId}` + .replace(`{${"playlistId"}}`, encodeURIComponent(String(playlistId))) + .replace(`{${"userId"}}`, encodeURIComponent(String(userId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication CustomAuthentication required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Get a playlist\'s users. + * @param {string} playlistId The playlist id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getPlaylistUsers: async (playlistId: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'playlistId' is not null or undefined + assertParamExists('getPlaylistUsers', 'playlistId', playlistId) + const localVarPath = `/Playlists/{playlistId}/Users` + .replace(`{${"playlistId"}}`, encodeURIComponent(String(playlistId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication CustomAuthentication required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -271,9 +357,9 @@ export const PlaylistsApiAxiosParamCreator = function (configuration?: Configura * @param {*} [options] Override http request option. * @throws {RequiredError} */ - removeFromPlaylist: async (playlistId: string, entryIds?: Array, options: AxiosRequestConfig = {}): Promise => { + removeItemFromPlaylist: async (playlistId: string, entryIds?: Array, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'playlistId' is not null or undefined - assertParamExists('removeFromPlaylist', 'playlistId', playlistId) + assertParamExists('removeItemFromPlaylist', 'playlistId', playlistId) const localVarPath = `/Playlists/{playlistId}/Items` .replace(`{${"playlistId"}}`, encodeURIComponent(String(playlistId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. @@ -300,6 +386,137 @@ export const PlaylistsApiAxiosParamCreator = function (configuration?: Configura let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Remove a user from a playlist\'s users. + * @param {string} playlistId The playlist id. + * @param {string} userId The user id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + removeUserFromPlaylist: async (playlistId: string, userId: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'playlistId' is not null or undefined + assertParamExists('removeUserFromPlaylist', 'playlistId', playlistId) + // verify required parameter 'userId' is not null or undefined + assertParamExists('removeUserFromPlaylist', 'userId', userId) + const localVarPath = `/Playlists/{playlistId}/Users/{userId}` + .replace(`{${"playlistId"}}`, encodeURIComponent(String(playlistId))) + .replace(`{${"userId"}}`, encodeURIComponent(String(userId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication CustomAuthentication required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Updates a playlist. + * @param {string} playlistId The playlist id. + * @param {UpdatePlaylistDto} updatePlaylistDto The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistDto id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updatePlaylist: async (playlistId: string, updatePlaylistDto: UpdatePlaylistDto, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'playlistId' is not null or undefined + assertParamExists('updatePlaylist', 'playlistId', playlistId) + // verify required parameter 'updatePlaylistDto' is not null or undefined + assertParamExists('updatePlaylist', 'updatePlaylistDto', updatePlaylistDto) + const localVarPath = `/Playlists/{playlistId}` + .replace(`{${"playlistId"}}`, encodeURIComponent(String(playlistId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication CustomAuthentication required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(updatePlaylistDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Modify a user of a playlist\'s users. + * @param {string} playlistId The playlist id. + * @param {string} userId The user id. + * @param {UpdatePlaylistUserDto} updatePlaylistUserDto The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistUserDto. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updatePlaylistUser: async (playlistId: string, userId: string, updatePlaylistUserDto: UpdatePlaylistUserDto, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'playlistId' is not null or undefined + assertParamExists('updatePlaylistUser', 'playlistId', playlistId) + // verify required parameter 'userId' is not null or undefined + assertParamExists('updatePlaylistUser', 'userId', userId) + // verify required parameter 'updatePlaylistUserDto' is not null or undefined + assertParamExists('updatePlaylistUser', 'updatePlaylistUserDto', updatePlaylistUserDto) + const localVarPath = `/Playlists/{playlistId}/Users/{userId}` + .replace(`{${"playlistId"}}`, encodeURIComponent(String(playlistId))) + .replace(`{${"userId"}}`, encodeURIComponent(String(userId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication CustomAuthentication required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(updatePlaylistUserDto, localVarRequestOptions, configuration) + return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, @@ -324,8 +541,8 @@ export const PlaylistsApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async addToPlaylist(playlistId: string, ids?: Array, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.addToPlaylist(playlistId, ids, userId, options); + async addItemToPlaylist(playlistId: string, ids?: Array, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.addItemToPlaylist(playlistId, ids, userId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -334,12 +551,12 @@ export const PlaylistsApiFp = function(configuration?: Configuration) { * @param {string} [name] The playlist name. * @param {Array} [ids] The item ids. * @param {string} [userId] The user id. - * @param {string} [mediaType] The media type. + * @param {MediaType} [mediaType] The media type. * @param {CreatePlaylistDto} [createPlaylistDto] The create playlist payload. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async createPlaylist(name?: string, ids?: Array, userId?: string, mediaType?: string, createPlaylistDto?: CreatePlaylistDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async createPlaylist(name?: string, ids?: Array, userId?: string, mediaType?: MediaType, createPlaylistDto?: CreatePlaylistDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createPlaylist(name, ids, userId, mediaType, createPlaylistDto, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -347,7 +564,7 @@ export const PlaylistsApiFp = function(configuration?: Configuration) { * * @summary Gets the original items of a playlist. * @param {string} playlistId The playlist id. - * @param {string} userId User id. + * @param {string} [userId] User id. * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results. * @param {number} [limit] Optional. The maximum number of records to return. * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. @@ -358,10 +575,33 @@ export const PlaylistsApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getPlaylistItems(playlistId: string, userId: string, startIndex?: number, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getPlaylistItems(playlistId: string, userId?: string, startIndex?: number, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getPlaylistItems(playlistId, userId, startIndex, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * + * @summary Get a playlist user. + * @param {string} playlistId The playlist id. + * @param {string} userId The user id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getPlaylistUser(playlistId: string, userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPlaylistUser(playlistId, userId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Get a playlist\'s users. + * @param {string} playlistId The playlist id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getPlaylistUsers(playlistId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getPlaylistUsers(playlistId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, /** * * @summary Moves a playlist item. @@ -383,8 +623,45 @@ export const PlaylistsApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async removeFromPlaylist(playlistId: string, entryIds?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.removeFromPlaylist(playlistId, entryIds, options); + async removeItemFromPlaylist(playlistId: string, entryIds?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.removeItemFromPlaylist(playlistId, entryIds, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Remove a user from a playlist\'s users. + * @param {string} playlistId The playlist id. + * @param {string} userId The user id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async removeUserFromPlaylist(playlistId: string, userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.removeUserFromPlaylist(playlistId, userId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Updates a playlist. + * @param {string} playlistId The playlist id. + * @param {UpdatePlaylistDto} updatePlaylistDto The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistDto id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async updatePlaylist(playlistId: string, updatePlaylistDto: UpdatePlaylistDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updatePlaylist(playlistId, updatePlaylistDto, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Modify a user of a playlist\'s users. + * @param {string} playlistId The playlist id. + * @param {string} userId The user id. + * @param {UpdatePlaylistUserDto} updatePlaylistUserDto The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistUserDto. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async updatePlaylistUser(playlistId: string, userId: string, updatePlaylistUserDto: UpdatePlaylistUserDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updatePlaylistUser(playlistId, userId, updatePlaylistUserDto, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, } @@ -406,8 +683,8 @@ export const PlaylistsApiFactory = function (configuration?: Configuration, base * @param {*} [options] Override http request option. * @throws {RequiredError} */ - addToPlaylist(playlistId: string, ids?: Array, userId?: string, options?: any): AxiosPromise { - return localVarFp.addToPlaylist(playlistId, ids, userId, options).then((request) => request(axios, basePath)); + addItemToPlaylist(playlistId: string, ids?: Array, userId?: string, options?: any): AxiosPromise { + return localVarFp.addItemToPlaylist(playlistId, ids, userId, options).then((request) => request(axios, basePath)); }, /** * For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. Query parameters are obsolete. @@ -415,19 +692,19 @@ export const PlaylistsApiFactory = function (configuration?: Configuration, base * @param {string} [name] The playlist name. * @param {Array} [ids] The item ids. * @param {string} [userId] The user id. - * @param {string} [mediaType] The media type. + * @param {MediaType} [mediaType] The media type. * @param {CreatePlaylistDto} [createPlaylistDto] The create playlist payload. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - createPlaylist(name?: string, ids?: Array, userId?: string, mediaType?: string, createPlaylistDto?: CreatePlaylistDto, options?: any): AxiosPromise { + createPlaylist(name?: string, ids?: Array, userId?: string, mediaType?: MediaType, createPlaylistDto?: CreatePlaylistDto, options?: any): AxiosPromise { return localVarFp.createPlaylist(name, ids, userId, mediaType, createPlaylistDto, options).then((request) => request(axios, basePath)); }, /** * * @summary Gets the original items of a playlist. * @param {string} playlistId The playlist id. - * @param {string} userId User id. + * @param {string} [userId] User id. * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results. * @param {number} [limit] Optional. The maximum number of records to return. * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. @@ -438,9 +715,30 @@ export const PlaylistsApiFactory = function (configuration?: Configuration, base * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getPlaylistItems(playlistId: string, userId: string, startIndex?: number, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options?: any): AxiosPromise { + getPlaylistItems(playlistId: string, userId?: string, startIndex?: number, limit?: number, fields?: Array, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, options?: any): AxiosPromise { return localVarFp.getPlaylistItems(playlistId, userId, startIndex, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options).then((request) => request(axios, basePath)); }, + /** + * + * @summary Get a playlist user. + * @param {string} playlistId The playlist id. + * @param {string} userId The user id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getPlaylistUser(playlistId: string, userId: string, options?: any): AxiosPromise { + return localVarFp.getPlaylistUser(playlistId, userId, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Get a playlist\'s users. + * @param {string} playlistId The playlist id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getPlaylistUsers(playlistId: string, options?: any): AxiosPromise> { + return localVarFp.getPlaylistUsers(playlistId, options).then((request) => request(axios, basePath)); + }, /** * * @summary Moves a playlist item. @@ -461,36 +759,70 @@ export const PlaylistsApiFactory = function (configuration?: Configuration, base * @param {*} [options] Override http request option. * @throws {RequiredError} */ - removeFromPlaylist(playlistId: string, entryIds?: Array, options?: any): AxiosPromise { - return localVarFp.removeFromPlaylist(playlistId, entryIds, options).then((request) => request(axios, basePath)); + removeItemFromPlaylist(playlistId: string, entryIds?: Array, options?: any): AxiosPromise { + return localVarFp.removeItemFromPlaylist(playlistId, entryIds, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Remove a user from a playlist\'s users. + * @param {string} playlistId The playlist id. + * @param {string} userId The user id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + removeUserFromPlaylist(playlistId: string, userId: string, options?: any): AxiosPromise { + return localVarFp.removeUserFromPlaylist(playlistId, userId, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Updates a playlist. + * @param {string} playlistId The playlist id. + * @param {UpdatePlaylistDto} updatePlaylistDto The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistDto id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updatePlaylist(playlistId: string, updatePlaylistDto: UpdatePlaylistDto, options?: any): AxiosPromise { + return localVarFp.updatePlaylist(playlistId, updatePlaylistDto, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Modify a user of a playlist\'s users. + * @param {string} playlistId The playlist id. + * @param {string} userId The user id. + * @param {UpdatePlaylistUserDto} updatePlaylistUserDto The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistUserDto. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updatePlaylistUser(playlistId: string, userId: string, updatePlaylistUserDto: UpdatePlaylistUserDto, options?: any): AxiosPromise { + return localVarFp.updatePlaylistUser(playlistId, userId, updatePlaylistUserDto, options).then((request) => request(axios, basePath)); }, }; }; /** - * Request parameters for addToPlaylist operation in PlaylistsApi. + * Request parameters for addItemToPlaylist operation in PlaylistsApi. * @export - * @interface PlaylistsApiAddToPlaylistRequest + * @interface PlaylistsApiAddItemToPlaylistRequest */ -export interface PlaylistsApiAddToPlaylistRequest { +export interface PlaylistsApiAddItemToPlaylistRequest { /** * The playlist id. * @type {string} - * @memberof PlaylistsApiAddToPlaylist + * @memberof PlaylistsApiAddItemToPlaylist */ readonly playlistId: string /** * Item id, comma delimited. * @type {Array} - * @memberof PlaylistsApiAddToPlaylist + * @memberof PlaylistsApiAddItemToPlaylist */ readonly ids?: Array /** * The userId. * @type {string} - * @memberof PlaylistsApiAddToPlaylist + * @memberof PlaylistsApiAddItemToPlaylist */ readonly userId?: string } @@ -524,10 +856,10 @@ export interface PlaylistsApiCreatePlaylistRequest { /** * The media type. - * @type {string} + * @type {MediaType} * @memberof PlaylistsApiCreatePlaylist */ - readonly mediaType?: string + readonly mediaType?: MediaType /** * The create playlist payload. @@ -555,7 +887,7 @@ export interface PlaylistsApiGetPlaylistItemsRequest { * @type {string} * @memberof PlaylistsApiGetPlaylistItems */ - readonly userId: string + readonly userId?: string /** * Optional. The record index to start at. All items with a lower index will be dropped from the results. @@ -607,6 +939,41 @@ export interface PlaylistsApiGetPlaylistItemsRequest { readonly enableImageTypes?: Array } +/** + * Request parameters for getPlaylistUser operation in PlaylistsApi. + * @export + * @interface PlaylistsApiGetPlaylistUserRequest + */ +export interface PlaylistsApiGetPlaylistUserRequest { + /** + * The playlist id. + * @type {string} + * @memberof PlaylistsApiGetPlaylistUser + */ + readonly playlistId: string + + /** + * The user id. + * @type {string} + * @memberof PlaylistsApiGetPlaylistUser + */ + readonly userId: string +} + +/** + * Request parameters for getPlaylistUsers operation in PlaylistsApi. + * @export + * @interface PlaylistsApiGetPlaylistUsersRequest + */ +export interface PlaylistsApiGetPlaylistUsersRequest { + /** + * The playlist id. + * @type {string} + * @memberof PlaylistsApiGetPlaylistUsers + */ + readonly playlistId: string +} + /** * Request parameters for moveItem operation in PlaylistsApi. * @export @@ -636,26 +1003,96 @@ export interface PlaylistsApiMoveItemRequest { } /** - * Request parameters for removeFromPlaylist operation in PlaylistsApi. + * Request parameters for removeItemFromPlaylist operation in PlaylistsApi. * @export - * @interface PlaylistsApiRemoveFromPlaylistRequest + * @interface PlaylistsApiRemoveItemFromPlaylistRequest */ -export interface PlaylistsApiRemoveFromPlaylistRequest { +export interface PlaylistsApiRemoveItemFromPlaylistRequest { /** * The playlist id. * @type {string} - * @memberof PlaylistsApiRemoveFromPlaylist + * @memberof PlaylistsApiRemoveItemFromPlaylist */ readonly playlistId: string /** * The item ids, comma delimited. * @type {Array} - * @memberof PlaylistsApiRemoveFromPlaylist + * @memberof PlaylistsApiRemoveItemFromPlaylist */ readonly entryIds?: Array } +/** + * Request parameters for removeUserFromPlaylist operation in PlaylistsApi. + * @export + * @interface PlaylistsApiRemoveUserFromPlaylistRequest + */ +export interface PlaylistsApiRemoveUserFromPlaylistRequest { + /** + * The playlist id. + * @type {string} + * @memberof PlaylistsApiRemoveUserFromPlaylist + */ + readonly playlistId: string + + /** + * The user id. + * @type {string} + * @memberof PlaylistsApiRemoveUserFromPlaylist + */ + readonly userId: string +} + +/** + * Request parameters for updatePlaylist operation in PlaylistsApi. + * @export + * @interface PlaylistsApiUpdatePlaylistRequest + */ +export interface PlaylistsApiUpdatePlaylistRequest { + /** + * The playlist id. + * @type {string} + * @memberof PlaylistsApiUpdatePlaylist + */ + readonly playlistId: string + + /** + * The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistDto id. + * @type {UpdatePlaylistDto} + * @memberof PlaylistsApiUpdatePlaylist + */ + readonly updatePlaylistDto: UpdatePlaylistDto +} + +/** + * Request parameters for updatePlaylistUser operation in PlaylistsApi. + * @export + * @interface PlaylistsApiUpdatePlaylistUserRequest + */ +export interface PlaylistsApiUpdatePlaylistUserRequest { + /** + * The playlist id. + * @type {string} + * @memberof PlaylistsApiUpdatePlaylistUser + */ + readonly playlistId: string + + /** + * The user id. + * @type {string} + * @memberof PlaylistsApiUpdatePlaylistUser + */ + readonly userId: string + + /** + * The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistUserDto. + * @type {UpdatePlaylistUserDto} + * @memberof PlaylistsApiUpdatePlaylistUser + */ + readonly updatePlaylistUserDto: UpdatePlaylistUserDto +} + /** * PlaylistsApi - object-oriented interface * @export @@ -666,13 +1103,13 @@ export class PlaylistsApi extends BaseAPI { /** * * @summary Adds items to a playlist. - * @param {PlaylistsApiAddToPlaylistRequest} requestParameters Request parameters. + * @param {PlaylistsApiAddItemToPlaylistRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PlaylistsApi */ - public addToPlaylist(requestParameters: PlaylistsApiAddToPlaylistRequest, options?: AxiosRequestConfig) { - return PlaylistsApiFp(this.configuration).addToPlaylist(requestParameters.playlistId, requestParameters.ids, requestParameters.userId, options).then((request) => request(this.axios, this.basePath)); + public addItemToPlaylist(requestParameters: PlaylistsApiAddItemToPlaylistRequest, options?: AxiosRequestConfig) { + return PlaylistsApiFp(this.configuration).addItemToPlaylist(requestParameters.playlistId, requestParameters.ids, requestParameters.userId, options).then((request) => request(this.axios, this.basePath)); } /** @@ -699,6 +1136,30 @@ export class PlaylistsApi extends BaseAPI { return PlaylistsApiFp(this.configuration).getPlaylistItems(requestParameters.playlistId, requestParameters.userId, requestParameters.startIndex, requestParameters.limit, requestParameters.fields, requestParameters.enableImages, requestParameters.enableUserData, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, options).then((request) => request(this.axios, this.basePath)); } + /** + * + * @summary Get a playlist user. + * @param {PlaylistsApiGetPlaylistUserRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PlaylistsApi + */ + public getPlaylistUser(requestParameters: PlaylistsApiGetPlaylistUserRequest, options?: AxiosRequestConfig) { + return PlaylistsApiFp(this.configuration).getPlaylistUser(requestParameters.playlistId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Get a playlist\'s users. + * @param {PlaylistsApiGetPlaylistUsersRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PlaylistsApi + */ + public getPlaylistUsers(requestParameters: PlaylistsApiGetPlaylistUsersRequest, options?: AxiosRequestConfig) { + return PlaylistsApiFp(this.configuration).getPlaylistUsers(requestParameters.playlistId, options).then((request) => request(this.axios, this.basePath)); + } + /** * * @summary Moves a playlist item. @@ -714,12 +1175,48 @@ export class PlaylistsApi extends BaseAPI { /** * * @summary Removes items from a playlist. - * @param {PlaylistsApiRemoveFromPlaylistRequest} requestParameters Request parameters. + * @param {PlaylistsApiRemoveItemFromPlaylistRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PlaylistsApi */ - public removeFromPlaylist(requestParameters: PlaylistsApiRemoveFromPlaylistRequest, options?: AxiosRequestConfig) { - return PlaylistsApiFp(this.configuration).removeFromPlaylist(requestParameters.playlistId, requestParameters.entryIds, options).then((request) => request(this.axios, this.basePath)); + public removeItemFromPlaylist(requestParameters: PlaylistsApiRemoveItemFromPlaylistRequest, options?: AxiosRequestConfig) { + return PlaylistsApiFp(this.configuration).removeItemFromPlaylist(requestParameters.playlistId, requestParameters.entryIds, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Remove a user from a playlist\'s users. + * @param {PlaylistsApiRemoveUserFromPlaylistRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PlaylistsApi + */ + public removeUserFromPlaylist(requestParameters: PlaylistsApiRemoveUserFromPlaylistRequest, options?: AxiosRequestConfig) { + return PlaylistsApiFp(this.configuration).removeUserFromPlaylist(requestParameters.playlistId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Updates a playlist. + * @param {PlaylistsApiUpdatePlaylistRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PlaylistsApi + */ + public updatePlaylist(requestParameters: PlaylistsApiUpdatePlaylistRequest, options?: AxiosRequestConfig) { + return PlaylistsApiFp(this.configuration).updatePlaylist(requestParameters.playlistId, requestParameters.updatePlaylistDto, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Modify a user of a playlist\'s users. + * @param {PlaylistsApiUpdatePlaylistUserRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PlaylistsApi + */ + public updatePlaylistUser(requestParameters: PlaylistsApiUpdatePlaylistUserRequest, options?: AxiosRequestConfig) { + return PlaylistsApiFp(this.configuration).updatePlaylistUser(requestParameters.playlistId, requestParameters.userId, requestParameters.updatePlaylistUserDto, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/generated-client/api/playstate-api.ts b/src/generated-client/api/playstate-api.ts index 7862a018..6434d02f 100644 --- a/src/generated-client/api/playstate-api.ts +++ b/src/generated-client/api/playstate-api.ts @@ -28,6 +28,8 @@ import { PlaybackStartInfo } from '../models'; // @ts-ignore import { PlaybackStopInfo } from '../models'; // @ts-ignore +import { ProblemDetails } from '../models'; +// @ts-ignore import { RepeatMode } from '../models'; // @ts-ignore import { UserItemDataDto } from '../models'; @@ -40,19 +42,16 @@ export const PlaystateApiAxiosParamCreator = function (configuration?: Configura /** * * @summary Marks an item as played for user. - * @param {string} userId User id. * @param {string} itemId Item id. + * @param {string} [userId] User id. * @param {string} [datePlayed] Optional. The date the item was played. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - markPlayedItem: async (userId: string, itemId: string, datePlayed?: string, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('markPlayedItem', 'userId', userId) + markPlayedItem: async (itemId: string, userId?: string, datePlayed?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'itemId' is not null or undefined assertParamExists('markPlayedItem', 'itemId', itemId) - const localVarPath = `/Users/{userId}/PlayedItems/{itemId}` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))) + const localVarPath = `/UserPlayedItems/{itemId}` .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -68,6 +67,10 @@ export const PlaystateApiAxiosParamCreator = function (configuration?: Configura // authentication CustomAuthentication required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (userId !== undefined) { + localVarQueryParameter['userId'] = userId; + } + if (datePlayed !== undefined) { localVarQueryParameter['datePlayed'] = (datePlayed as any instanceof Date) ? (datePlayed as any).toISOString() : @@ -88,18 +91,15 @@ export const PlaystateApiAxiosParamCreator = function (configuration?: Configura /** * * @summary Marks an item as unplayed for user. - * @param {string} userId User id. * @param {string} itemId Item id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - markUnplayedItem: async (userId: string, itemId: string, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('markUnplayedItem', 'userId', userId) + markUnplayedItem: async (itemId: string, userId?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'itemId' is not null or undefined assertParamExists('markUnplayedItem', 'itemId', itemId) - const localVarPath = `/Users/{userId}/PlayedItems/{itemId}` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))) + const localVarPath = `/UserPlayedItems/{itemId}` .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -115,6 +115,10 @@ export const PlaystateApiAxiosParamCreator = function (configuration?: Configura // authentication CustomAuthentication required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (userId !== undefined) { + localVarQueryParameter['userId'] = userId; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -128,8 +132,7 @@ export const PlaystateApiAxiosParamCreator = function (configuration?: Configura }, /** * - * @summary Reports a user\'s playback progress. - * @param {string} userId User id. + * @summary Reports a session\'s playback progress. * @param {string} itemId Item id. * @param {string} [mediaSourceId] The id of the MediaSource. * @param {number} [positionTicks] Optional. The current position, in ticks. 1 tick = 10000 ms. @@ -145,13 +148,10 @@ export const PlaystateApiAxiosParamCreator = function (configuration?: Configura * @param {*} [options] Override http request option. * @throws {RequiredError} */ - onPlaybackProgress: async (userId: string, itemId: string, mediaSourceId?: string, positionTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, volumeLevel?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, repeatMode?: RepeatMode, isPaused?: boolean, isMuted?: boolean, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('onPlaybackProgress', 'userId', userId) + onPlaybackProgress: async (itemId: string, mediaSourceId?: string, positionTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, volumeLevel?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, repeatMode?: RepeatMode, isPaused?: boolean, isMuted?: boolean, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'itemId' is not null or undefined assertParamExists('onPlaybackProgress', 'itemId', itemId) - const localVarPath = `/Users/{userId}/PlayingItems/{itemId}/Progress` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))) + const localVarPath = `/PlayingItems/{itemId}/Progress` .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -224,8 +224,7 @@ export const PlaystateApiAxiosParamCreator = function (configuration?: Configura }, /** * - * @summary Reports that a user has begun playing an item. - * @param {string} userId User id. + * @summary Reports that a session has begun playing an item. * @param {string} itemId Item id. * @param {string} [mediaSourceId] The id of the MediaSource. * @param {number} [audioStreamIndex] The audio stream index. @@ -237,13 +236,10 @@ export const PlaystateApiAxiosParamCreator = function (configuration?: Configura * @param {*} [options] Override http request option. * @throws {RequiredError} */ - onPlaybackStart: async (userId: string, itemId: string, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, canSeek?: boolean, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('onPlaybackStart', 'userId', userId) + onPlaybackStart: async (itemId: string, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, canSeek?: boolean, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'itemId' is not null or undefined assertParamExists('onPlaybackStart', 'itemId', itemId) - const localVarPath = `/Users/{userId}/PlayingItems/{itemId}` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))) + const localVarPath = `/PlayingItems/{itemId}` .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -300,8 +296,7 @@ export const PlaystateApiAxiosParamCreator = function (configuration?: Configura }, /** * - * @summary Reports that a user has stopped playing an item. - * @param {string} userId User id. + * @summary Reports that a session has stopped playing an item. * @param {string} itemId Item id. * @param {string} [mediaSourceId] The id of the MediaSource. * @param {string} [nextMediaType] The next media type that will play. @@ -311,13 +306,10 @@ export const PlaystateApiAxiosParamCreator = function (configuration?: Configura * @param {*} [options] Override http request option. * @throws {RequiredError} */ - onPlaybackStopped: async (userId: string, itemId: string, mediaSourceId?: string, nextMediaType?: string, positionTicks?: number, liveStreamId?: string, playSessionId?: string, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('onPlaybackStopped', 'userId', userId) + onPlaybackStopped: async (itemId: string, mediaSourceId?: string, nextMediaType?: string, positionTicks?: number, liveStreamId?: string, playSessionId?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'itemId' is not null or undefined assertParamExists('onPlaybackStopped', 'itemId', itemId) - const localVarPath = `/Users/{userId}/PlayingItems/{itemId}` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))) + const localVarPath = `/PlayingItems/{itemId}` .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -528,32 +520,31 @@ export const PlaystateApiFp = function(configuration?: Configuration) { /** * * @summary Marks an item as played for user. - * @param {string} userId User id. * @param {string} itemId Item id. + * @param {string} [userId] User id. * @param {string} [datePlayed] Optional. The date the item was played. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async markPlayedItem(userId: string, itemId: string, datePlayed?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.markPlayedItem(userId, itemId, datePlayed, options); + async markPlayedItem(itemId: string, userId?: string, datePlayed?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.markPlayedItem(itemId, userId, datePlayed, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * * @summary Marks an item as unplayed for user. - * @param {string} userId User id. * @param {string} itemId Item id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async markUnplayedItem(userId: string, itemId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.markUnplayedItem(userId, itemId, options); + async markUnplayedItem(itemId: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.markUnplayedItem(itemId, userId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * - * @summary Reports a user\'s playback progress. - * @param {string} userId User id. + * @summary Reports a session\'s playback progress. * @param {string} itemId Item id. * @param {string} [mediaSourceId] The id of the MediaSource. * @param {number} [positionTicks] Optional. The current position, in ticks. 1 tick = 10000 ms. @@ -569,14 +560,13 @@ export const PlaystateApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async onPlaybackProgress(userId: string, itemId: string, mediaSourceId?: string, positionTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, volumeLevel?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, repeatMode?: RepeatMode, isPaused?: boolean, isMuted?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.onPlaybackProgress(userId, itemId, mediaSourceId, positionTicks, audioStreamIndex, subtitleStreamIndex, volumeLevel, playMethod, liveStreamId, playSessionId, repeatMode, isPaused, isMuted, options); + async onPlaybackProgress(itemId: string, mediaSourceId?: string, positionTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, volumeLevel?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, repeatMode?: RepeatMode, isPaused?: boolean, isMuted?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.onPlaybackProgress(itemId, mediaSourceId, positionTicks, audioStreamIndex, subtitleStreamIndex, volumeLevel, playMethod, liveStreamId, playSessionId, repeatMode, isPaused, isMuted, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * - * @summary Reports that a user has begun playing an item. - * @param {string} userId User id. + * @summary Reports that a session has begun playing an item. * @param {string} itemId Item id. * @param {string} [mediaSourceId] The id of the MediaSource. * @param {number} [audioStreamIndex] The audio stream index. @@ -588,14 +578,13 @@ export const PlaystateApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async onPlaybackStart(userId: string, itemId: string, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, canSeek?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.onPlaybackStart(userId, itemId, mediaSourceId, audioStreamIndex, subtitleStreamIndex, playMethod, liveStreamId, playSessionId, canSeek, options); + async onPlaybackStart(itemId: string, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, canSeek?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.onPlaybackStart(itemId, mediaSourceId, audioStreamIndex, subtitleStreamIndex, playMethod, liveStreamId, playSessionId, canSeek, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * - * @summary Reports that a user has stopped playing an item. - * @param {string} userId User id. + * @summary Reports that a session has stopped playing an item. * @param {string} itemId Item id. * @param {string} [mediaSourceId] The id of the MediaSource. * @param {string} [nextMediaType] The next media type that will play. @@ -605,8 +594,8 @@ export const PlaystateApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async onPlaybackStopped(userId: string, itemId: string, mediaSourceId?: string, nextMediaType?: string, positionTicks?: number, liveStreamId?: string, playSessionId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.onPlaybackStopped(userId, itemId, mediaSourceId, nextMediaType, positionTicks, liveStreamId, playSessionId, options); + async onPlaybackStopped(itemId: string, mediaSourceId?: string, nextMediaType?: string, positionTicks?: number, liveStreamId?: string, playSessionId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.onPlaybackStopped(itemId, mediaSourceId, nextMediaType, positionTicks, liveStreamId, playSessionId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -666,30 +655,29 @@ export const PlaystateApiFactory = function (configuration?: Configuration, base /** * * @summary Marks an item as played for user. - * @param {string} userId User id. * @param {string} itemId Item id. + * @param {string} [userId] User id. * @param {string} [datePlayed] Optional. The date the item was played. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - markPlayedItem(userId: string, itemId: string, datePlayed?: string, options?: any): AxiosPromise { - return localVarFp.markPlayedItem(userId, itemId, datePlayed, options).then((request) => request(axios, basePath)); + markPlayedItem(itemId: string, userId?: string, datePlayed?: string, options?: any): AxiosPromise { + return localVarFp.markPlayedItem(itemId, userId, datePlayed, options).then((request) => request(axios, basePath)); }, /** * * @summary Marks an item as unplayed for user. - * @param {string} userId User id. * @param {string} itemId Item id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - markUnplayedItem(userId: string, itemId: string, options?: any): AxiosPromise { - return localVarFp.markUnplayedItem(userId, itemId, options).then((request) => request(axios, basePath)); + markUnplayedItem(itemId: string, userId?: string, options?: any): AxiosPromise { + return localVarFp.markUnplayedItem(itemId, userId, options).then((request) => request(axios, basePath)); }, /** * - * @summary Reports a user\'s playback progress. - * @param {string} userId User id. + * @summary Reports a session\'s playback progress. * @param {string} itemId Item id. * @param {string} [mediaSourceId] The id of the MediaSource. * @param {number} [positionTicks] Optional. The current position, in ticks. 1 tick = 10000 ms. @@ -705,13 +693,12 @@ export const PlaystateApiFactory = function (configuration?: Configuration, base * @param {*} [options] Override http request option. * @throws {RequiredError} */ - onPlaybackProgress(userId: string, itemId: string, mediaSourceId?: string, positionTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, volumeLevel?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, repeatMode?: RepeatMode, isPaused?: boolean, isMuted?: boolean, options?: any): AxiosPromise { - return localVarFp.onPlaybackProgress(userId, itemId, mediaSourceId, positionTicks, audioStreamIndex, subtitleStreamIndex, volumeLevel, playMethod, liveStreamId, playSessionId, repeatMode, isPaused, isMuted, options).then((request) => request(axios, basePath)); + onPlaybackProgress(itemId: string, mediaSourceId?: string, positionTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, volumeLevel?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, repeatMode?: RepeatMode, isPaused?: boolean, isMuted?: boolean, options?: any): AxiosPromise { + return localVarFp.onPlaybackProgress(itemId, mediaSourceId, positionTicks, audioStreamIndex, subtitleStreamIndex, volumeLevel, playMethod, liveStreamId, playSessionId, repeatMode, isPaused, isMuted, options).then((request) => request(axios, basePath)); }, /** * - * @summary Reports that a user has begun playing an item. - * @param {string} userId User id. + * @summary Reports that a session has begun playing an item. * @param {string} itemId Item id. * @param {string} [mediaSourceId] The id of the MediaSource. * @param {number} [audioStreamIndex] The audio stream index. @@ -723,13 +710,12 @@ export const PlaystateApiFactory = function (configuration?: Configuration, base * @param {*} [options] Override http request option. * @throws {RequiredError} */ - onPlaybackStart(userId: string, itemId: string, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, canSeek?: boolean, options?: any): AxiosPromise { - return localVarFp.onPlaybackStart(userId, itemId, mediaSourceId, audioStreamIndex, subtitleStreamIndex, playMethod, liveStreamId, playSessionId, canSeek, options).then((request) => request(axios, basePath)); + onPlaybackStart(itemId: string, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, canSeek?: boolean, options?: any): AxiosPromise { + return localVarFp.onPlaybackStart(itemId, mediaSourceId, audioStreamIndex, subtitleStreamIndex, playMethod, liveStreamId, playSessionId, canSeek, options).then((request) => request(axios, basePath)); }, /** * - * @summary Reports that a user has stopped playing an item. - * @param {string} userId User id. + * @summary Reports that a session has stopped playing an item. * @param {string} itemId Item id. * @param {string} [mediaSourceId] The id of the MediaSource. * @param {string} [nextMediaType] The next media type that will play. @@ -739,8 +725,8 @@ export const PlaystateApiFactory = function (configuration?: Configuration, base * @param {*} [options] Override http request option. * @throws {RequiredError} */ - onPlaybackStopped(userId: string, itemId: string, mediaSourceId?: string, nextMediaType?: string, positionTicks?: number, liveStreamId?: string, playSessionId?: string, options?: any): AxiosPromise { - return localVarFp.onPlaybackStopped(userId, itemId, mediaSourceId, nextMediaType, positionTicks, liveStreamId, playSessionId, options).then((request) => request(axios, basePath)); + onPlaybackStopped(itemId: string, mediaSourceId?: string, nextMediaType?: string, positionTicks?: number, liveStreamId?: string, playSessionId?: string, options?: any): AxiosPromise { + return localVarFp.onPlaybackStopped(itemId, mediaSourceId, nextMediaType, positionTicks, liveStreamId, playSessionId, options).then((request) => request(axios, basePath)); }, /** * @@ -791,13 +777,6 @@ export const PlaystateApiFactory = function (configuration?: Configuration, base * @interface PlaystateApiMarkPlayedItemRequest */ export interface PlaystateApiMarkPlayedItemRequest { - /** - * User id. - * @type {string} - * @memberof PlaystateApiMarkPlayedItem - */ - readonly userId: string - /** * Item id. * @type {string} @@ -805,6 +784,13 @@ export interface PlaystateApiMarkPlayedItemRequest { */ readonly itemId: string + /** + * User id. + * @type {string} + * @memberof PlaystateApiMarkPlayedItem + */ + readonly userId?: string + /** * Optional. The date the item was played. * @type {string} @@ -819,19 +805,19 @@ export interface PlaystateApiMarkPlayedItemRequest { * @interface PlaystateApiMarkUnplayedItemRequest */ export interface PlaystateApiMarkUnplayedItemRequest { - /** - * User id. - * @type {string} - * @memberof PlaystateApiMarkUnplayedItem - */ - readonly userId: string - /** * Item id. * @type {string} * @memberof PlaystateApiMarkUnplayedItem */ readonly itemId: string + + /** + * User id. + * @type {string} + * @memberof PlaystateApiMarkUnplayedItem + */ + readonly userId?: string } /** @@ -840,13 +826,6 @@ export interface PlaystateApiMarkUnplayedItemRequest { * @interface PlaystateApiOnPlaybackProgressRequest */ export interface PlaystateApiOnPlaybackProgressRequest { - /** - * User id. - * @type {string} - * @memberof PlaystateApiOnPlaybackProgress - */ - readonly userId: string - /** * Item id. * @type {string} @@ -938,13 +917,6 @@ export interface PlaystateApiOnPlaybackProgressRequest { * @interface PlaystateApiOnPlaybackStartRequest */ export interface PlaystateApiOnPlaybackStartRequest { - /** - * User id. - * @type {string} - * @memberof PlaystateApiOnPlaybackStart - */ - readonly userId: string - /** * Item id. * @type {string} @@ -1008,13 +980,6 @@ export interface PlaystateApiOnPlaybackStartRequest { * @interface PlaystateApiOnPlaybackStoppedRequest */ export interface PlaystateApiOnPlaybackStoppedRequest { - /** - * User id. - * @type {string} - * @memberof PlaystateApiOnPlaybackStopped - */ - readonly userId: string - /** * Item id. * @type {string} @@ -1130,7 +1095,7 @@ export class PlaystateApi extends BaseAPI { * @memberof PlaystateApi */ public markPlayedItem(requestParameters: PlaystateApiMarkPlayedItemRequest, options?: AxiosRequestConfig) { - return PlaystateApiFp(this.configuration).markPlayedItem(requestParameters.userId, requestParameters.itemId, requestParameters.datePlayed, options).then((request) => request(this.axios, this.basePath)); + return PlaystateApiFp(this.configuration).markPlayedItem(requestParameters.itemId, requestParameters.userId, requestParameters.datePlayed, options).then((request) => request(this.axios, this.basePath)); } /** @@ -1142,43 +1107,43 @@ export class PlaystateApi extends BaseAPI { * @memberof PlaystateApi */ public markUnplayedItem(requestParameters: PlaystateApiMarkUnplayedItemRequest, options?: AxiosRequestConfig) { - return PlaystateApiFp(this.configuration).markUnplayedItem(requestParameters.userId, requestParameters.itemId, options).then((request) => request(this.axios, this.basePath)); + return PlaystateApiFp(this.configuration).markUnplayedItem(requestParameters.itemId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath)); } /** * - * @summary Reports a user\'s playback progress. + * @summary Reports a session\'s playback progress. * @param {PlaystateApiOnPlaybackProgressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PlaystateApi */ public onPlaybackProgress(requestParameters: PlaystateApiOnPlaybackProgressRequest, options?: AxiosRequestConfig) { - return PlaystateApiFp(this.configuration).onPlaybackProgress(requestParameters.userId, requestParameters.itemId, requestParameters.mediaSourceId, requestParameters.positionTicks, requestParameters.audioStreamIndex, requestParameters.subtitleStreamIndex, requestParameters.volumeLevel, requestParameters.playMethod, requestParameters.liveStreamId, requestParameters.playSessionId, requestParameters.repeatMode, requestParameters.isPaused, requestParameters.isMuted, options).then((request) => request(this.axios, this.basePath)); + return PlaystateApiFp(this.configuration).onPlaybackProgress(requestParameters.itemId, requestParameters.mediaSourceId, requestParameters.positionTicks, requestParameters.audioStreamIndex, requestParameters.subtitleStreamIndex, requestParameters.volumeLevel, requestParameters.playMethod, requestParameters.liveStreamId, requestParameters.playSessionId, requestParameters.repeatMode, requestParameters.isPaused, requestParameters.isMuted, options).then((request) => request(this.axios, this.basePath)); } /** * - * @summary Reports that a user has begun playing an item. + * @summary Reports that a session has begun playing an item. * @param {PlaystateApiOnPlaybackStartRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PlaystateApi */ public onPlaybackStart(requestParameters: PlaystateApiOnPlaybackStartRequest, options?: AxiosRequestConfig) { - return PlaystateApiFp(this.configuration).onPlaybackStart(requestParameters.userId, requestParameters.itemId, requestParameters.mediaSourceId, requestParameters.audioStreamIndex, requestParameters.subtitleStreamIndex, requestParameters.playMethod, requestParameters.liveStreamId, requestParameters.playSessionId, requestParameters.canSeek, options).then((request) => request(this.axios, this.basePath)); + return PlaystateApiFp(this.configuration).onPlaybackStart(requestParameters.itemId, requestParameters.mediaSourceId, requestParameters.audioStreamIndex, requestParameters.subtitleStreamIndex, requestParameters.playMethod, requestParameters.liveStreamId, requestParameters.playSessionId, requestParameters.canSeek, options).then((request) => request(this.axios, this.basePath)); } /** * - * @summary Reports that a user has stopped playing an item. + * @summary Reports that a session has stopped playing an item. * @param {PlaystateApiOnPlaybackStoppedRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PlaystateApi */ public onPlaybackStopped(requestParameters: PlaystateApiOnPlaybackStoppedRequest, options?: AxiosRequestConfig) { - return PlaystateApiFp(this.configuration).onPlaybackStopped(requestParameters.userId, requestParameters.itemId, requestParameters.mediaSourceId, requestParameters.nextMediaType, requestParameters.positionTicks, requestParameters.liveStreamId, requestParameters.playSessionId, options).then((request) => request(this.axios, this.basePath)); + return PlaystateApiFp(this.configuration).onPlaybackStopped(requestParameters.itemId, requestParameters.mediaSourceId, requestParameters.nextMediaType, requestParameters.positionTicks, requestParameters.liveStreamId, requestParameters.playSessionId, options).then((request) => request(this.axios, this.basePath)); } /** diff --git a/src/generated-client/api/quick-connect-api.ts b/src/generated-client/api/quick-connect-api.ts index 2b3b91b6..4b611e63 100644 --- a/src/generated-client/api/quick-connect-api.ts +++ b/src/generated-client/api/quick-connect-api.ts @@ -33,12 +33,13 @@ export const QuickConnectApiAxiosParamCreator = function (configuration?: Config * * @summary Authorizes a pending quick connect request. * @param {string} code Quick connect code to authorize. + * @param {string} [userId] The user the authorize. Access to the requested user is required. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - authorize: async (code: string, options: AxiosRequestConfig = {}): Promise => { + authorizeQuickConnect: async (code: string, userId?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'code' is not null or undefined - assertParamExists('authorize', 'code', code) + assertParamExists('authorizeQuickConnect', 'code', code) const localVarPath = `/QuickConnect/Authorize`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -58,6 +59,40 @@ export const QuickConnectApiAxiosParamCreator = function (configuration?: Config localVarQueryParameter['code'] = code; } + if (userId !== undefined) { + localVarQueryParameter['userId'] = userId; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Gets the current quick connect state. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getQuickConnectEnabled: async (options: AxiosRequestConfig = {}): Promise => { + const localVarPath = `/QuickConnect/Enabled`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -76,9 +111,9 @@ export const QuickConnectApiAxiosParamCreator = function (configuration?: Config * @param {*} [options] Override http request option. * @throws {RequiredError} */ - connect: async (secret: string, options: AxiosRequestConfig = {}): Promise => { + getQuickConnectState: async (secret: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'secret' is not null or undefined - assertParamExists('connect', 'secret', secret) + assertParamExists('getQuickConnectState', 'secret', secret) const localVarPath = `/QuickConnect/Connect`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -97,36 +132,6 @@ export const QuickConnectApiAxiosParamCreator = function (configuration?: Config - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * - * @summary Gets the current quick connect state. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getEnabled: async (options: AxiosRequestConfig = {}): Promise => { - const localVarPath = `/QuickConnect/Enabled`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -142,7 +147,7 @@ export const QuickConnectApiAxiosParamCreator = function (configuration?: Config * @param {*} [options] Override http request option. * @throws {RequiredError} */ - initiate: async (options: AxiosRequestConfig = {}): Promise => { + initiateQuickConnect: async (options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/QuickConnect/Initiate`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -151,7 +156,7 @@ export const QuickConnectApiAxiosParamCreator = function (configuration?: Config baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -180,11 +185,22 @@ export const QuickConnectApiFp = function(configuration?: Configuration) { * * @summary Authorizes a pending quick connect request. * @param {string} code Quick connect code to authorize. + * @param {string} [userId] The user the authorize. Access to the requested user is required. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async authorize(code: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.authorize(code, options); + async authorizeQuickConnect(code: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.authorizeQuickConnect(code, userId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Gets the current quick connect state. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getQuickConnectEnabled(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getQuickConnectEnabled(options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -194,18 +210,8 @@ export const QuickConnectApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async connect(secret: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.connect(secret, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * - * @summary Gets the current quick connect state. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getEnabled(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEnabled(options); + async getQuickConnectState(secret: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getQuickConnectState(secret, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -214,8 +220,8 @@ export const QuickConnectApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async initiate(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.initiate(options); + async initiateQuickConnect(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.initiateQuickConnect(options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, } @@ -232,11 +238,21 @@ export const QuickConnectApiFactory = function (configuration?: Configuration, b * * @summary Authorizes a pending quick connect request. * @param {string} code Quick connect code to authorize. + * @param {string} [userId] The user the authorize. Access to the requested user is required. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - authorize(code: string, options?: any): AxiosPromise { - return localVarFp.authorize(code, options).then((request) => request(axios, basePath)); + authorizeQuickConnect(code: string, userId?: string, options?: any): AxiosPromise { + return localVarFp.authorizeQuickConnect(code, userId, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Gets the current quick connect state. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getQuickConnectEnabled(options?: any): AxiosPromise { + return localVarFp.getQuickConnectEnabled(options).then((request) => request(axios, basePath)); }, /** * @@ -245,17 +261,8 @@ export const QuickConnectApiFactory = function (configuration?: Configuration, b * @param {*} [options] Override http request option. * @throws {RequiredError} */ - connect(secret: string, options?: any): AxiosPromise { - return localVarFp.connect(secret, options).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Gets the current quick connect state. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getEnabled(options?: any): AxiosPromise { - return localVarFp.getEnabled(options).then((request) => request(axios, basePath)); + getQuickConnectState(secret: string, options?: any): AxiosPromise { + return localVarFp.getQuickConnectState(secret, options).then((request) => request(axios, basePath)); }, /** * @@ -263,36 +270,43 @@ export const QuickConnectApiFactory = function (configuration?: Configuration, b * @param {*} [options] Override http request option. * @throws {RequiredError} */ - initiate(options?: any): AxiosPromise { - return localVarFp.initiate(options).then((request) => request(axios, basePath)); + initiateQuickConnect(options?: any): AxiosPromise { + return localVarFp.initiateQuickConnect(options).then((request) => request(axios, basePath)); }, }; }; /** - * Request parameters for authorize operation in QuickConnectApi. + * Request parameters for authorizeQuickConnect operation in QuickConnectApi. * @export - * @interface QuickConnectApiAuthorizeRequest + * @interface QuickConnectApiAuthorizeQuickConnectRequest */ -export interface QuickConnectApiAuthorizeRequest { +export interface QuickConnectApiAuthorizeQuickConnectRequest { /** * Quick connect code to authorize. * @type {string} - * @memberof QuickConnectApiAuthorize + * @memberof QuickConnectApiAuthorizeQuickConnect */ readonly code: string + + /** + * The user the authorize. Access to the requested user is required. + * @type {string} + * @memberof QuickConnectApiAuthorizeQuickConnect + */ + readonly userId?: string } /** - * Request parameters for connect operation in QuickConnectApi. + * Request parameters for getQuickConnectState operation in QuickConnectApi. * @export - * @interface QuickConnectApiConnectRequest + * @interface QuickConnectApiGetQuickConnectStateRequest */ -export interface QuickConnectApiConnectRequest { +export interface QuickConnectApiGetQuickConnectStateRequest { /** * Secret previously returned from the Initiate endpoint. * @type {string} - * @memberof QuickConnectApiConnect + * @memberof QuickConnectApiGetQuickConnectState */ readonly secret: string } @@ -307,25 +321,13 @@ export class QuickConnectApi extends BaseAPI { /** * * @summary Authorizes a pending quick connect request. - * @param {QuickConnectApiAuthorizeRequest} requestParameters Request parameters. + * @param {QuickConnectApiAuthorizeQuickConnectRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QuickConnectApi */ - public authorize(requestParameters: QuickConnectApiAuthorizeRequest, options?: AxiosRequestConfig) { - return QuickConnectApiFp(this.configuration).authorize(requestParameters.code, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Attempts to retrieve authentication information. - * @param {QuickConnectApiConnectRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof QuickConnectApi - */ - public connect(requestParameters: QuickConnectApiConnectRequest, options?: AxiosRequestConfig) { - return QuickConnectApiFp(this.configuration).connect(requestParameters.secret, options).then((request) => request(this.axios, this.basePath)); + public authorizeQuickConnect(requestParameters: QuickConnectApiAuthorizeQuickConnectRequest, options?: AxiosRequestConfig) { + return QuickConnectApiFp(this.configuration).authorizeQuickConnect(requestParameters.code, requestParameters.userId, options).then((request) => request(this.axios, this.basePath)); } /** @@ -335,8 +337,20 @@ export class QuickConnectApi extends BaseAPI { * @throws {RequiredError} * @memberof QuickConnectApi */ - public getEnabled(options?: AxiosRequestConfig) { - return QuickConnectApiFp(this.configuration).getEnabled(options).then((request) => request(this.axios, this.basePath)); + public getQuickConnectEnabled(options?: AxiosRequestConfig) { + return QuickConnectApiFp(this.configuration).getQuickConnectEnabled(options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Attempts to retrieve authentication information. + * @param {QuickConnectApiGetQuickConnectStateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof QuickConnectApi + */ + public getQuickConnectState(requestParameters: QuickConnectApiGetQuickConnectStateRequest, options?: AxiosRequestConfig) { + return QuickConnectApiFp(this.configuration).getQuickConnectState(requestParameters.secret, options).then((request) => request(this.axios, this.basePath)); } /** @@ -346,7 +360,7 @@ export class QuickConnectApi extends BaseAPI { * @throws {RequiredError} * @memberof QuickConnectApi */ - public initiate(options?: AxiosRequestConfig) { - return QuickConnectApiFp(this.configuration).initiate(options).then((request) => request(this.axios, this.basePath)); + public initiateQuickConnect(options?: AxiosRequestConfig) { + return QuickConnectApiFp(this.configuration).initiateQuickConnect(options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/generated-client/api/search-api.ts b/src/generated-client/api/search-api.ts index c03ba5d7..b0506c7b 100644 --- a/src/generated-client/api/search-api.ts +++ b/src/generated-client/api/search-api.ts @@ -22,6 +22,8 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr // @ts-ignore import { BaseItemKind } from '../models'; // @ts-ignore +import { MediaType } from '../models'; +// @ts-ignore import { SearchHintResult } from '../models'; /** * SearchApi - axios parameter creator @@ -36,9 +38,9 @@ export const SearchApiAxiosParamCreator = function (configuration?: Configuratio * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results. * @param {number} [limit] Optional. The maximum number of records to return. * @param {string} [userId] Optional. Supply a user id to search within a user\'s library or omit to search all. - * @param {Array} [includeItemTypes] If specified, only results with the specified item types are returned. This allows multiple, comma delimeted. - * @param {Array} [excludeItemTypes] If specified, results with these item types are filtered out. This allows multiple, comma delimeted. - * @param {Array} [mediaTypes] If specified, only results with the specified media types are returned. This allows multiple, comma delimeted. + * @param {Array} [includeItemTypes] If specified, only results with the specified item types are returned. This allows multiple, comma delimited. + * @param {Array} [excludeItemTypes] If specified, results with these item types are filtered out. This allows multiple, comma delimited. + * @param {Array} [mediaTypes] If specified, only results with the specified media types are returned. This allows multiple, comma delimited. * @param {string} [parentId] If specified, only children of the parent are returned. * @param {boolean} [isMovie] Optional filter for movies. * @param {boolean} [isSeries] Optional filter for series. @@ -53,9 +55,9 @@ export const SearchApiAxiosParamCreator = function (configuration?: Configuratio * @param {*} [options] Override http request option. * @throws {RequiredError} */ - get: async (searchTerm: string, startIndex?: number, limit?: number, userId?: string, includeItemTypes?: Array, excludeItemTypes?: Array, mediaTypes?: Array, parentId?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, includePeople?: boolean, includeMedia?: boolean, includeGenres?: boolean, includeStudios?: boolean, includeArtists?: boolean, options: AxiosRequestConfig = {}): Promise => { + getSearchHints: async (searchTerm: string, startIndex?: number, limit?: number, userId?: string, includeItemTypes?: Array, excludeItemTypes?: Array, mediaTypes?: Array, parentId?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, includePeople?: boolean, includeMedia?: boolean, includeGenres?: boolean, includeStudios?: boolean, includeArtists?: boolean, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'searchTerm' is not null or undefined - assertParamExists('get', 'searchTerm', searchTerm) + assertParamExists('getSearchHints', 'searchTerm', searchTerm) const localVarPath = `/Search/Hints`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -171,9 +173,9 @@ export const SearchApiFp = function(configuration?: Configuration) { * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results. * @param {number} [limit] Optional. The maximum number of records to return. * @param {string} [userId] Optional. Supply a user id to search within a user\'s library or omit to search all. - * @param {Array} [includeItemTypes] If specified, only results with the specified item types are returned. This allows multiple, comma delimeted. - * @param {Array} [excludeItemTypes] If specified, results with these item types are filtered out. This allows multiple, comma delimeted. - * @param {Array} [mediaTypes] If specified, only results with the specified media types are returned. This allows multiple, comma delimeted. + * @param {Array} [includeItemTypes] If specified, only results with the specified item types are returned. This allows multiple, comma delimited. + * @param {Array} [excludeItemTypes] If specified, results with these item types are filtered out. This allows multiple, comma delimited. + * @param {Array} [mediaTypes] If specified, only results with the specified media types are returned. This allows multiple, comma delimited. * @param {string} [parentId] If specified, only children of the parent are returned. * @param {boolean} [isMovie] Optional filter for movies. * @param {boolean} [isSeries] Optional filter for series. @@ -188,8 +190,8 @@ export const SearchApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async get(searchTerm: string, startIndex?: number, limit?: number, userId?: string, includeItemTypes?: Array, excludeItemTypes?: Array, mediaTypes?: Array, parentId?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, includePeople?: boolean, includeMedia?: boolean, includeGenres?: boolean, includeStudios?: boolean, includeArtists?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.get(searchTerm, startIndex, limit, userId, includeItemTypes, excludeItemTypes, mediaTypes, parentId, isMovie, isSeries, isNews, isKids, isSports, includePeople, includeMedia, includeGenres, includeStudios, includeArtists, options); + async getSearchHints(searchTerm: string, startIndex?: number, limit?: number, userId?: string, includeItemTypes?: Array, excludeItemTypes?: Array, mediaTypes?: Array, parentId?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, includePeople?: boolean, includeMedia?: boolean, includeGenres?: boolean, includeStudios?: boolean, includeArtists?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSearchHints(searchTerm, startIndex, limit, userId, includeItemTypes, excludeItemTypes, mediaTypes, parentId, isMovie, isSeries, isNews, isKids, isSports, includePeople, includeMedia, includeGenres, includeStudios, includeArtists, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, } @@ -209,9 +211,9 @@ export const SearchApiFactory = function (configuration?: Configuration, basePat * @param {number} [startIndex] Optional. The record index to start at. All items with a lower index will be dropped from the results. * @param {number} [limit] Optional. The maximum number of records to return. * @param {string} [userId] Optional. Supply a user id to search within a user\'s library or omit to search all. - * @param {Array} [includeItemTypes] If specified, only results with the specified item types are returned. This allows multiple, comma delimeted. - * @param {Array} [excludeItemTypes] If specified, results with these item types are filtered out. This allows multiple, comma delimeted. - * @param {Array} [mediaTypes] If specified, only results with the specified media types are returned. This allows multiple, comma delimeted. + * @param {Array} [includeItemTypes] If specified, only results with the specified item types are returned. This allows multiple, comma delimited. + * @param {Array} [excludeItemTypes] If specified, results with these item types are filtered out. This allows multiple, comma delimited. + * @param {Array} [mediaTypes] If specified, only results with the specified media types are returned. This allows multiple, comma delimited. * @param {string} [parentId] If specified, only children of the parent are returned. * @param {boolean} [isMovie] Optional filter for movies. * @param {boolean} [isSeries] Optional filter for series. @@ -226,141 +228,141 @@ export const SearchApiFactory = function (configuration?: Configuration, basePat * @param {*} [options] Override http request option. * @throws {RequiredError} */ - get(searchTerm: string, startIndex?: number, limit?: number, userId?: string, includeItemTypes?: Array, excludeItemTypes?: Array, mediaTypes?: Array, parentId?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, includePeople?: boolean, includeMedia?: boolean, includeGenres?: boolean, includeStudios?: boolean, includeArtists?: boolean, options?: any): AxiosPromise { - return localVarFp.get(searchTerm, startIndex, limit, userId, includeItemTypes, excludeItemTypes, mediaTypes, parentId, isMovie, isSeries, isNews, isKids, isSports, includePeople, includeMedia, includeGenres, includeStudios, includeArtists, options).then((request) => request(axios, basePath)); + getSearchHints(searchTerm: string, startIndex?: number, limit?: number, userId?: string, includeItemTypes?: Array, excludeItemTypes?: Array, mediaTypes?: Array, parentId?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, includePeople?: boolean, includeMedia?: boolean, includeGenres?: boolean, includeStudios?: boolean, includeArtists?: boolean, options?: any): AxiosPromise { + return localVarFp.getSearchHints(searchTerm, startIndex, limit, userId, includeItemTypes, excludeItemTypes, mediaTypes, parentId, isMovie, isSeries, isNews, isKids, isSports, includePeople, includeMedia, includeGenres, includeStudios, includeArtists, options).then((request) => request(axios, basePath)); }, }; }; /** - * Request parameters for get operation in SearchApi. + * Request parameters for getSearchHints operation in SearchApi. * @export - * @interface SearchApiGetRequest + * @interface SearchApiGetSearchHintsRequest */ -export interface SearchApiGetRequest { +export interface SearchApiGetSearchHintsRequest { /** * The search term to filter on. * @type {string} - * @memberof SearchApiGet + * @memberof SearchApiGetSearchHints */ readonly searchTerm: string /** * Optional. The record index to start at. All items with a lower index will be dropped from the results. * @type {number} - * @memberof SearchApiGet + * @memberof SearchApiGetSearchHints */ readonly startIndex?: number /** * Optional. The maximum number of records to return. * @type {number} - * @memberof SearchApiGet + * @memberof SearchApiGetSearchHints */ readonly limit?: number /** * Optional. Supply a user id to search within a user\'s library or omit to search all. * @type {string} - * @memberof SearchApiGet + * @memberof SearchApiGetSearchHints */ readonly userId?: string /** - * If specified, only results with the specified item types are returned. This allows multiple, comma delimeted. + * If specified, only results with the specified item types are returned. This allows multiple, comma delimited. * @type {Array} - * @memberof SearchApiGet + * @memberof SearchApiGetSearchHints */ readonly includeItemTypes?: Array /** - * If specified, results with these item types are filtered out. This allows multiple, comma delimeted. + * If specified, results with these item types are filtered out. This allows multiple, comma delimited. * @type {Array} - * @memberof SearchApiGet + * @memberof SearchApiGetSearchHints */ readonly excludeItemTypes?: Array /** - * If specified, only results with the specified media types are returned. This allows multiple, comma delimeted. - * @type {Array} - * @memberof SearchApiGet + * If specified, only results with the specified media types are returned. This allows multiple, comma delimited. + * @type {Array} + * @memberof SearchApiGetSearchHints */ - readonly mediaTypes?: Array + readonly mediaTypes?: Array /** * If specified, only children of the parent are returned. * @type {string} - * @memberof SearchApiGet + * @memberof SearchApiGetSearchHints */ readonly parentId?: string /** * Optional filter for movies. * @type {boolean} - * @memberof SearchApiGet + * @memberof SearchApiGetSearchHints */ readonly isMovie?: boolean /** * Optional filter for series. * @type {boolean} - * @memberof SearchApiGet + * @memberof SearchApiGetSearchHints */ readonly isSeries?: boolean /** * Optional filter for news. * @type {boolean} - * @memberof SearchApiGet + * @memberof SearchApiGetSearchHints */ readonly isNews?: boolean /** * Optional filter for kids. * @type {boolean} - * @memberof SearchApiGet + * @memberof SearchApiGetSearchHints */ readonly isKids?: boolean /** * Optional filter for sports. * @type {boolean} - * @memberof SearchApiGet + * @memberof SearchApiGetSearchHints */ readonly isSports?: boolean /** * Optional filter whether to include people. * @type {boolean} - * @memberof SearchApiGet + * @memberof SearchApiGetSearchHints */ readonly includePeople?: boolean /** * Optional filter whether to include media. * @type {boolean} - * @memberof SearchApiGet + * @memberof SearchApiGetSearchHints */ readonly includeMedia?: boolean /** * Optional filter whether to include genres. * @type {boolean} - * @memberof SearchApiGet + * @memberof SearchApiGetSearchHints */ readonly includeGenres?: boolean /** * Optional filter whether to include studios. * @type {boolean} - * @memberof SearchApiGet + * @memberof SearchApiGetSearchHints */ readonly includeStudios?: boolean /** * Optional filter whether to include artists. * @type {boolean} - * @memberof SearchApiGet + * @memberof SearchApiGetSearchHints */ readonly includeArtists?: boolean } @@ -375,12 +377,12 @@ export class SearchApi extends BaseAPI { /** * * @summary Gets the search hint result. - * @param {SearchApiGetRequest} requestParameters Request parameters. + * @param {SearchApiGetSearchHintsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SearchApi */ - public get(requestParameters: SearchApiGetRequest, options?: AxiosRequestConfig) { - return SearchApiFp(this.configuration).get(requestParameters.searchTerm, requestParameters.startIndex, requestParameters.limit, requestParameters.userId, requestParameters.includeItemTypes, requestParameters.excludeItemTypes, requestParameters.mediaTypes, requestParameters.parentId, requestParameters.isMovie, requestParameters.isSeries, requestParameters.isNews, requestParameters.isKids, requestParameters.isSports, requestParameters.includePeople, requestParameters.includeMedia, requestParameters.includeGenres, requestParameters.includeStudios, requestParameters.includeArtists, options).then((request) => request(this.axios, this.basePath)); + public getSearchHints(requestParameters: SearchApiGetSearchHintsRequest, options?: AxiosRequestConfig) { + return SearchApiFp(this.configuration).getSearchHints(requestParameters.searchTerm, requestParameters.startIndex, requestParameters.limit, requestParameters.userId, requestParameters.includeItemTypes, requestParameters.excludeItemTypes, requestParameters.mediaTypes, requestParameters.parentId, requestParameters.isMovie, requestParameters.isSeries, requestParameters.isNews, requestParameters.isKids, requestParameters.isSports, requestParameters.includePeople, requestParameters.includeMedia, requestParameters.includeGenres, requestParameters.includeStudios, requestParameters.includeArtists, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/generated-client/api/session-api.ts b/src/generated-client/api/session-api.ts index daeea448..9f8d18eb 100644 --- a/src/generated-client/api/session-api.ts +++ b/src/generated-client/api/session-api.ts @@ -28,6 +28,8 @@ import { GeneralCommand } from '../models'; // @ts-ignore import { GeneralCommandType } from '../models'; // @ts-ignore +import { MediaType } from '../models'; +// @ts-ignore import { MessageCommand } from '../models'; // @ts-ignore import { NameIdPair } from '../models'; @@ -336,15 +338,14 @@ export const SessionApiAxiosParamCreator = function (configuration?: Configurati * * @summary Updates capabilities for a device. * @param {string} [id] The session id. - * @param {Array} [playableMediaTypes] A list of playable media types, comma delimited. Audio, Video, Book, Photo. + * @param {Array} [playableMediaTypes] A list of playable media types, comma delimited. Audio, Video, Book, Photo. * @param {Array} [supportedCommands] A list of supported remote control commands, comma delimited. * @param {boolean} [supportsMediaControl] Determines whether media can be played remotely.. - * @param {boolean} [supportsSync] Determines whether sync is supported. * @param {boolean} [supportsPersistentIdentifier] Determines whether the device supports a unique identifier. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - postCapabilities: async (id?: string, playableMediaTypes?: Array, supportedCommands?: Array, supportsMediaControl?: boolean, supportsSync?: boolean, supportsPersistentIdentifier?: boolean, options: AxiosRequestConfig = {}): Promise => { + postCapabilities: async (id?: string, playableMediaTypes?: Array, supportedCommands?: Array, supportsMediaControl?: boolean, supportsPersistentIdentifier?: boolean, options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/Sessions/Capabilities`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -376,10 +377,6 @@ export const SessionApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['supportsMediaControl'] = supportsMediaControl; } - if (supportsSync !== undefined) { - localVarQueryParameter['supportsSync'] = supportsSync; - } - if (supportsPersistentIdentifier !== undefined) { localVarQueryParameter['supportsPersistentIdentifier'] = supportsPersistentIdentifier; } @@ -868,16 +865,15 @@ export const SessionApiFp = function(configuration?: Configuration) { * * @summary Updates capabilities for a device. * @param {string} [id] The session id. - * @param {Array} [playableMediaTypes] A list of playable media types, comma delimited. Audio, Video, Book, Photo. + * @param {Array} [playableMediaTypes] A list of playable media types, comma delimited. Audio, Video, Book, Photo. * @param {Array} [supportedCommands] A list of supported remote control commands, comma delimited. * @param {boolean} [supportsMediaControl] Determines whether media can be played remotely.. - * @param {boolean} [supportsSync] Determines whether sync is supported. * @param {boolean} [supportsPersistentIdentifier] Determines whether the device supports a unique identifier. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async postCapabilities(id?: string, playableMediaTypes?: Array, supportedCommands?: Array, supportsMediaControl?: boolean, supportsSync?: boolean, supportsPersistentIdentifier?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.postCapabilities(id, playableMediaTypes, supportedCommands, supportsMediaControl, supportsSync, supportsPersistentIdentifier, options); + async postCapabilities(id?: string, playableMediaTypes?: Array, supportedCommands?: Array, supportsMediaControl?: boolean, supportsPersistentIdentifier?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.postCapabilities(id, playableMediaTypes, supportedCommands, supportsMediaControl, supportsPersistentIdentifier, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -1073,16 +1069,15 @@ export const SessionApiFactory = function (configuration?: Configuration, basePa * * @summary Updates capabilities for a device. * @param {string} [id] The session id. - * @param {Array} [playableMediaTypes] A list of playable media types, comma delimited. Audio, Video, Book, Photo. + * @param {Array} [playableMediaTypes] A list of playable media types, comma delimited. Audio, Video, Book, Photo. * @param {Array} [supportedCommands] A list of supported remote control commands, comma delimited. * @param {boolean} [supportsMediaControl] Determines whether media can be played remotely.. - * @param {boolean} [supportsSync] Determines whether sync is supported. * @param {boolean} [supportsPersistentIdentifier] Determines whether the device supports a unique identifier. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - postCapabilities(id?: string, playableMediaTypes?: Array, supportedCommands?: Array, supportsMediaControl?: boolean, supportsSync?: boolean, supportsPersistentIdentifier?: boolean, options?: any): AxiosPromise { - return localVarFp.postCapabilities(id, playableMediaTypes, supportedCommands, supportsMediaControl, supportsSync, supportsPersistentIdentifier, options).then((request) => request(axios, basePath)); + postCapabilities(id?: string, playableMediaTypes?: Array, supportedCommands?: Array, supportsMediaControl?: boolean, supportsPersistentIdentifier?: boolean, options?: any): AxiosPromise { + return localVarFp.postCapabilities(id, playableMediaTypes, supportedCommands, supportsMediaControl, supportsPersistentIdentifier, options).then((request) => request(axios, basePath)); }, /** * @@ -1348,10 +1343,10 @@ export interface SessionApiPostCapabilitiesRequest { /** * A list of playable media types, comma delimited. Audio, Video, Book, Photo. - * @type {Array} + * @type {Array} * @memberof SessionApiPostCapabilities */ - readonly playableMediaTypes?: Array + readonly playableMediaTypes?: Array /** * A list of supported remote control commands, comma delimited. @@ -1367,13 +1362,6 @@ export interface SessionApiPostCapabilitiesRequest { */ readonly supportsMediaControl?: boolean - /** - * Determines whether sync is supported. - * @type {boolean} - * @memberof SessionApiPostCapabilities - */ - readonly supportsSync?: boolean - /** * Determines whether the device supports a unique identifier. * @type {boolean} @@ -1650,7 +1638,7 @@ export class SessionApi extends BaseAPI { * @memberof SessionApi */ public postCapabilities(requestParameters: SessionApiPostCapabilitiesRequest = {}, options?: AxiosRequestConfig) { - return SessionApiFp(this.configuration).postCapabilities(requestParameters.id, requestParameters.playableMediaTypes, requestParameters.supportedCommands, requestParameters.supportsMediaControl, requestParameters.supportsSync, requestParameters.supportsPersistentIdentifier, options).then((request) => request(this.axios, this.basePath)); + return SessionApiFp(this.configuration).postCapabilities(requestParameters.id, requestParameters.playableMediaTypes, requestParameters.supportedCommands, requestParameters.supportsMediaControl, requestParameters.supportsPersistentIdentifier, options).then((request) => request(this.axios, this.basePath)); } /** diff --git a/src/generated-client/api/subtitle-api.ts b/src/generated-client/api/subtitle-api.ts index 9a679d76..71a24d02 100644 --- a/src/generated-client/api/subtitle-api.ts +++ b/src/generated-client/api/subtitle-api.ts @@ -188,15 +188,15 @@ export const SubtitleApiAxiosParamCreator = function (configuration?: Configurat /** * * @summary Gets the remote subtitles. - * @param {string} id The item id. + * @param {string} subtitleId The item id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getRemoteSubtitles: async (id: string, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getRemoteSubtitles', 'id', id) - const localVarPath = `/Providers/Subtitles/Subtitles/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); + getRemoteSubtitles: async (subtitleId: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'subtitleId' is not null or undefined + assertParamExists('getRemoteSubtitles', 'subtitleId', subtitleId) + const localVarPath = `/Providers/Subtitles/Subtitles/{subtitleId}` + .replace(`{${"subtitleId"}}`, encodeURIComponent(String(subtitleId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -597,12 +597,12 @@ export const SubtitleApiFp = function(configuration?: Configuration) { /** * * @summary Gets the remote subtitles. - * @param {string} id The item id. + * @param {string} subtitleId The item id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getRemoteSubtitles(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRemoteSubtitles(id, options); + async getRemoteSubtitles(subtitleId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getRemoteSubtitles(subtitleId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -743,12 +743,12 @@ export const SubtitleApiFactory = function (configuration?: Configuration, baseP /** * * @summary Gets the remote subtitles. - * @param {string} id The item id. + * @param {string} subtitleId The item id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getRemoteSubtitles(id: string, options?: any): AxiosPromise { - return localVarFp.getRemoteSubtitles(id, options).then((request) => request(axios, basePath)); + getRemoteSubtitles(subtitleId: string, options?: any): AxiosPromise { + return localVarFp.getRemoteSubtitles(subtitleId, options).then((request) => request(axios, basePath)); }, /** * @@ -899,7 +899,7 @@ export interface SubtitleApiGetRemoteSubtitlesRequest { * @type {string} * @memberof SubtitleApiGetRemoteSubtitles */ - readonly id: string + readonly subtitleId: string } /** @@ -1238,7 +1238,7 @@ export class SubtitleApi extends BaseAPI { * @memberof SubtitleApi */ public getRemoteSubtitles(requestParameters: SubtitleApiGetRemoteSubtitlesRequest, options?: AxiosRequestConfig) { - return SubtitleApiFp(this.configuration).getRemoteSubtitles(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); + return SubtitleApiFp(this.configuration).getRemoteSubtitles(requestParameters.subtitleId, options).then((request) => request(this.axios, this.basePath)); } /** diff --git a/src/generated-client/api/suggestions-api.ts b/src/generated-client/api/suggestions-api.ts index 01588ceb..fb5cff2b 100644 --- a/src/generated-client/api/suggestions-api.ts +++ b/src/generated-client/api/suggestions-api.ts @@ -23,6 +23,8 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr import { BaseItemDtoQueryResult } from '../models'; // @ts-ignore import { BaseItemKind } from '../models'; +// @ts-ignore +import { MediaType } from '../models'; /** * SuggestionsApi - axios parameter creator * @export @@ -32,8 +34,8 @@ export const SuggestionsApiAxiosParamCreator = function (configuration?: Configu /** * * @summary Gets suggestions. - * @param {string} userId The user id. - * @param {Array} [mediaType] The media types. + * @param {string} [userId] The user id. + * @param {Array} [mediaType] The media types. * @param {Array} [type] The type. * @param {number} [startIndex] Optional. The start index. * @param {number} [limit] Optional. The limit. @@ -41,11 +43,8 @@ export const SuggestionsApiAxiosParamCreator = function (configuration?: Configu * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getSuggestions: async (userId: string, mediaType?: Array, type?: Array, startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('getSuggestions', 'userId', userId) - const localVarPath = `/Users/{userId}/Suggestions` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))); + getSuggestions: async (userId?: string, mediaType?: Array, type?: Array, startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options: AxiosRequestConfig = {}): Promise => { + const localVarPath = `/Items/Suggestions`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -60,6 +59,10 @@ export const SuggestionsApiAxiosParamCreator = function (configuration?: Configu // authentication CustomAuthentication required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (userId !== undefined) { + localVarQueryParameter['userId'] = userId; + } + if (mediaType) { localVarQueryParameter['mediaType'] = mediaType; } @@ -104,8 +107,8 @@ export const SuggestionsApiFp = function(configuration?: Configuration) { /** * * @summary Gets suggestions. - * @param {string} userId The user id. - * @param {Array} [mediaType] The media types. + * @param {string} [userId] The user id. + * @param {Array} [mediaType] The media types. * @param {Array} [type] The type. * @param {number} [startIndex] Optional. The start index. * @param {number} [limit] Optional. The limit. @@ -113,7 +116,7 @@ export const SuggestionsApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getSuggestions(userId: string, mediaType?: Array, type?: Array, startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getSuggestions(userId?: string, mediaType?: Array, type?: Array, startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getSuggestions(userId, mediaType, type, startIndex, limit, enableTotalRecordCount, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -130,8 +133,8 @@ export const SuggestionsApiFactory = function (configuration?: Configuration, ba /** * * @summary Gets suggestions. - * @param {string} userId The user id. - * @param {Array} [mediaType] The media types. + * @param {string} [userId] The user id. + * @param {Array} [mediaType] The media types. * @param {Array} [type] The type. * @param {number} [startIndex] Optional. The start index. * @param {number} [limit] Optional. The limit. @@ -139,7 +142,7 @@ export const SuggestionsApiFactory = function (configuration?: Configuration, ba * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getSuggestions(userId: string, mediaType?: Array, type?: Array, startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options?: any): AxiosPromise { + getSuggestions(userId?: string, mediaType?: Array, type?: Array, startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options?: any): AxiosPromise { return localVarFp.getSuggestions(userId, mediaType, type, startIndex, limit, enableTotalRecordCount, options).then((request) => request(axios, basePath)); }, }; @@ -156,14 +159,14 @@ export interface SuggestionsApiGetSuggestionsRequest { * @type {string} * @memberof SuggestionsApiGetSuggestions */ - readonly userId: string + readonly userId?: string /** * The media types. - * @type {Array} + * @type {Array} * @memberof SuggestionsApiGetSuggestions */ - readonly mediaType?: Array + readonly mediaType?: Array /** * The type. @@ -209,7 +212,7 @@ export class SuggestionsApi extends BaseAPI { * @throws {RequiredError} * @memberof SuggestionsApi */ - public getSuggestions(requestParameters: SuggestionsApiGetSuggestionsRequest, options?: AxiosRequestConfig) { + public getSuggestions(requestParameters: SuggestionsApiGetSuggestionsRequest = {}, options?: AxiosRequestConfig) { return SuggestionsApiFp(this.configuration).getSuggestions(requestParameters.userId, requestParameters.mediaType, requestParameters.type, requestParameters.startIndex, requestParameters.limit, requestParameters.enableTotalRecordCount, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/generated-client/api/system-api.ts b/src/generated-client/api/system-api.ts index fa6efe90..8233f354 100644 --- a/src/generated-client/api/system-api.ts +++ b/src/generated-client/api/system-api.ts @@ -24,6 +24,8 @@ import { EndPointInfo } from '../models'; // @ts-ignore import { LogFile } from '../models'; // @ts-ignore +import { ProblemDetails } from '../models'; +// @ts-ignore import { PublicSystemInfo } from '../models'; // @ts-ignore import { SystemInfo } from '../models'; diff --git a/src/generated-client/api/trailers-api.ts b/src/generated-client/api/trailers-api.ts index a48389d1..b740c9e8 100644 --- a/src/generated-client/api/trailers-api.ts +++ b/src/generated-client/api/trailers-api.ts @@ -30,8 +30,12 @@ import { ItemFields } from '../models'; // @ts-ignore import { ItemFilter } from '../models'; // @ts-ignore +import { ItemSortBy } from '../models'; +// @ts-ignore import { LocationType } from '../models'; // @ts-ignore +import { MediaType } from '../models'; +// @ts-ignore import { SeriesStatus } from '../models'; // @ts-ignore import { SortOrder } from '../models'; @@ -46,7 +50,7 @@ export const TrailersApiAxiosParamCreator = function (configuration?: Configurat /** * * @summary Finds movies and trailers similar to a given trailer. - * @param {string} [userId] The user id. + * @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key. * @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc). * @param {boolean} [hasThemeSong] Optional filter by items with theme songs. * @param {boolean} [hasThemeVideo] Optional filter by items with theme videos. @@ -69,9 +73,9 @@ export const TrailersApiAxiosParamCreator = function (configuration?: Configurat * @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO. * @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO. * @param {boolean} [hasOverview] Optional filter by items that have an overview or not. - * @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not. - * @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not. - * @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not. + * @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not. + * @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not. + * @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not. * @param {boolean} [isMovie] Optional filter for live tv movies. * @param {boolean} [isSeries] Optional filter for live tv series. * @param {boolean} [isNews] Optional filter for live tv news. @@ -82,15 +86,15 @@ export const TrailersApiAxiosParamCreator = function (configuration?: Configurat * @param {number} [limit] Optional. The maximum number of records to return. * @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false. * @param {string} [searchTerm] Optional. Filter based on a search term. - * @param {Array} [sortOrder] Sort Order - Ascending,Descending. + * @param {Array} [sortOrder] Sort Order - Ascending, Descending. * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root. * @param {Array} [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. * @param {Array} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. * @param {Array} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes. * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not. - * @param {Array} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited. + * @param {Array} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited. * @param {Array} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited. - * @param {Array} [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. + * @param {Array} [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. * @param {boolean} [isPlayed] Optional filter by items that are played, or not. * @param {Array} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. * @param {Array} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. @@ -133,7 +137,7 @@ export const TrailersApiAxiosParamCreator = function (configuration?: Configurat * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getTrailers: async (userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array, excludeLocationTypes?: Array, 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, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array, parentId?: string, fields?: Array, excludeItemTypes?: Array, filters?: Array, isFavorite?: boolean, mediaTypes?: Array, imageTypes?: Array, sortBy?: Array, isPlayed?: boolean, genres?: Array, officialRatings?: Array, tags?: Array, years?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, person?: string, personIds?: Array, personTypes?: Array, studios?: Array, artists?: Array, excludeArtistIds?: Array, artistIds?: Array, albumArtistIds?: Array, contributingArtistIds?: Array, albums?: Array, albumIds?: Array, ids?: Array, videoTypes?: Array, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array, genreIds?: Array, enableTotalRecordCount?: boolean, enableImages?: boolean, options: AxiosRequestConfig = {}): Promise => { + getTrailers: async (userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array, excludeLocationTypes?: Array, 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, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array, parentId?: string, fields?: Array, excludeItemTypes?: Array, filters?: Array, isFavorite?: boolean, mediaTypes?: Array, imageTypes?: Array, sortBy?: Array, isPlayed?: boolean, genres?: Array, officialRatings?: Array, tags?: Array, years?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, person?: string, personIds?: Array, personTypes?: Array, studios?: Array, artists?: Array, excludeArtistIds?: Array, artistIds?: Array, albumArtistIds?: Array, contributingArtistIds?: Array, albums?: Array, albumIds?: Array, ids?: Array, videoTypes?: Array, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array, genreIds?: Array, enableTotalRecordCount?: boolean, enableImages?: boolean, options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/Trailers`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -517,7 +521,7 @@ export const TrailersApiFp = function(configuration?: Configuration) { /** * * @summary Finds movies and trailers similar to a given trailer. - * @param {string} [userId] The user id. + * @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key. * @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc). * @param {boolean} [hasThemeSong] Optional filter by items with theme songs. * @param {boolean} [hasThemeVideo] Optional filter by items with theme videos. @@ -540,9 +544,9 @@ export const TrailersApiFp = function(configuration?: Configuration) { * @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO. * @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO. * @param {boolean} [hasOverview] Optional filter by items that have an overview or not. - * @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not. - * @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not. - * @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not. + * @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not. + * @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not. + * @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not. * @param {boolean} [isMovie] Optional filter for live tv movies. * @param {boolean} [isSeries] Optional filter for live tv series. * @param {boolean} [isNews] Optional filter for live tv news. @@ -553,15 +557,15 @@ export const TrailersApiFp = function(configuration?: Configuration) { * @param {number} [limit] Optional. The maximum number of records to return. * @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false. * @param {string} [searchTerm] Optional. Filter based on a search term. - * @param {Array} [sortOrder] Sort Order - Ascending,Descending. + * @param {Array} [sortOrder] Sort Order - Ascending, Descending. * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root. * @param {Array} [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. * @param {Array} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. * @param {Array} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes. * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not. - * @param {Array} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited. + * @param {Array} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited. * @param {Array} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited. - * @param {Array} [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. + * @param {Array} [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. * @param {boolean} [isPlayed] Optional filter by items that are played, or not. * @param {Array} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. * @param {Array} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. @@ -604,7 +608,7 @@ export const TrailersApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getTrailers(userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array, excludeLocationTypes?: Array, 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, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array, parentId?: string, fields?: Array, excludeItemTypes?: Array, filters?: Array, isFavorite?: boolean, mediaTypes?: Array, imageTypes?: Array, sortBy?: Array, isPlayed?: boolean, genres?: Array, officialRatings?: Array, tags?: Array, years?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, person?: string, personIds?: Array, personTypes?: Array, studios?: Array, artists?: Array, excludeArtistIds?: Array, artistIds?: Array, albumArtistIds?: Array, contributingArtistIds?: Array, albums?: Array, albumIds?: Array, ids?: Array, videoTypes?: Array, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array, genreIds?: Array, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getTrailers(userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array, excludeLocationTypes?: Array, 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, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array, parentId?: string, fields?: Array, excludeItemTypes?: Array, filters?: Array, isFavorite?: boolean, mediaTypes?: Array, imageTypes?: Array, sortBy?: Array, isPlayed?: boolean, genres?: Array, officialRatings?: Array, tags?: Array, years?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, person?: string, personIds?: Array, personTypes?: Array, studios?: Array, artists?: Array, excludeArtistIds?: Array, artistIds?: Array, albumArtistIds?: Array, contributingArtistIds?: Array, albums?: Array, albumIds?: Array, ids?: Array, videoTypes?: Array, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array, genreIds?: Array, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getTrailers(userId, maxOfficialRating, hasThemeSong, hasThemeVideo, hasSubtitles, hasSpecialFeature, hasTrailer, adjacentTo, parentIndexNumber, hasParentalRating, isHd, is4K, locationTypes, excludeLocationTypes, isMissing, isUnaired, minCommunityRating, minCriticRating, minPremiereDate, minDateLastSaved, minDateLastSavedForUser, maxPremiereDate, hasOverview, hasImdbId, hasTmdbId, hasTvdbId, isMovie, isSeries, isNews, isKids, isSports, excludeItemIds, startIndex, limit, recursive, searchTerm, sortOrder, parentId, fields, excludeItemTypes, filters, isFavorite, mediaTypes, imageTypes, sortBy, isPlayed, genres, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, artists, excludeArtistIds, artistIds, albumArtistIds, contributingArtistIds, albums, albumIds, ids, videoTypes, minOfficialRating, isLocked, isPlaceHolder, hasOfficialRating, collapseBoxSetItems, minWidth, minHeight, maxWidth, maxHeight, is3D, seriesStatus, nameStartsWithOrGreater, nameStartsWith, nameLessThan, studioIds, genreIds, enableTotalRecordCount, enableImages, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -621,7 +625,7 @@ export const TrailersApiFactory = function (configuration?: Configuration, baseP /** * * @summary Finds movies and trailers similar to a given trailer. - * @param {string} [userId] The user id. + * @param {string} [userId] The user id supplied as query parameter; this is required when not using an API key. * @param {string} [maxOfficialRating] Optional filter by maximum official rating (PG, PG-13, TV-MA, etc). * @param {boolean} [hasThemeSong] Optional filter by items with theme songs. * @param {boolean} [hasThemeVideo] Optional filter by items with theme videos. @@ -644,9 +648,9 @@ export const TrailersApiFactory = function (configuration?: Configuration, baseP * @param {string} [minDateLastSavedForUser] Optional. The minimum last saved date for the current user. Format = ISO. * @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format = ISO. * @param {boolean} [hasOverview] Optional filter by items that have an overview or not. - * @param {boolean} [hasImdbId] Optional filter by items that have an imdb id or not. - * @param {boolean} [hasTmdbId] Optional filter by items that have a tmdb id or not. - * @param {boolean} [hasTvdbId] Optional filter by items that have a tvdb id or not. + * @param {boolean} [hasImdbId] Optional filter by items that have an IMDb id or not. + * @param {boolean} [hasTmdbId] Optional filter by items that have a TMDb id or not. + * @param {boolean} [hasTvdbId] Optional filter by items that have a TVDb id or not. * @param {boolean} [isMovie] Optional filter for live tv movies. * @param {boolean} [isSeries] Optional filter for live tv series. * @param {boolean} [isNews] Optional filter for live tv news. @@ -657,15 +661,15 @@ export const TrailersApiFactory = function (configuration?: Configuration, baseP * @param {number} [limit] Optional. The maximum number of records to return. * @param {boolean} [recursive] When searching within folders, this determines whether or not the search will be recursive. true/false. * @param {string} [searchTerm] Optional. Filter based on a search term. - * @param {Array} [sortOrder] Sort Order - Ascending,Descending. + * @param {Array} [sortOrder] Sort Order - Ascending, Descending. * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root. * @param {Array} [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. * @param {Array} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. * @param {Array} [filters] Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes. * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not. - * @param {Array} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited. + * @param {Array} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited. * @param {Array} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited. - * @param {Array} [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. + * @param {Array} [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. * @param {boolean} [isPlayed] Optional filter by items that are played, or not. * @param {Array} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited. * @param {Array} [officialRatings] Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited. @@ -708,7 +712,7 @@ export const TrailersApiFactory = function (configuration?: Configuration, baseP * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getTrailers(userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array, excludeLocationTypes?: Array, 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, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array, parentId?: string, fields?: Array, excludeItemTypes?: Array, filters?: Array, isFavorite?: boolean, mediaTypes?: Array, imageTypes?: Array, sortBy?: Array, isPlayed?: boolean, genres?: Array, officialRatings?: Array, tags?: Array, years?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, person?: string, personIds?: Array, personTypes?: Array, studios?: Array, artists?: Array, excludeArtistIds?: Array, artistIds?: Array, albumArtistIds?: Array, contributingArtistIds?: Array, albums?: Array, albumIds?: Array, ids?: Array, videoTypes?: Array, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array, genreIds?: Array, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): AxiosPromise { + getTrailers(userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array, excludeLocationTypes?: Array, 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, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array, parentId?: string, fields?: Array, excludeItemTypes?: Array, filters?: Array, isFavorite?: boolean, mediaTypes?: Array, imageTypes?: Array, sortBy?: Array, isPlayed?: boolean, genres?: Array, officialRatings?: Array, tags?: Array, years?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, person?: string, personIds?: Array, personTypes?: Array, studios?: Array, artists?: Array, excludeArtistIds?: Array, artistIds?: Array, albumArtistIds?: Array, contributingArtistIds?: Array, albums?: Array, albumIds?: Array, ids?: Array, videoTypes?: Array, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array, genreIds?: Array, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): AxiosPromise { return localVarFp.getTrailers(userId, maxOfficialRating, hasThemeSong, hasThemeVideo, hasSubtitles, hasSpecialFeature, hasTrailer, adjacentTo, parentIndexNumber, hasParentalRating, isHd, is4K, locationTypes, excludeLocationTypes, isMissing, isUnaired, minCommunityRating, minCriticRating, minPremiereDate, minDateLastSaved, minDateLastSavedForUser, maxPremiereDate, hasOverview, hasImdbId, hasTmdbId, hasTvdbId, isMovie, isSeries, isNews, isKids, isSports, excludeItemIds, startIndex, limit, recursive, searchTerm, sortOrder, parentId, fields, excludeItemTypes, filters, isFavorite, mediaTypes, imageTypes, sortBy, isPlayed, genres, officialRatings, tags, years, enableUserData, imageTypeLimit, enableImageTypes, person, personIds, personTypes, studios, artists, excludeArtistIds, artistIds, albumArtistIds, contributingArtistIds, albums, albumIds, ids, videoTypes, minOfficialRating, isLocked, isPlaceHolder, hasOfficialRating, collapseBoxSetItems, minWidth, minHeight, maxWidth, maxHeight, is3D, seriesStatus, nameStartsWithOrGreater, nameStartsWith, nameLessThan, studioIds, genreIds, enableTotalRecordCount, enableImages, options).then((request) => request(axios, basePath)); }, }; @@ -721,7 +725,7 @@ export const TrailersApiFactory = function (configuration?: Configuration, baseP */ export interface TrailersApiGetTrailersRequest { /** - * The user id. + * The user id supplied as query parameter; this is required when not using an API key. * @type {string} * @memberof TrailersApiGetTrailers */ @@ -882,21 +886,21 @@ export interface TrailersApiGetTrailersRequest { readonly hasOverview?: boolean /** - * Optional filter by items that have an imdb id or not. + * Optional filter by items that have an IMDb id or not. * @type {boolean} * @memberof TrailersApiGetTrailers */ readonly hasImdbId?: boolean /** - * Optional filter by items that have a tmdb id or not. + * Optional filter by items that have a TMDb id or not. * @type {boolean} * @memberof TrailersApiGetTrailers */ readonly hasTmdbId?: boolean /** - * Optional filter by items that have a tvdb id or not. + * Optional filter by items that have a TVDb id or not. * @type {boolean} * @memberof TrailersApiGetTrailers */ @@ -973,7 +977,7 @@ export interface TrailersApiGetTrailersRequest { readonly searchTerm?: string /** - * Sort Order - Ascending,Descending. + * Sort Order - Ascending, Descending. * @type {Array} * @memberof TrailersApiGetTrailers */ @@ -1016,10 +1020,10 @@ export interface TrailersApiGetTrailersRequest { /** * Optional filter by MediaType. Allows multiple, comma delimited. - * @type {Array} + * @type {Array} * @memberof TrailersApiGetTrailers */ - readonly mediaTypes?: Array + readonly mediaTypes?: Array /** * Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited. @@ -1030,10 +1034,10 @@ export interface TrailersApiGetTrailersRequest { /** * 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. - * @type {Array} + * @type {Array} * @memberof TrailersApiGetTrailers */ - readonly sortBy?: Array + readonly sortBy?: Array /** * Optional filter by items that are played, or not. diff --git a/src/generated-client/api/trickplay-api.ts b/src/generated-client/api/trickplay-api.ts new file mode 100644 index 00000000..282cf6c9 --- /dev/null +++ b/src/generated-client/api/trickplay-api.ts @@ -0,0 +1,294 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; +import { Configuration } from '../configuration'; +// Some imports not used depending on template conditions +// @ts-ignore +import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common'; +// @ts-ignore +import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base'; +// @ts-ignore +import { ProblemDetails } from '../models'; +/** + * TrickplayApi - axios parameter creator + * @export + */ +export const TrickplayApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * + * @summary Gets an image tiles playlist for trickplay. + * @param {string} itemId The item id. + * @param {number} width The width of a single tile. + * @param {string} [mediaSourceId] The media version id, if using an alternate version. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getTrickplayHlsPlaylist: async (itemId: string, width: number, mediaSourceId?: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'itemId' is not null or undefined + assertParamExists('getTrickplayHlsPlaylist', 'itemId', itemId) + // verify required parameter 'width' is not null or undefined + assertParamExists('getTrickplayHlsPlaylist', 'width', width) + const localVarPath = `/Videos/{itemId}/Trickplay/{width}/tiles.m3u8` + .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))) + .replace(`{${"width"}}`, encodeURIComponent(String(width))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication CustomAuthentication required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + if (mediaSourceId !== undefined) { + localVarQueryParameter['mediaSourceId'] = mediaSourceId; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Gets a trickplay tile image. + * @param {string} itemId The item id. + * @param {number} width The width of a single tile. + * @param {number} index The index of the desired tile. + * @param {string} [mediaSourceId] The media version id, if using an alternate version. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getTrickplayTileImage: async (itemId: string, width: number, index: number, mediaSourceId?: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'itemId' is not null or undefined + assertParamExists('getTrickplayTileImage', 'itemId', itemId) + // verify required parameter 'width' is not null or undefined + assertParamExists('getTrickplayTileImage', 'width', width) + // verify required parameter 'index' is not null or undefined + assertParamExists('getTrickplayTileImage', 'index', index) + const localVarPath = `/Videos/{itemId}/Trickplay/{width}/{index}.jpg` + .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))) + .replace(`{${"width"}}`, encodeURIComponent(String(width))) + .replace(`{${"index"}}`, encodeURIComponent(String(index))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication CustomAuthentication required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + if (mediaSourceId !== undefined) { + localVarQueryParameter['mediaSourceId'] = mediaSourceId; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * TrickplayApi - functional programming interface + * @export + */ +export const TrickplayApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = TrickplayApiAxiosParamCreator(configuration) + return { + /** + * + * @summary Gets an image tiles playlist for trickplay. + * @param {string} itemId The item id. + * @param {number} width The width of a single tile. + * @param {string} [mediaSourceId] The media version id, if using an alternate version. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getTrickplayHlsPlaylist(itemId: string, width: number, mediaSourceId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTrickplayHlsPlaylist(itemId, width, mediaSourceId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Gets a trickplay tile image. + * @param {string} itemId The item id. + * @param {number} width The width of a single tile. + * @param {number} index The index of the desired tile. + * @param {string} [mediaSourceId] The media version id, if using an alternate version. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getTrickplayTileImage(itemId: string, width: number, index: number, mediaSourceId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTrickplayTileImage(itemId, width, index, mediaSourceId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + } +}; + +/** + * TrickplayApi - factory interface + * @export + */ +export const TrickplayApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = TrickplayApiFp(configuration) + return { + /** + * + * @summary Gets an image tiles playlist for trickplay. + * @param {string} itemId The item id. + * @param {number} width The width of a single tile. + * @param {string} [mediaSourceId] The media version id, if using an alternate version. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getTrickplayHlsPlaylist(itemId: string, width: number, mediaSourceId?: string, options?: any): AxiosPromise { + return localVarFp.getTrickplayHlsPlaylist(itemId, width, mediaSourceId, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Gets a trickplay tile image. + * @param {string} itemId The item id. + * @param {number} width The width of a single tile. + * @param {number} index The index of the desired tile. + * @param {string} [mediaSourceId] The media version id, if using an alternate version. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getTrickplayTileImage(itemId: string, width: number, index: number, mediaSourceId?: string, options?: any): AxiosPromise { + return localVarFp.getTrickplayTileImage(itemId, width, index, mediaSourceId, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * Request parameters for getTrickplayHlsPlaylist operation in TrickplayApi. + * @export + * @interface TrickplayApiGetTrickplayHlsPlaylistRequest + */ +export interface TrickplayApiGetTrickplayHlsPlaylistRequest { + /** + * The item id. + * @type {string} + * @memberof TrickplayApiGetTrickplayHlsPlaylist + */ + readonly itemId: string + + /** + * The width of a single tile. + * @type {number} + * @memberof TrickplayApiGetTrickplayHlsPlaylist + */ + readonly width: number + + /** + * The media version id, if using an alternate version. + * @type {string} + * @memberof TrickplayApiGetTrickplayHlsPlaylist + */ + readonly mediaSourceId?: string +} + +/** + * Request parameters for getTrickplayTileImage operation in TrickplayApi. + * @export + * @interface TrickplayApiGetTrickplayTileImageRequest + */ +export interface TrickplayApiGetTrickplayTileImageRequest { + /** + * The item id. + * @type {string} + * @memberof TrickplayApiGetTrickplayTileImage + */ + readonly itemId: string + + /** + * The width of a single tile. + * @type {number} + * @memberof TrickplayApiGetTrickplayTileImage + */ + readonly width: number + + /** + * The index of the desired tile. + * @type {number} + * @memberof TrickplayApiGetTrickplayTileImage + */ + readonly index: number + + /** + * The media version id, if using an alternate version. + * @type {string} + * @memberof TrickplayApiGetTrickplayTileImage + */ + readonly mediaSourceId?: string +} + +/** + * TrickplayApi - object-oriented interface + * @export + * @class TrickplayApi + * @extends {BaseAPI} + */ +export class TrickplayApi extends BaseAPI { + /** + * + * @summary Gets an image tiles playlist for trickplay. + * @param {TrickplayApiGetTrickplayHlsPlaylistRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TrickplayApi + */ + public getTrickplayHlsPlaylist(requestParameters: TrickplayApiGetTrickplayHlsPlaylistRequest, options?: AxiosRequestConfig) { + return TrickplayApiFp(this.configuration).getTrickplayHlsPlaylist(requestParameters.itemId, requestParameters.width, requestParameters.mediaSourceId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Gets a trickplay tile image. + * @param {TrickplayApiGetTrickplayTileImageRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TrickplayApi + */ + public getTrickplayTileImage(requestParameters: TrickplayApiGetTrickplayTileImageRequest, options?: AxiosRequestConfig) { + return TrickplayApiFp(this.configuration).getTrickplayTileImage(requestParameters.itemId, requestParameters.width, requestParameters.index, requestParameters.mediaSourceId, options).then((request) => request(this.axios, this.basePath)); + } +} diff --git a/src/generated-client/api/tv-shows-api.ts b/src/generated-client/api/tv-shows-api.ts index 2b9251e2..43c18d17 100644 --- a/src/generated-client/api/tv-shows-api.ts +++ b/src/generated-client/api/tv-shows-api.ts @@ -26,6 +26,8 @@ import { ImageType } from '../models'; // @ts-ignore import { ItemFields } from '../models'; // @ts-ignore +import { ItemSortBy } from '../models'; +// @ts-ignore import { ProblemDetails } from '../models'; /** * TvShowsApi - axios parameter creator @@ -50,11 +52,11 @@ export const TvShowsApiAxiosParamCreator = function (configuration?: Configurati * @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type. * @param {Array} [enableImageTypes] Optional. The image types to include in the output. * @param {boolean} [enableUserData] Optional. Include user data. - * @param {string} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. + * @param {ItemSortBy} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getEpisodes: async (seriesId: string, userId?: string, fields?: Array, season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, enableUserData?: boolean, sortBy?: string, options: AxiosRequestConfig = {}): Promise => { + getEpisodes: async (seriesId: string, userId?: string, fields?: Array, season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, enableUserData?: boolean, sortBy?: ItemSortBy, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'seriesId' is not null or undefined assertParamExists('getEpisodes', 'seriesId', seriesId) const localVarPath = `/Shows/{seriesId}/Episodes` @@ -156,11 +158,12 @@ export const TvShowsApiAxiosParamCreator = function (configuration?: Configurati * @param {string} [nextUpDateCutoff] Optional. Starting date of shows to show in Next Up section. * @param {boolean} [enableTotalRecordCount] Whether to enable the total records count. Defaults to true. * @param {boolean} [disableFirstEpisode] Whether to disable sending the first episode in a series as next up. - * @param {boolean} [enableRewatching] Whether to include watched episode in next up results. + * @param {boolean} [enableResumable] Whether to include resumable episodes in next up results. + * @param {boolean} [enableRewatching] Whether to include watched episodes in next up results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getNextUp: async (userId?: string, startIndex?: number, limit?: number, fields?: Array, seriesId?: string, parentId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, enableUserData?: boolean, nextUpDateCutoff?: string, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, enableRewatching?: boolean, options: AxiosRequestConfig = {}): Promise => { + getNextUp: async (userId?: string, startIndex?: number, limit?: number, fields?: Array, seriesId?: string, parentId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, enableUserData?: boolean, nextUpDateCutoff?: string, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, enableResumable?: boolean, enableRewatching?: boolean, options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/Shows/NextUp`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -230,6 +233,10 @@ export const TvShowsApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['disableFirstEpisode'] = disableFirstEpisode; } + if (enableResumable !== undefined) { + localVarQueryParameter['enableResumable'] = enableResumable; + } + if (enableRewatching !== undefined) { localVarQueryParameter['enableRewatching'] = enableRewatching; } @@ -432,11 +439,11 @@ export const TvShowsApiFp = function(configuration?: Configuration) { * @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type. * @param {Array} [enableImageTypes] Optional. The image types to include in the output. * @param {boolean} [enableUserData] Optional. Include user data. - * @param {string} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. + * @param {ItemSortBy} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getEpisodes(seriesId: string, userId?: string, fields?: Array, season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, enableUserData?: boolean, sortBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getEpisodes(seriesId: string, userId?: string, fields?: Array, season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, enableUserData?: boolean, sortBy?: ItemSortBy, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getEpisodes(seriesId, userId, fields, season, seasonId, isMissing, adjacentTo, startItemId, startIndex, limit, enableImages, imageTypeLimit, enableImageTypes, enableUserData, sortBy, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -456,12 +463,13 @@ export const TvShowsApiFp = function(configuration?: Configuration) { * @param {string} [nextUpDateCutoff] Optional. Starting date of shows to show in Next Up section. * @param {boolean} [enableTotalRecordCount] Whether to enable the total records count. Defaults to true. * @param {boolean} [disableFirstEpisode] Whether to disable sending the first episode in a series as next up. - * @param {boolean} [enableRewatching] Whether to include watched episode in next up results. + * @param {boolean} [enableResumable] Whether to include resumable episodes in next up results. + * @param {boolean} [enableRewatching] Whether to include watched episodes in next up results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getNextUp(userId?: string, startIndex?: number, limit?: number, fields?: Array, seriesId?: string, parentId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, enableUserData?: boolean, nextUpDateCutoff?: string, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, enableRewatching?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNextUp(userId, startIndex, limit, fields, seriesId, parentId, enableImages, imageTypeLimit, enableImageTypes, enableUserData, nextUpDateCutoff, enableTotalRecordCount, disableFirstEpisode, enableRewatching, options); + async getNextUp(userId?: string, startIndex?: number, limit?: number, fields?: Array, seriesId?: string, parentId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, enableUserData?: boolean, nextUpDateCutoff?: string, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, enableResumable?: boolean, enableRewatching?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getNextUp(userId, startIndex, limit, fields, seriesId, parentId, enableImages, imageTypeLimit, enableImageTypes, enableUserData, nextUpDateCutoff, enableTotalRecordCount, disableFirstEpisode, enableResumable, enableRewatching, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -530,11 +538,11 @@ export const TvShowsApiFactory = function (configuration?: Configuration, basePa * @param {number} [imageTypeLimit] Optional, the max number of images to return, per image type. * @param {Array} [enableImageTypes] Optional. The image types to include in the output. * @param {boolean} [enableUserData] Optional. Include user data. - * @param {string} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. + * @param {ItemSortBy} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getEpisodes(seriesId: string, userId?: string, fields?: Array, season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, enableUserData?: boolean, sortBy?: string, options?: any): AxiosPromise { + getEpisodes(seriesId: string, userId?: string, fields?: Array, season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, enableUserData?: boolean, sortBy?: ItemSortBy, options?: any): AxiosPromise { return localVarFp.getEpisodes(seriesId, userId, fields, season, seasonId, isMissing, adjacentTo, startItemId, startIndex, limit, enableImages, imageTypeLimit, enableImageTypes, enableUserData, sortBy, options).then((request) => request(axios, basePath)); }, /** @@ -553,12 +561,13 @@ export const TvShowsApiFactory = function (configuration?: Configuration, basePa * @param {string} [nextUpDateCutoff] Optional. Starting date of shows to show in Next Up section. * @param {boolean} [enableTotalRecordCount] Whether to enable the total records count. Defaults to true. * @param {boolean} [disableFirstEpisode] Whether to disable sending the first episode in a series as next up. - * @param {boolean} [enableRewatching] Whether to include watched episode in next up results. + * @param {boolean} [enableResumable] Whether to include resumable episodes in next up results. + * @param {boolean} [enableRewatching] Whether to include watched episodes in next up results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getNextUp(userId?: string, startIndex?: number, limit?: number, fields?: Array, seriesId?: string, parentId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, enableUserData?: boolean, nextUpDateCutoff?: string, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, enableRewatching?: boolean, options?: any): AxiosPromise { - return localVarFp.getNextUp(userId, startIndex, limit, fields, seriesId, parentId, enableImages, imageTypeLimit, enableImageTypes, enableUserData, nextUpDateCutoff, enableTotalRecordCount, disableFirstEpisode, enableRewatching, options).then((request) => request(axios, basePath)); + getNextUp(userId?: string, startIndex?: number, limit?: number, fields?: Array, seriesId?: string, parentId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, enableUserData?: boolean, nextUpDateCutoff?: string, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, enableResumable?: boolean, enableRewatching?: boolean, options?: any): AxiosPromise { + return localVarFp.getNextUp(userId, startIndex, limit, fields, seriesId, parentId, enableImages, imageTypeLimit, enableImageTypes, enableUserData, nextUpDateCutoff, enableTotalRecordCount, disableFirstEpisode, enableResumable, enableRewatching, options).then((request) => request(axios, basePath)); }, /** * @@ -706,10 +715,10 @@ export interface TvShowsApiGetEpisodesRequest { /** * 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. - * @type {string} + * @type {ItemSortBy} * @memberof TvShowsApiGetEpisodes */ - readonly sortBy?: string + readonly sortBy?: ItemSortBy } /** @@ -810,7 +819,14 @@ export interface TvShowsApiGetNextUpRequest { readonly disableFirstEpisode?: boolean /** - * Whether to include watched episode in next up results. + * Whether to include resumable episodes in next up results. + * @type {boolean} + * @memberof TvShowsApiGetNextUp + */ + readonly enableResumable?: boolean + + /** + * Whether to include watched episodes in next up results. * @type {boolean} * @memberof TvShowsApiGetNextUp */ @@ -992,7 +1008,7 @@ export class TvShowsApi extends BaseAPI { * @memberof TvShowsApi */ public getNextUp(requestParameters: TvShowsApiGetNextUpRequest = {}, options?: AxiosRequestConfig) { - return TvShowsApiFp(this.configuration).getNextUp(requestParameters.userId, requestParameters.startIndex, requestParameters.limit, requestParameters.fields, requestParameters.seriesId, requestParameters.parentId, requestParameters.enableImages, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, requestParameters.enableUserData, requestParameters.nextUpDateCutoff, requestParameters.enableTotalRecordCount, requestParameters.disableFirstEpisode, requestParameters.enableRewatching, options).then((request) => request(this.axios, this.basePath)); + return TvShowsApiFp(this.configuration).getNextUp(requestParameters.userId, requestParameters.startIndex, requestParameters.limit, requestParameters.fields, requestParameters.seriesId, requestParameters.parentId, requestParameters.enableImages, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, requestParameters.enableUserData, requestParameters.nextUpDateCutoff, requestParameters.enableTotalRecordCount, requestParameters.disableFirstEpisode, requestParameters.enableResumable, requestParameters.enableRewatching, options).then((request) => request(this.axios, this.basePath)); } /** diff --git a/src/generated-client/api/universal-audio-api.ts b/src/generated-client/api/universal-audio-api.ts index 0ff58de5..0d028308 100644 --- a/src/generated-client/api/universal-audio-api.ts +++ b/src/generated-client/api/universal-audio-api.ts @@ -19,6 +19,10 @@ import { Configuration } from '../configuration'; import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base'; +// @ts-ignore +import { MediaStreamProtocol } from '../models'; +// @ts-ignore +import { ProblemDetails } from '../models'; /** * UniversalAudioApi - axios parameter creator * @export @@ -40,7 +44,7 @@ export const UniversalAudioApiAxiosParamCreator = function (configuration?: Conf * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. * @param {string} [transcodingContainer] Optional. The container to transcode to. - * @param {string} [transcodingProtocol] Optional. The transcoding protocol. + * @param {MediaStreamProtocol} [transcodingProtocol] Optional. The transcoding protocol. * @param {number} [maxAudioSampleRate] Optional. The maximum audio sample rate. * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth. * @param {boolean} [enableRemoteMedia] Optional. Whether to enable remote media. @@ -49,7 +53,7 @@ export const UniversalAudioApiAxiosParamCreator = function (configuration?: Conf * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getUniversalAudioStream: async (itemId: string, container?: Array, mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options: AxiosRequestConfig = {}): Promise => { + getUniversalAudioStream: async (itemId: string, container?: Array, mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: MediaStreamProtocol, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'itemId' is not null or undefined assertParamExists('getUniversalAudioStream', 'itemId', itemId) const localVarPath = `/Audio/{itemId}/universal` @@ -162,7 +166,7 @@ export const UniversalAudioApiAxiosParamCreator = function (configuration?: Conf * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. * @param {string} [transcodingContainer] Optional. The container to transcode to. - * @param {string} [transcodingProtocol] Optional. The transcoding protocol. + * @param {MediaStreamProtocol} [transcodingProtocol] Optional. The transcoding protocol. * @param {number} [maxAudioSampleRate] Optional. The maximum audio sample rate. * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth. * @param {boolean} [enableRemoteMedia] Optional. Whether to enable remote media. @@ -171,7 +175,7 @@ export const UniversalAudioApiAxiosParamCreator = function (configuration?: Conf * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headUniversalAudioStream: async (itemId: string, container?: Array, mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options: AxiosRequestConfig = {}): Promise => { + headUniversalAudioStream: async (itemId: string, container?: Array, mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: MediaStreamProtocol, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'itemId' is not null or undefined assertParamExists('headUniversalAudioStream', 'itemId', itemId) const localVarPath = `/Audio/{itemId}/universal` @@ -294,7 +298,7 @@ export const UniversalAudioApiFp = function(configuration?: Configuration) { * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. * @param {string} [transcodingContainer] Optional. The container to transcode to. - * @param {string} [transcodingProtocol] Optional. The transcoding protocol. + * @param {MediaStreamProtocol} [transcodingProtocol] Optional. The transcoding protocol. * @param {number} [maxAudioSampleRate] Optional. The maximum audio sample rate. * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth. * @param {boolean} [enableRemoteMedia] Optional. Whether to enable remote media. @@ -303,7 +307,7 @@ export const UniversalAudioApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getUniversalAudioStream(itemId: string, container?: Array, mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getUniversalAudioStream(itemId: string, container?: Array, mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: MediaStreamProtocol, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getUniversalAudioStream(itemId, container, mediaSourceId, deviceId, userId, audioCodec, maxAudioChannels, transcodingAudioChannels, maxStreamingBitrate, audioBitRate, startTimeTicks, transcodingContainer, transcodingProtocol, maxAudioSampleRate, maxAudioBitDepth, enableRemoteMedia, breakOnNonKeyFrames, enableRedirection, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -322,7 +326,7 @@ export const UniversalAudioApiFp = function(configuration?: Configuration) { * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. * @param {string} [transcodingContainer] Optional. The container to transcode to. - * @param {string} [transcodingProtocol] Optional. The transcoding protocol. + * @param {MediaStreamProtocol} [transcodingProtocol] Optional. The transcoding protocol. * @param {number} [maxAudioSampleRate] Optional. The maximum audio sample rate. * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth. * @param {boolean} [enableRemoteMedia] Optional. Whether to enable remote media. @@ -331,7 +335,7 @@ export const UniversalAudioApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async headUniversalAudioStream(itemId: string, container?: Array, mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async headUniversalAudioStream(itemId: string, container?: Array, mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: MediaStreamProtocol, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.headUniversalAudioStream(itemId, container, mediaSourceId, deviceId, userId, audioCodec, maxAudioChannels, transcodingAudioChannels, maxStreamingBitrate, audioBitRate, startTimeTicks, transcodingContainer, transcodingProtocol, maxAudioSampleRate, maxAudioBitDepth, enableRemoteMedia, breakOnNonKeyFrames, enableRedirection, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -360,7 +364,7 @@ export const UniversalAudioApiFactory = function (configuration?: Configuration, * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. * @param {string} [transcodingContainer] Optional. The container to transcode to. - * @param {string} [transcodingProtocol] Optional. The transcoding protocol. + * @param {MediaStreamProtocol} [transcodingProtocol] Optional. The transcoding protocol. * @param {number} [maxAudioSampleRate] Optional. The maximum audio sample rate. * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth. * @param {boolean} [enableRemoteMedia] Optional. Whether to enable remote media. @@ -369,7 +373,7 @@ export const UniversalAudioApiFactory = function (configuration?: Configuration, * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getUniversalAudioStream(itemId: string, container?: Array, mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: any): AxiosPromise { + getUniversalAudioStream(itemId: string, container?: Array, mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: MediaStreamProtocol, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: any): AxiosPromise { return localVarFp.getUniversalAudioStream(itemId, container, mediaSourceId, deviceId, userId, audioCodec, maxAudioChannels, transcodingAudioChannels, maxStreamingBitrate, audioBitRate, startTimeTicks, transcodingContainer, transcodingProtocol, maxAudioSampleRate, maxAudioBitDepth, enableRemoteMedia, breakOnNonKeyFrames, enableRedirection, options).then((request) => request(axios, basePath)); }, /** @@ -387,7 +391,7 @@ export const UniversalAudioApiFactory = function (configuration?: Configuration, * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. * @param {string} [transcodingContainer] Optional. The container to transcode to. - * @param {string} [transcodingProtocol] Optional. The transcoding protocol. + * @param {MediaStreamProtocol} [transcodingProtocol] Optional. The transcoding protocol. * @param {number} [maxAudioSampleRate] Optional. The maximum audio sample rate. * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth. * @param {boolean} [enableRemoteMedia] Optional. Whether to enable remote media. @@ -396,7 +400,7 @@ export const UniversalAudioApiFactory = function (configuration?: Configuration, * @param {*} [options] Override http request option. * @throws {RequiredError} */ - headUniversalAudioStream(itemId: string, container?: Array, mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: any): AxiosPromise { + headUniversalAudioStream(itemId: string, container?: Array, mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: MediaStreamProtocol, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: any): AxiosPromise { return localVarFp.headUniversalAudioStream(itemId, container, mediaSourceId, deviceId, userId, audioCodec, maxAudioChannels, transcodingAudioChannels, maxStreamingBitrate, audioBitRate, startTimeTicks, transcodingContainer, transcodingProtocol, maxAudioSampleRate, maxAudioBitDepth, enableRemoteMedia, breakOnNonKeyFrames, enableRedirection, options).then((request) => request(axios, basePath)); }, }; @@ -494,10 +498,10 @@ export interface UniversalAudioApiGetUniversalAudioStreamRequest { /** * Optional. The transcoding protocol. - * @type {string} + * @type {MediaStreamProtocol} * @memberof UniversalAudioApiGetUniversalAudioStream */ - readonly transcodingProtocol?: string + readonly transcodingProtocol?: MediaStreamProtocol /** * Optional. The maximum audio sample rate. @@ -627,10 +631,10 @@ export interface UniversalAudioApiHeadUniversalAudioStreamRequest { /** * Optional. The transcoding protocol. - * @type {string} + * @type {MediaStreamProtocol} * @memberof UniversalAudioApiHeadUniversalAudioStream */ - readonly transcodingProtocol?: string + readonly transcodingProtocol?: MediaStreamProtocol /** * Optional. The maximum audio sample rate. diff --git a/src/generated-client/api/user-api.ts b/src/generated-client/api/user-api.ts index 618e576c..d6ffddd2 100644 --- a/src/generated-client/api/user-api.ts +++ b/src/generated-client/api/user-api.ts @@ -38,8 +38,6 @@ import { ProblemDetails } from '../models'; // @ts-ignore import { QuickConnectDto } from '../models'; // @ts-ignore -import { UpdateUserEasyPassword } from '../models'; -// @ts-ignore import { UpdateUserPassword } from '../models'; // @ts-ignore import { UserConfiguration } from '../models'; @@ -53,52 +51,6 @@ import { UserPolicy } from '../models'; */ export const UserApiAxiosParamCreator = function (configuration?: Configuration) { return { - /** - * - * @summary Authenticates a user. - * @param {string} userId The user id. - * @param {string} pw The password as plain text. - * @param {string} [password] The password sha1-hash. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - authenticateUser: async (userId: string, pw: string, password?: string, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('authenticateUser', 'userId', userId) - // verify required parameter 'pw' is not null or undefined - assertParamExists('authenticateUser', 'pw', pw) - const localVarPath = `/Users/{userId}/Authenticate` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (pw !== undefined) { - localVarQueryParameter['pw'] = pw; - } - - if (password !== undefined) { - localVarQueryParameter['password'] = password; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, /** * * @summary Authenticates a user by name. @@ -465,18 +417,15 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * * @summary Updates a user. - * @param {string} userId The user id. * @param {UserDto} userDto The updated user model. + * @param {string} [userId] The user id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateUser: async (userId: string, userDto: UserDto, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('updateUser', 'userId', userId) + updateUser: async (userDto: UserDto, userId?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'userDto' is not null or undefined assertParamExists('updateUser', 'userDto', userDto) - const localVarPath = `/Users/{userId}` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))); + const localVarPath = `/Users`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -491,6 +440,10 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) // authentication CustomAuthentication required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (userId !== undefined) { + localVarQueryParameter['userId'] = userId; + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -508,18 +461,15 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * * @summary Updates a user configuration. - * @param {string} userId The user id. * @param {UserConfiguration} userConfiguration The new user configuration. + * @param {string} [userId] The user id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateUserConfiguration: async (userId: string, userConfiguration: UserConfiguration, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('updateUserConfiguration', 'userId', userId) + updateUserConfiguration: async (userConfiguration: UserConfiguration, userId?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'userConfiguration' is not null or undefined assertParamExists('updateUserConfiguration', 'userConfiguration', userConfiguration) - const localVarPath = `/Users/{userId}/Configuration` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))); + const localVarPath = `/Users/Configuration`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -534,6 +484,10 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) // authentication CustomAuthentication required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (userId !== undefined) { + localVarQueryParameter['userId'] = userId; + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -548,64 +502,18 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) options: localVarRequestOptions, }; }, - /** - * - * @summary Updates a user\'s easy password. - * @param {string} userId The user id. - * @param {UpdateUserEasyPassword} updateUserEasyPassword The M:Jellyfin.Api.Controllers.UserController.UpdateUserEasyPassword(System.Guid,Jellyfin.Api.Models.UserDtos.UpdateUserEasyPassword) request. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - updateUserEasyPassword: async (userId: string, updateUserEasyPassword: UpdateUserEasyPassword, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('updateUserEasyPassword', 'userId', userId) - // verify required parameter 'updateUserEasyPassword' is not null or undefined - assertParamExists('updateUserEasyPassword', 'updateUserEasyPassword', updateUserEasyPassword) - const localVarPath = `/Users/{userId}/EasyPassword` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication CustomAuthentication required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(updateUserEasyPassword, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, /** * * @summary Updates a user\'s password. - * @param {string} userId The user id. - * @param {UpdateUserPassword} updateUserPassword The M:Jellyfin.Api.Controllers.UserController.UpdateUserPassword(System.Guid,Jellyfin.Api.Models.UserDtos.UpdateUserPassword) request. + * @param {UpdateUserPassword} updateUserPassword The M:Jellyfin.Api.Controllers.UserController.UpdateUserPassword(System.Nullable{System.Guid},Jellyfin.Api.Models.UserDtos.UpdateUserPassword) request. + * @param {string} [userId] The user id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateUserPassword: async (userId: string, updateUserPassword: UpdateUserPassword, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('updateUserPassword', 'userId', userId) + updateUserPassword: async (updateUserPassword: UpdateUserPassword, userId?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'updateUserPassword' is not null or undefined assertParamExists('updateUserPassword', 'updateUserPassword', updateUserPassword) - const localVarPath = `/Users/{userId}/Password` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))); + const localVarPath = `/Users/Password`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -620,6 +528,10 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) // authentication CustomAuthentication required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (userId !== undefined) { + localVarQueryParameter['userId'] = userId; + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -687,19 +599,6 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) export const UserApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = UserApiAxiosParamCreator(configuration) return { - /** - * - * @summary Authenticates a user. - * @param {string} userId The user id. - * @param {string} pw The password as plain text. - * @param {string} [password] The password sha1-hash. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async authenticateUser(userId: string, pw: string, password?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.authenticateUser(userId, pw, password, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, /** * * @summary Authenticates a user by name. @@ -812,49 +711,37 @@ export const UserApiFp = function(configuration?: Configuration) { /** * * @summary Updates a user. - * @param {string} userId The user id. * @param {UserDto} userDto The updated user model. + * @param {string} [userId] The user id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async updateUser(userId: string, userDto: UserDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateUser(userId, userDto, options); + async updateUser(userDto: UserDto, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateUser(userDto, userId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * * @summary Updates a user configuration. - * @param {string} userId The user id. * @param {UserConfiguration} userConfiguration The new user configuration. + * @param {string} [userId] The user id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async updateUserConfiguration(userId: string, userConfiguration: UserConfiguration, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateUserConfiguration(userId, userConfiguration, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * - * @summary Updates a user\'s easy password. - * @param {string} userId The user id. - * @param {UpdateUserEasyPassword} updateUserEasyPassword The M:Jellyfin.Api.Controllers.UserController.UpdateUserEasyPassword(System.Guid,Jellyfin.Api.Models.UserDtos.UpdateUserEasyPassword) request. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async updateUserEasyPassword(userId: string, updateUserEasyPassword: UpdateUserEasyPassword, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateUserEasyPassword(userId, updateUserEasyPassword, options); + async updateUserConfiguration(userConfiguration: UserConfiguration, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateUserConfiguration(userConfiguration, userId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * * @summary Updates a user\'s password. - * @param {string} userId The user id. - * @param {UpdateUserPassword} updateUserPassword The M:Jellyfin.Api.Controllers.UserController.UpdateUserPassword(System.Guid,Jellyfin.Api.Models.UserDtos.UpdateUserPassword) request. + * @param {UpdateUserPassword} updateUserPassword The M:Jellyfin.Api.Controllers.UserController.UpdateUserPassword(System.Nullable{System.Guid},Jellyfin.Api.Models.UserDtos.UpdateUserPassword) request. + * @param {string} [userId] The user id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async updateUserPassword(userId: string, updateUserPassword: UpdateUserPassword, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateUserPassword(userId, updateUserPassword, options); + async updateUserPassword(updateUserPassword: UpdateUserPassword, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateUserPassword(updateUserPassword, userId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** @@ -879,18 +766,6 @@ export const UserApiFp = function(configuration?: Configuration) { export const UserApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = UserApiFp(configuration) return { - /** - * - * @summary Authenticates a user. - * @param {string} userId The user id. - * @param {string} pw The password as plain text. - * @param {string} [password] The password sha1-hash. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - authenticateUser(userId: string, pw: string, password?: string, options?: any): AxiosPromise { - return localVarFp.authenticateUser(userId, pw, password, options).then((request) => request(axios, basePath)); - }, /** * * @summary Authenticates a user by name. @@ -993,46 +868,35 @@ export const UserApiFactory = function (configuration?: Configuration, basePath? /** * * @summary Updates a user. - * @param {string} userId The user id. * @param {UserDto} userDto The updated user model. + * @param {string} [userId] The user id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateUser(userId: string, userDto: UserDto, options?: any): AxiosPromise { - return localVarFp.updateUser(userId, userDto, options).then((request) => request(axios, basePath)); + updateUser(userDto: UserDto, userId?: string, options?: any): AxiosPromise { + return localVarFp.updateUser(userDto, userId, options).then((request) => request(axios, basePath)); }, /** * * @summary Updates a user configuration. - * @param {string} userId The user id. * @param {UserConfiguration} userConfiguration The new user configuration. + * @param {string} [userId] The user id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateUserConfiguration(userId: string, userConfiguration: UserConfiguration, options?: any): AxiosPromise { - return localVarFp.updateUserConfiguration(userId, userConfiguration, options).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Updates a user\'s easy password. - * @param {string} userId The user id. - * @param {UpdateUserEasyPassword} updateUserEasyPassword The M:Jellyfin.Api.Controllers.UserController.UpdateUserEasyPassword(System.Guid,Jellyfin.Api.Models.UserDtos.UpdateUserEasyPassword) request. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - updateUserEasyPassword(userId: string, updateUserEasyPassword: UpdateUserEasyPassword, options?: any): AxiosPromise { - return localVarFp.updateUserEasyPassword(userId, updateUserEasyPassword, options).then((request) => request(axios, basePath)); + updateUserConfiguration(userConfiguration: UserConfiguration, userId?: string, options?: any): AxiosPromise { + return localVarFp.updateUserConfiguration(userConfiguration, userId, options).then((request) => request(axios, basePath)); }, /** * * @summary Updates a user\'s password. - * @param {string} userId The user id. - * @param {UpdateUserPassword} updateUserPassword The M:Jellyfin.Api.Controllers.UserController.UpdateUserPassword(System.Guid,Jellyfin.Api.Models.UserDtos.UpdateUserPassword) request. + * @param {UpdateUserPassword} updateUserPassword The M:Jellyfin.Api.Controllers.UserController.UpdateUserPassword(System.Nullable{System.Guid},Jellyfin.Api.Models.UserDtos.UpdateUserPassword) request. + * @param {string} [userId] The user id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateUserPassword(userId: string, updateUserPassword: UpdateUserPassword, options?: any): AxiosPromise { - return localVarFp.updateUserPassword(userId, updateUserPassword, options).then((request) => request(axios, basePath)); + updateUserPassword(updateUserPassword: UpdateUserPassword, userId?: string, options?: any): AxiosPromise { + return localVarFp.updateUserPassword(updateUserPassword, userId, options).then((request) => request(axios, basePath)); }, /** * @@ -1048,34 +912,6 @@ export const UserApiFactory = function (configuration?: Configuration, basePath? }; }; -/** - * Request parameters for authenticateUser operation in UserApi. - * @export - * @interface UserApiAuthenticateUserRequest - */ -export interface UserApiAuthenticateUserRequest { - /** - * The user id. - * @type {string} - * @memberof UserApiAuthenticateUser - */ - readonly userId: string - - /** - * The password as plain text. - * @type {string} - * @memberof UserApiAuthenticateUser - */ - readonly pw: string - - /** - * The password sha1-hash. - * @type {string} - * @memberof UserApiAuthenticateUser - */ - readonly password?: string -} - /** * Request parameters for authenticateUserByName operation in UserApi. * @export @@ -1201,19 +1037,19 @@ export interface UserApiGetUsersRequest { * @interface UserApiUpdateUserRequest */ export interface UserApiUpdateUserRequest { - /** - * The user id. - * @type {string} - * @memberof UserApiUpdateUser - */ - readonly userId: string - /** * The updated user model. * @type {UserDto} * @memberof UserApiUpdateUser */ readonly userDto: UserDto + + /** + * The user id. + * @type {string} + * @memberof UserApiUpdateUser + */ + readonly userId?: string } /** @@ -1222,40 +1058,19 @@ export interface UserApiUpdateUserRequest { * @interface UserApiUpdateUserConfigurationRequest */ export interface UserApiUpdateUserConfigurationRequest { - /** - * The user id. - * @type {string} - * @memberof UserApiUpdateUserConfiguration - */ - readonly userId: string - /** * The new user configuration. * @type {UserConfiguration} * @memberof UserApiUpdateUserConfiguration */ readonly userConfiguration: UserConfiguration -} -/** - * Request parameters for updateUserEasyPassword operation in UserApi. - * @export - * @interface UserApiUpdateUserEasyPasswordRequest - */ -export interface UserApiUpdateUserEasyPasswordRequest { /** * The user id. * @type {string} - * @memberof UserApiUpdateUserEasyPassword + * @memberof UserApiUpdateUserConfiguration */ - readonly userId: string - - /** - * The M:Jellyfin.Api.Controllers.UserController.UpdateUserEasyPassword(System.Guid,Jellyfin.Api.Models.UserDtos.UpdateUserEasyPassword) request. - * @type {UpdateUserEasyPassword} - * @memberof UserApiUpdateUserEasyPassword - */ - readonly updateUserEasyPassword: UpdateUserEasyPassword + readonly userId?: string } /** @@ -1265,18 +1080,18 @@ export interface UserApiUpdateUserEasyPasswordRequest { */ export interface UserApiUpdateUserPasswordRequest { /** - * The user id. - * @type {string} - * @memberof UserApiUpdateUserPassword - */ - readonly userId: string - - /** - * The M:Jellyfin.Api.Controllers.UserController.UpdateUserPassword(System.Guid,Jellyfin.Api.Models.UserDtos.UpdateUserPassword) request. + * The M:Jellyfin.Api.Controllers.UserController.UpdateUserPassword(System.Nullable{System.Guid},Jellyfin.Api.Models.UserDtos.UpdateUserPassword) request. * @type {UpdateUserPassword} * @memberof UserApiUpdateUserPassword */ readonly updateUserPassword: UpdateUserPassword + + /** + * The user id. + * @type {string} + * @memberof UserApiUpdateUserPassword + */ + readonly userId?: string } /** @@ -1307,18 +1122,6 @@ export interface UserApiUpdateUserPolicyRequest { * @extends {BaseAPI} */ export class UserApi extends BaseAPI { - /** - * - * @summary Authenticates a user. - * @param {UserApiAuthenticateUserRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UserApi - */ - public authenticateUser(requestParameters: UserApiAuthenticateUserRequest, options?: AxiosRequestConfig) { - return UserApiFp(this.configuration).authenticateUser(requestParameters.userId, requestParameters.pw, requestParameters.password, options).then((request) => request(this.axios, this.basePath)); - } - /** * * @summary Authenticates a user by name. @@ -1446,7 +1249,7 @@ export class UserApi extends BaseAPI { * @memberof UserApi */ public updateUser(requestParameters: UserApiUpdateUserRequest, options?: AxiosRequestConfig) { - return UserApiFp(this.configuration).updateUser(requestParameters.userId, requestParameters.userDto, options).then((request) => request(this.axios, this.basePath)); + return UserApiFp(this.configuration).updateUser(requestParameters.userDto, requestParameters.userId, options).then((request) => request(this.axios, this.basePath)); } /** @@ -1458,19 +1261,7 @@ export class UserApi extends BaseAPI { * @memberof UserApi */ public updateUserConfiguration(requestParameters: UserApiUpdateUserConfigurationRequest, options?: AxiosRequestConfig) { - return UserApiFp(this.configuration).updateUserConfiguration(requestParameters.userId, requestParameters.userConfiguration, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Updates a user\'s easy password. - * @param {UserApiUpdateUserEasyPasswordRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UserApi - */ - public updateUserEasyPassword(requestParameters: UserApiUpdateUserEasyPasswordRequest, options?: AxiosRequestConfig) { - return UserApiFp(this.configuration).updateUserEasyPassword(requestParameters.userId, requestParameters.updateUserEasyPassword, options).then((request) => request(this.axios, this.basePath)); + return UserApiFp(this.configuration).updateUserConfiguration(requestParameters.userConfiguration, requestParameters.userId, options).then((request) => request(this.axios, this.basePath)); } /** @@ -1482,7 +1273,7 @@ export class UserApi extends BaseAPI { * @memberof UserApi */ public updateUserPassword(requestParameters: UserApiUpdateUserPasswordRequest, options?: AxiosRequestConfig) { - return UserApiFp(this.configuration).updateUserPassword(requestParameters.userId, requestParameters.updateUserPassword, options).then((request) => request(this.axios, this.basePath)); + return UserApiFp(this.configuration).updateUserPassword(requestParameters.updateUserPassword, requestParameters.userId, options).then((request) => request(this.axios, this.basePath)); } /** diff --git a/src/generated-client/api/user-library-api.ts b/src/generated-client/api/user-library-api.ts index dd3e8f87..aed619de 100644 --- a/src/generated-client/api/user-library-api.ts +++ b/src/generated-client/api/user-library-api.ts @@ -40,18 +40,15 @@ export const UserLibraryApiAxiosParamCreator = function (configuration?: Configu /** * * @summary Deletes a user\'s saved personal rating for an item. - * @param {string} userId User id. * @param {string} itemId Item id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deleteUserItemRating: async (userId: string, itemId: string, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('deleteUserItemRating', 'userId', userId) + deleteUserItemRating: async (itemId: string, userId?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'itemId' is not null or undefined assertParamExists('deleteUserItemRating', 'itemId', itemId) - const localVarPath = `/Users/{userId}/Items/{itemId}/Rating` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))) + const localVarPath = `/UserItems/{itemId}/Rating` .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -67,6 +64,10 @@ export const UserLibraryApiAxiosParamCreator = function (configuration?: Configu // authentication CustomAuthentication required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (userId !== undefined) { + localVarQueryParameter['userId'] = userId; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -81,18 +82,15 @@ export const UserLibraryApiAxiosParamCreator = function (configuration?: Configu /** * * @summary Gets intros to play before the main media item plays. - * @param {string} userId User id. * @param {string} itemId Item id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getIntros: async (userId: string, itemId: string, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('getIntros', 'userId', userId) + getIntros: async (itemId: string, userId?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'itemId' is not null or undefined assertParamExists('getIntros', 'itemId', itemId) - const localVarPath = `/Users/{userId}/Items/{itemId}/Intros` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))) + const localVarPath = `/Items/{itemId}/Intros` .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -108,6 +106,10 @@ export const UserLibraryApiAxiosParamCreator = function (configuration?: Configu // authentication CustomAuthentication required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (userId !== undefined) { + localVarQueryParameter['userId'] = userId; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -122,18 +124,15 @@ export const UserLibraryApiAxiosParamCreator = function (configuration?: Configu /** * * @summary Gets an item from a user\'s library. - * @param {string} userId User id. * @param {string} itemId Item id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getItem: async (userId: string, itemId: string, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('getItem', 'userId', userId) + getItem: async (itemId: string, userId?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'itemId' is not null or undefined assertParamExists('getItem', 'itemId', itemId) - const localVarPath = `/Users/{userId}/Items/{itemId}` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))) + const localVarPath = `/Items/{itemId}` .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -149,6 +148,10 @@ export const UserLibraryApiAxiosParamCreator = function (configuration?: Configu // authentication CustomAuthentication required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (userId !== undefined) { + localVarQueryParameter['userId'] = userId; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -163,7 +166,7 @@ export const UserLibraryApiAxiosParamCreator = function (configuration?: Configu /** * * @summary Gets latest media. - * @param {string} userId User id. + * @param {string} [userId] User id. * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root. * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. * @param {Array} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. @@ -177,11 +180,8 @@ export const UserLibraryApiAxiosParamCreator = function (configuration?: Configu * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getLatestMedia: async (userId: string, parentId?: string, fields?: Array, includeItemTypes?: Array, isPlayed?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, enableUserData?: boolean, limit?: number, groupItems?: boolean, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('getLatestMedia', 'userId', userId) - const localVarPath = `/Users/{userId}/Items/Latest` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))); + getLatestMedia: async (userId?: string, parentId?: string, fields?: Array, includeItemTypes?: Array, isPlayed?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, enableUserData?: boolean, limit?: number, groupItems?: boolean, options: AxiosRequestConfig = {}): Promise => { + const localVarPath = `/Items/Latest`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -196,6 +196,10 @@ export const UserLibraryApiAxiosParamCreator = function (configuration?: Configu // authentication CustomAuthentication required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (userId !== undefined) { + localVarQueryParameter['userId'] = userId; + } + if (parentId !== undefined) { localVarQueryParameter['parentId'] = parentId; } @@ -250,18 +254,15 @@ export const UserLibraryApiAxiosParamCreator = function (configuration?: Configu /** * * @summary Gets local trailers for an item. - * @param {string} userId User id. * @param {string} itemId Item id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getLocalTrailers: async (userId: string, itemId: string, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('getLocalTrailers', 'userId', userId) + getLocalTrailers: async (itemId: string, userId?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'itemId' is not null or undefined assertParamExists('getLocalTrailers', 'itemId', itemId) - const localVarPath = `/Users/{userId}/Items/{itemId}/LocalTrailers` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))) + const localVarPath = `/Items/{itemId}/LocalTrailers` .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -277,6 +278,10 @@ export const UserLibraryApiAxiosParamCreator = function (configuration?: Configu // authentication CustomAuthentication required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (userId !== undefined) { + localVarQueryParameter['userId'] = userId; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -291,15 +296,12 @@ export const UserLibraryApiAxiosParamCreator = function (configuration?: Configu /** * * @summary Gets the root folder from a user\'s library. - * @param {string} userId User id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getRootFolder: async (userId: string, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('getRootFolder', 'userId', userId) - const localVarPath = `/Users/{userId}/Items/Root` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))); + getRootFolder: async (userId?: string, options: AxiosRequestConfig = {}): Promise => { + const localVarPath = `/Items/Root`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -314,6 +316,10 @@ export const UserLibraryApiAxiosParamCreator = function (configuration?: Configu // authentication CustomAuthentication required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (userId !== undefined) { + localVarQueryParameter['userId'] = userId; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -328,18 +334,15 @@ export const UserLibraryApiAxiosParamCreator = function (configuration?: Configu /** * * @summary Gets special features for an item. - * @param {string} userId User id. * @param {string} itemId Item id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getSpecialFeatures: async (userId: string, itemId: string, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('getSpecialFeatures', 'userId', userId) + getSpecialFeatures: async (itemId: string, userId?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'itemId' is not null or undefined assertParamExists('getSpecialFeatures', 'itemId', itemId) - const localVarPath = `/Users/{userId}/Items/{itemId}/SpecialFeatures` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))) + const localVarPath = `/Items/{itemId}/SpecialFeatures` .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -355,6 +358,10 @@ export const UserLibraryApiAxiosParamCreator = function (configuration?: Configu // authentication CustomAuthentication required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (userId !== undefined) { + localVarQueryParameter['userId'] = userId; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -369,18 +376,15 @@ export const UserLibraryApiAxiosParamCreator = function (configuration?: Configu /** * * @summary Marks an item as a favorite. - * @param {string} userId User id. * @param {string} itemId Item id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - markFavoriteItem: async (userId: string, itemId: string, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('markFavoriteItem', 'userId', userId) + markFavoriteItem: async (itemId: string, userId?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'itemId' is not null or undefined assertParamExists('markFavoriteItem', 'itemId', itemId) - const localVarPath = `/Users/{userId}/FavoriteItems/{itemId}` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))) + const localVarPath = `/UserFavoriteItems/{itemId}` .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -396,6 +400,10 @@ export const UserLibraryApiAxiosParamCreator = function (configuration?: Configu // authentication CustomAuthentication required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (userId !== undefined) { + localVarQueryParameter['userId'] = userId; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -410,18 +418,15 @@ export const UserLibraryApiAxiosParamCreator = function (configuration?: Configu /** * * @summary Unmarks item as a favorite. - * @param {string} userId User id. * @param {string} itemId Item id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - unmarkFavoriteItem: async (userId: string, itemId: string, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('unmarkFavoriteItem', 'userId', userId) + unmarkFavoriteItem: async (itemId: string, userId?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'itemId' is not null or undefined assertParamExists('unmarkFavoriteItem', 'itemId', itemId) - const localVarPath = `/Users/{userId}/FavoriteItems/{itemId}` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))) + const localVarPath = `/UserFavoriteItems/{itemId}` .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -437,6 +442,10 @@ export const UserLibraryApiAxiosParamCreator = function (configuration?: Configu // authentication CustomAuthentication required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (userId !== undefined) { + localVarQueryParameter['userId'] = userId; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -451,19 +460,16 @@ export const UserLibraryApiAxiosParamCreator = function (configuration?: Configu /** * * @summary Updates a user\'s rating for an item. - * @param {string} userId User id. * @param {string} itemId Item id. - * @param {boolean} [likes] Whether this M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRating(System.Guid,System.Guid,System.Nullable{System.Boolean}) is likes. + * @param {string} [userId] User id. + * @param {boolean} [likes] Whether this M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRating(System.Nullable{System.Guid},System.Guid,System.Nullable{System.Boolean}) is likes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateUserItemRating: async (userId: string, itemId: string, likes?: boolean, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('updateUserItemRating', 'userId', userId) + updateUserItemRating: async (itemId: string, userId?: string, likes?: boolean, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'itemId' is not null or undefined assertParamExists('updateUserItemRating', 'itemId', itemId) - const localVarPath = `/Users/{userId}/Items/{itemId}/Rating` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))) + const localVarPath = `/UserItems/{itemId}/Rating` .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -479,6 +485,10 @@ export const UserLibraryApiAxiosParamCreator = function (configuration?: Configu // authentication CustomAuthentication required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (userId !== undefined) { + localVarQueryParameter['userId'] = userId; + } + if (likes !== undefined) { localVarQueryParameter['likes'] = likes; } @@ -507,43 +517,43 @@ export const UserLibraryApiFp = function(configuration?: Configuration) { /** * * @summary Deletes a user\'s saved personal rating for an item. - * @param {string} userId User id. * @param {string} itemId Item id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async deleteUserItemRating(userId: string, itemId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteUserItemRating(userId, itemId, options); + async deleteUserItemRating(itemId: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteUserItemRating(itemId, userId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * * @summary Gets intros to play before the main media item plays. - * @param {string} userId User id. * @param {string} itemId Item id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getIntros(userId: string, itemId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getIntros(userId, itemId, options); + async getIntros(itemId: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getIntros(itemId, userId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * * @summary Gets an item from a user\'s library. - * @param {string} userId User id. * @param {string} itemId Item id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getItem(userId: string, itemId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getItem(userId, itemId, options); + async getItem(itemId: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getItem(itemId, userId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * * @summary Gets latest media. - * @param {string} userId User id. + * @param {string} [userId] User id. * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root. * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. * @param {Array} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. @@ -557,80 +567,80 @@ export const UserLibraryApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getLatestMedia(userId: string, parentId?: string, fields?: Array, includeItemTypes?: Array, isPlayed?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, enableUserData?: boolean, limit?: number, groupItems?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + async getLatestMedia(userId?: string, parentId?: string, fields?: Array, includeItemTypes?: Array, isPlayed?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, enableUserData?: boolean, limit?: number, groupItems?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getLatestMedia(userId, parentId, fields, includeItemTypes, isPlayed, enableImages, imageTypeLimit, enableImageTypes, enableUserData, limit, groupItems, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * * @summary Gets local trailers for an item. - * @param {string} userId User id. * @param {string} itemId Item id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getLocalTrailers(userId: string, itemId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getLocalTrailers(userId, itemId, options); + async getLocalTrailers(itemId: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getLocalTrailers(itemId, userId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * * @summary Gets the root folder from a user\'s library. - * @param {string} userId User id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getRootFolder(userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getRootFolder(userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getRootFolder(userId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * * @summary Gets special features for an item. - * @param {string} userId User id. * @param {string} itemId Item id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getSpecialFeatures(userId: string, itemId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSpecialFeatures(userId, itemId, options); + async getSpecialFeatures(itemId: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSpecialFeatures(itemId, userId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * * @summary Marks an item as a favorite. - * @param {string} userId User id. * @param {string} itemId Item id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async markFavoriteItem(userId: string, itemId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.markFavoriteItem(userId, itemId, options); + async markFavoriteItem(itemId: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.markFavoriteItem(itemId, userId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * * @summary Unmarks item as a favorite. - * @param {string} userId User id. * @param {string} itemId Item id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async unmarkFavoriteItem(userId: string, itemId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.unmarkFavoriteItem(userId, itemId, options); + async unmarkFavoriteItem(itemId: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.unmarkFavoriteItem(itemId, userId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * * @summary Updates a user\'s rating for an item. - * @param {string} userId User id. * @param {string} itemId Item id. - * @param {boolean} [likes] Whether this M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRating(System.Guid,System.Guid,System.Nullable{System.Boolean}) is likes. + * @param {string} [userId] User id. + * @param {boolean} [likes] Whether this M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRating(System.Nullable{System.Guid},System.Guid,System.Nullable{System.Boolean}) is likes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async updateUserItemRating(userId: string, itemId: string, likes?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateUserItemRating(userId, itemId, likes, options); + async updateUserItemRating(itemId: string, userId?: string, likes?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateUserItemRating(itemId, userId, likes, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, } @@ -646,40 +656,40 @@ export const UserLibraryApiFactory = function (configuration?: Configuration, ba /** * * @summary Deletes a user\'s saved personal rating for an item. - * @param {string} userId User id. * @param {string} itemId Item id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deleteUserItemRating(userId: string, itemId: string, options?: any): AxiosPromise { - return localVarFp.deleteUserItemRating(userId, itemId, options).then((request) => request(axios, basePath)); + deleteUserItemRating(itemId: string, userId?: string, options?: any): AxiosPromise { + return localVarFp.deleteUserItemRating(itemId, userId, options).then((request) => request(axios, basePath)); }, /** * * @summary Gets intros to play before the main media item plays. - * @param {string} userId User id. * @param {string} itemId Item id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getIntros(userId: string, itemId: string, options?: any): AxiosPromise { - return localVarFp.getIntros(userId, itemId, options).then((request) => request(axios, basePath)); + getIntros(itemId: string, userId?: string, options?: any): AxiosPromise { + return localVarFp.getIntros(itemId, userId, options).then((request) => request(axios, basePath)); }, /** * * @summary Gets an item from a user\'s library. - * @param {string} userId User id. * @param {string} itemId Item id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getItem(userId: string, itemId: string, options?: any): AxiosPromise { - return localVarFp.getItem(userId, itemId, options).then((request) => request(axios, basePath)); + getItem(itemId: string, userId?: string, options?: any): AxiosPromise { + return localVarFp.getItem(itemId, userId, options).then((request) => request(axios, basePath)); }, /** * * @summary Gets latest media. - * @param {string} userId User id. + * @param {string} [userId] User id. * @param {string} [parentId] Specify this to localize the search to a specific item or folder. Omit to use the root. * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. * @param {Array} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited. @@ -693,74 +703,74 @@ export const UserLibraryApiFactory = function (configuration?: Configuration, ba * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getLatestMedia(userId: string, parentId?: string, fields?: Array, includeItemTypes?: Array, isPlayed?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, enableUserData?: boolean, limit?: number, groupItems?: boolean, options?: any): AxiosPromise> { + getLatestMedia(userId?: string, parentId?: string, fields?: Array, includeItemTypes?: Array, isPlayed?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, enableUserData?: boolean, limit?: number, groupItems?: boolean, options?: any): AxiosPromise> { return localVarFp.getLatestMedia(userId, parentId, fields, includeItemTypes, isPlayed, enableImages, imageTypeLimit, enableImageTypes, enableUserData, limit, groupItems, options).then((request) => request(axios, basePath)); }, /** * * @summary Gets local trailers for an item. - * @param {string} userId User id. * @param {string} itemId Item id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getLocalTrailers(userId: string, itemId: string, options?: any): AxiosPromise> { - return localVarFp.getLocalTrailers(userId, itemId, options).then((request) => request(axios, basePath)); + getLocalTrailers(itemId: string, userId?: string, options?: any): AxiosPromise> { + return localVarFp.getLocalTrailers(itemId, userId, options).then((request) => request(axios, basePath)); }, /** * * @summary Gets the root folder from a user\'s library. - * @param {string} userId User id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getRootFolder(userId: string, options?: any): AxiosPromise { + getRootFolder(userId?: string, options?: any): AxiosPromise { return localVarFp.getRootFolder(userId, options).then((request) => request(axios, basePath)); }, /** * * @summary Gets special features for an item. - * @param {string} userId User id. * @param {string} itemId Item id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getSpecialFeatures(userId: string, itemId: string, options?: any): AxiosPromise> { - return localVarFp.getSpecialFeatures(userId, itemId, options).then((request) => request(axios, basePath)); + getSpecialFeatures(itemId: string, userId?: string, options?: any): AxiosPromise> { + return localVarFp.getSpecialFeatures(itemId, userId, options).then((request) => request(axios, basePath)); }, /** * * @summary Marks an item as a favorite. - * @param {string} userId User id. * @param {string} itemId Item id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - markFavoriteItem(userId: string, itemId: string, options?: any): AxiosPromise { - return localVarFp.markFavoriteItem(userId, itemId, options).then((request) => request(axios, basePath)); + markFavoriteItem(itemId: string, userId?: string, options?: any): AxiosPromise { + return localVarFp.markFavoriteItem(itemId, userId, options).then((request) => request(axios, basePath)); }, /** * * @summary Unmarks item as a favorite. - * @param {string} userId User id. * @param {string} itemId Item id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - unmarkFavoriteItem(userId: string, itemId: string, options?: any): AxiosPromise { - return localVarFp.unmarkFavoriteItem(userId, itemId, options).then((request) => request(axios, basePath)); + unmarkFavoriteItem(itemId: string, userId?: string, options?: any): AxiosPromise { + return localVarFp.unmarkFavoriteItem(itemId, userId, options).then((request) => request(axios, basePath)); }, /** * * @summary Updates a user\'s rating for an item. - * @param {string} userId User id. * @param {string} itemId Item id. - * @param {boolean} [likes] Whether this M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRating(System.Guid,System.Guid,System.Nullable{System.Boolean}) is likes. + * @param {string} [userId] User id. + * @param {boolean} [likes] Whether this M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRating(System.Nullable{System.Guid},System.Guid,System.Nullable{System.Boolean}) is likes. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateUserItemRating(userId: string, itemId: string, likes?: boolean, options?: any): AxiosPromise { - return localVarFp.updateUserItemRating(userId, itemId, likes, options).then((request) => request(axios, basePath)); + updateUserItemRating(itemId: string, userId?: string, likes?: boolean, options?: any): AxiosPromise { + return localVarFp.updateUserItemRating(itemId, userId, likes, options).then((request) => request(axios, basePath)); }, }; }; @@ -771,19 +781,19 @@ export const UserLibraryApiFactory = function (configuration?: Configuration, ba * @interface UserLibraryApiDeleteUserItemRatingRequest */ export interface UserLibraryApiDeleteUserItemRatingRequest { - /** - * User id. - * @type {string} - * @memberof UserLibraryApiDeleteUserItemRating - */ - readonly userId: string - /** * Item id. * @type {string} * @memberof UserLibraryApiDeleteUserItemRating */ readonly itemId: string + + /** + * User id. + * @type {string} + * @memberof UserLibraryApiDeleteUserItemRating + */ + readonly userId?: string } /** @@ -792,19 +802,19 @@ export interface UserLibraryApiDeleteUserItemRatingRequest { * @interface UserLibraryApiGetIntrosRequest */ export interface UserLibraryApiGetIntrosRequest { - /** - * User id. - * @type {string} - * @memberof UserLibraryApiGetIntros - */ - readonly userId: string - /** * Item id. * @type {string} * @memberof UserLibraryApiGetIntros */ readonly itemId: string + + /** + * User id. + * @type {string} + * @memberof UserLibraryApiGetIntros + */ + readonly userId?: string } /** @@ -813,19 +823,19 @@ export interface UserLibraryApiGetIntrosRequest { * @interface UserLibraryApiGetItemRequest */ export interface UserLibraryApiGetItemRequest { - /** - * User id. - * @type {string} - * @memberof UserLibraryApiGetItem - */ - readonly userId: string - /** * Item id. * @type {string} * @memberof UserLibraryApiGetItem */ readonly itemId: string + + /** + * User id. + * @type {string} + * @memberof UserLibraryApiGetItem + */ + readonly userId?: string } /** @@ -839,7 +849,7 @@ export interface UserLibraryApiGetLatestMediaRequest { * @type {string} * @memberof UserLibraryApiGetLatestMedia */ - readonly userId: string + readonly userId?: string /** * Specify this to localize the search to a specific item or folder. Omit to use the root. @@ -918,19 +928,19 @@ export interface UserLibraryApiGetLatestMediaRequest { * @interface UserLibraryApiGetLocalTrailersRequest */ export interface UserLibraryApiGetLocalTrailersRequest { - /** - * User id. - * @type {string} - * @memberof UserLibraryApiGetLocalTrailers - */ - readonly userId: string - /** * Item id. * @type {string} * @memberof UserLibraryApiGetLocalTrailers */ readonly itemId: string + + /** + * User id. + * @type {string} + * @memberof UserLibraryApiGetLocalTrailers + */ + readonly userId?: string } /** @@ -944,7 +954,7 @@ export interface UserLibraryApiGetRootFolderRequest { * @type {string} * @memberof UserLibraryApiGetRootFolder */ - readonly userId: string + readonly userId?: string } /** @@ -953,19 +963,19 @@ export interface UserLibraryApiGetRootFolderRequest { * @interface UserLibraryApiGetSpecialFeaturesRequest */ export interface UserLibraryApiGetSpecialFeaturesRequest { - /** - * User id. - * @type {string} - * @memberof UserLibraryApiGetSpecialFeatures - */ - readonly userId: string - /** * Item id. * @type {string} * @memberof UserLibraryApiGetSpecialFeatures */ readonly itemId: string + + /** + * User id. + * @type {string} + * @memberof UserLibraryApiGetSpecialFeatures + */ + readonly userId?: string } /** @@ -974,19 +984,19 @@ export interface UserLibraryApiGetSpecialFeaturesRequest { * @interface UserLibraryApiMarkFavoriteItemRequest */ export interface UserLibraryApiMarkFavoriteItemRequest { - /** - * User id. - * @type {string} - * @memberof UserLibraryApiMarkFavoriteItem - */ - readonly userId: string - /** * Item id. * @type {string} * @memberof UserLibraryApiMarkFavoriteItem */ readonly itemId: string + + /** + * User id. + * @type {string} + * @memberof UserLibraryApiMarkFavoriteItem + */ + readonly userId?: string } /** @@ -995,19 +1005,19 @@ export interface UserLibraryApiMarkFavoriteItemRequest { * @interface UserLibraryApiUnmarkFavoriteItemRequest */ export interface UserLibraryApiUnmarkFavoriteItemRequest { - /** - * User id. - * @type {string} - * @memberof UserLibraryApiUnmarkFavoriteItem - */ - readonly userId: string - /** * Item id. * @type {string} * @memberof UserLibraryApiUnmarkFavoriteItem */ readonly itemId: string + + /** + * User id. + * @type {string} + * @memberof UserLibraryApiUnmarkFavoriteItem + */ + readonly userId?: string } /** @@ -1016,13 +1026,6 @@ export interface UserLibraryApiUnmarkFavoriteItemRequest { * @interface UserLibraryApiUpdateUserItemRatingRequest */ export interface UserLibraryApiUpdateUserItemRatingRequest { - /** - * User id. - * @type {string} - * @memberof UserLibraryApiUpdateUserItemRating - */ - readonly userId: string - /** * Item id. * @type {string} @@ -1031,7 +1034,14 @@ export interface UserLibraryApiUpdateUserItemRatingRequest { readonly itemId: string /** - * Whether this M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRating(System.Guid,System.Guid,System.Nullable{System.Boolean}) is likes. + * User id. + * @type {string} + * @memberof UserLibraryApiUpdateUserItemRating + */ + readonly userId?: string + + /** + * Whether this M:Jellyfin.Api.Controllers.UserLibraryController.UpdateUserItemRating(System.Nullable{System.Guid},System.Guid,System.Nullable{System.Boolean}) is likes. * @type {boolean} * @memberof UserLibraryApiUpdateUserItemRating */ @@ -1054,7 +1064,7 @@ export class UserLibraryApi extends BaseAPI { * @memberof UserLibraryApi */ public deleteUserItemRating(requestParameters: UserLibraryApiDeleteUserItemRatingRequest, options?: AxiosRequestConfig) { - return UserLibraryApiFp(this.configuration).deleteUserItemRating(requestParameters.userId, requestParameters.itemId, options).then((request) => request(this.axios, this.basePath)); + return UserLibraryApiFp(this.configuration).deleteUserItemRating(requestParameters.itemId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath)); } /** @@ -1066,7 +1076,7 @@ export class UserLibraryApi extends BaseAPI { * @memberof UserLibraryApi */ public getIntros(requestParameters: UserLibraryApiGetIntrosRequest, options?: AxiosRequestConfig) { - return UserLibraryApiFp(this.configuration).getIntros(requestParameters.userId, requestParameters.itemId, options).then((request) => request(this.axios, this.basePath)); + return UserLibraryApiFp(this.configuration).getIntros(requestParameters.itemId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath)); } /** @@ -1078,7 +1088,7 @@ export class UserLibraryApi extends BaseAPI { * @memberof UserLibraryApi */ public getItem(requestParameters: UserLibraryApiGetItemRequest, options?: AxiosRequestConfig) { - return UserLibraryApiFp(this.configuration).getItem(requestParameters.userId, requestParameters.itemId, options).then((request) => request(this.axios, this.basePath)); + return UserLibraryApiFp(this.configuration).getItem(requestParameters.itemId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath)); } /** @@ -1089,7 +1099,7 @@ export class UserLibraryApi extends BaseAPI { * @throws {RequiredError} * @memberof UserLibraryApi */ - public getLatestMedia(requestParameters: UserLibraryApiGetLatestMediaRequest, options?: AxiosRequestConfig) { + public getLatestMedia(requestParameters: UserLibraryApiGetLatestMediaRequest = {}, options?: AxiosRequestConfig) { return UserLibraryApiFp(this.configuration).getLatestMedia(requestParameters.userId, requestParameters.parentId, requestParameters.fields, requestParameters.includeItemTypes, requestParameters.isPlayed, requestParameters.enableImages, requestParameters.imageTypeLimit, requestParameters.enableImageTypes, requestParameters.enableUserData, requestParameters.limit, requestParameters.groupItems, options).then((request) => request(this.axios, this.basePath)); } @@ -1102,7 +1112,7 @@ export class UserLibraryApi extends BaseAPI { * @memberof UserLibraryApi */ public getLocalTrailers(requestParameters: UserLibraryApiGetLocalTrailersRequest, options?: AxiosRequestConfig) { - return UserLibraryApiFp(this.configuration).getLocalTrailers(requestParameters.userId, requestParameters.itemId, options).then((request) => request(this.axios, this.basePath)); + return UserLibraryApiFp(this.configuration).getLocalTrailers(requestParameters.itemId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath)); } /** @@ -1113,7 +1123,7 @@ export class UserLibraryApi extends BaseAPI { * @throws {RequiredError} * @memberof UserLibraryApi */ - public getRootFolder(requestParameters: UserLibraryApiGetRootFolderRequest, options?: AxiosRequestConfig) { + public getRootFolder(requestParameters: UserLibraryApiGetRootFolderRequest = {}, options?: AxiosRequestConfig) { return UserLibraryApiFp(this.configuration).getRootFolder(requestParameters.userId, options).then((request) => request(this.axios, this.basePath)); } @@ -1126,7 +1136,7 @@ export class UserLibraryApi extends BaseAPI { * @memberof UserLibraryApi */ public getSpecialFeatures(requestParameters: UserLibraryApiGetSpecialFeaturesRequest, options?: AxiosRequestConfig) { - return UserLibraryApiFp(this.configuration).getSpecialFeatures(requestParameters.userId, requestParameters.itemId, options).then((request) => request(this.axios, this.basePath)); + return UserLibraryApiFp(this.configuration).getSpecialFeatures(requestParameters.itemId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath)); } /** @@ -1138,7 +1148,7 @@ export class UserLibraryApi extends BaseAPI { * @memberof UserLibraryApi */ public markFavoriteItem(requestParameters: UserLibraryApiMarkFavoriteItemRequest, options?: AxiosRequestConfig) { - return UserLibraryApiFp(this.configuration).markFavoriteItem(requestParameters.userId, requestParameters.itemId, options).then((request) => request(this.axios, this.basePath)); + return UserLibraryApiFp(this.configuration).markFavoriteItem(requestParameters.itemId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath)); } /** @@ -1150,7 +1160,7 @@ export class UserLibraryApi extends BaseAPI { * @memberof UserLibraryApi */ public unmarkFavoriteItem(requestParameters: UserLibraryApiUnmarkFavoriteItemRequest, options?: AxiosRequestConfig) { - return UserLibraryApiFp(this.configuration).unmarkFavoriteItem(requestParameters.userId, requestParameters.itemId, options).then((request) => request(this.axios, this.basePath)); + return UserLibraryApiFp(this.configuration).unmarkFavoriteItem(requestParameters.itemId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath)); } /** @@ -1162,6 +1172,6 @@ export class UserLibraryApi extends BaseAPI { * @memberof UserLibraryApi */ public updateUserItemRating(requestParameters: UserLibraryApiUpdateUserItemRatingRequest, options?: AxiosRequestConfig) { - return UserLibraryApiFp(this.configuration).updateUserItemRating(requestParameters.userId, requestParameters.itemId, requestParameters.likes, options).then((request) => request(this.axios, this.basePath)); + return UserLibraryApiFp(this.configuration).updateUserItemRating(requestParameters.itemId, requestParameters.userId, requestParameters.likes, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/generated-client/api/user-views-api.ts b/src/generated-client/api/user-views-api.ts index b7f70d13..3f63c2d3 100644 --- a/src/generated-client/api/user-views-api.ts +++ b/src/generated-client/api/user-views-api.ts @@ -22,6 +22,8 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr // @ts-ignore import { BaseItemDtoQueryResult } from '../models'; // @ts-ignore +import { CollectionType } from '../models'; +// @ts-ignore import { ProblemDetails } from '../models'; // @ts-ignore import { SpecialViewOptionDto } from '../models'; @@ -34,15 +36,12 @@ export const UserViewsApiAxiosParamCreator = function (configuration?: Configura /** * * @summary Get user view grouping options. - * @param {string} userId User id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getGroupingOptions: async (userId: string, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('getGroupingOptions', 'userId', userId) - const localVarPath = `/Users/{userId}/GroupingOptions` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))); + getGroupingOptions: async (userId?: string, options: AxiosRequestConfig = {}): Promise => { + const localVarPath = `/UserViews/GroupingOptions`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -57,6 +56,10 @@ export const UserViewsApiAxiosParamCreator = function (configuration?: Configura // authentication CustomAuthentication required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (userId !== undefined) { + localVarQueryParameter['userId'] = userId; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -71,18 +74,15 @@ export const UserViewsApiAxiosParamCreator = function (configuration?: Configura /** * * @summary Get user views. - * @param {string} userId User id. + * @param {string} [userId] User id. * @param {boolean} [includeExternalContent] Whether or not to include external views such as channels or live tv. - * @param {Array} [presetViews] Preset views. + * @param {Array} [presetViews] Preset views. * @param {boolean} [includeHidden] Whether or not to include hidden content. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getUserViews: async (userId: string, includeExternalContent?: boolean, presetViews?: Array, includeHidden?: boolean, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'userId' is not null or undefined - assertParamExists('getUserViews', 'userId', userId) - const localVarPath = `/Users/{userId}/Views` - .replace(`{${"userId"}}`, encodeURIComponent(String(userId))); + getUserViews: async (userId?: string, includeExternalContent?: boolean, presetViews?: Array, includeHidden?: boolean, options: AxiosRequestConfig = {}): Promise => { + const localVarPath = `/UserViews`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -97,6 +97,10 @@ export const UserViewsApiAxiosParamCreator = function (configuration?: Configura // authentication CustomAuthentication required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (userId !== undefined) { + localVarQueryParameter['userId'] = userId; + } + if (includeExternalContent !== undefined) { localVarQueryParameter['includeExternalContent'] = includeExternalContent; } @@ -133,25 +137,25 @@ export const UserViewsApiFp = function(configuration?: Configuration) { /** * * @summary Get user view grouping options. - * @param {string} userId User id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getGroupingOptions(userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + async getGroupingOptions(userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getGroupingOptions(userId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * * @summary Get user views. - * @param {string} userId User id. + * @param {string} [userId] User id. * @param {boolean} [includeExternalContent] Whether or not to include external views such as channels or live tv. - * @param {Array} [presetViews] Preset views. + * @param {Array} [presetViews] Preset views. * @param {boolean} [includeHidden] Whether or not to include hidden content. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getUserViews(userId: string, includeExternalContent?: boolean, presetViews?: Array, includeHidden?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getUserViews(userId?: string, includeExternalContent?: boolean, presetViews?: Array, includeHidden?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getUserViews(userId, includeExternalContent, presetViews, includeHidden, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -168,24 +172,24 @@ export const UserViewsApiFactory = function (configuration?: Configuration, base /** * * @summary Get user view grouping options. - * @param {string} userId User id. + * @param {string} [userId] User id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getGroupingOptions(userId: string, options?: any): AxiosPromise> { + getGroupingOptions(userId?: string, options?: any): AxiosPromise> { return localVarFp.getGroupingOptions(userId, options).then((request) => request(axios, basePath)); }, /** * * @summary Get user views. - * @param {string} userId User id. + * @param {string} [userId] User id. * @param {boolean} [includeExternalContent] Whether or not to include external views such as channels or live tv. - * @param {Array} [presetViews] Preset views. + * @param {Array} [presetViews] Preset views. * @param {boolean} [includeHidden] Whether or not to include hidden content. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getUserViews(userId: string, includeExternalContent?: boolean, presetViews?: Array, includeHidden?: boolean, options?: any): AxiosPromise { + getUserViews(userId?: string, includeExternalContent?: boolean, presetViews?: Array, includeHidden?: boolean, options?: any): AxiosPromise { return localVarFp.getUserViews(userId, includeExternalContent, presetViews, includeHidden, options).then((request) => request(axios, basePath)); }, }; @@ -202,7 +206,7 @@ export interface UserViewsApiGetGroupingOptionsRequest { * @type {string} * @memberof UserViewsApiGetGroupingOptions */ - readonly userId: string + readonly userId?: string } /** @@ -216,7 +220,7 @@ export interface UserViewsApiGetUserViewsRequest { * @type {string} * @memberof UserViewsApiGetUserViews */ - readonly userId: string + readonly userId?: string /** * Whether or not to include external views such as channels or live tv. @@ -227,10 +231,10 @@ export interface UserViewsApiGetUserViewsRequest { /** * Preset views. - * @type {Array} + * @type {Array} * @memberof UserViewsApiGetUserViews */ - readonly presetViews?: Array + readonly presetViews?: Array /** * Whether or not to include hidden content. @@ -255,7 +259,7 @@ export class UserViewsApi extends BaseAPI { * @throws {RequiredError} * @memberof UserViewsApi */ - public getGroupingOptions(requestParameters: UserViewsApiGetGroupingOptionsRequest, options?: AxiosRequestConfig) { + public getGroupingOptions(requestParameters: UserViewsApiGetGroupingOptionsRequest = {}, options?: AxiosRequestConfig) { return UserViewsApiFp(this.configuration).getGroupingOptions(requestParameters.userId, options).then((request) => request(this.axios, this.basePath)); } @@ -267,7 +271,7 @@ export class UserViewsApi extends BaseAPI { * @throws {RequiredError} * @memberof UserViewsApi */ - public getUserViews(requestParameters: UserViewsApiGetUserViewsRequest, options?: AxiosRequestConfig) { + public getUserViews(requestParameters: UserViewsApiGetUserViewsRequest = {}, options?: AxiosRequestConfig) { return UserViewsApiFp(this.configuration).getUserViews(requestParameters.userId, requestParameters.includeExternalContent, requestParameters.presetViews, requestParameters.includeHidden, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/generated-client/api/years-api.ts b/src/generated-client/api/years-api.ts index 4be6cb9d..03022bd8 100644 --- a/src/generated-client/api/years-api.ts +++ b/src/generated-client/api/years-api.ts @@ -30,6 +30,10 @@ import { ImageType } from '../models'; // @ts-ignore import { ItemFields } from '../models'; // @ts-ignore +import { ItemSortBy } from '../models'; +// @ts-ignore +import { MediaType } from '../models'; +// @ts-ignore import { ProblemDetails } from '../models'; // @ts-ignore import { SortOrder } from '../models'; @@ -91,8 +95,8 @@ export const YearsApiAxiosParamCreator = function (configuration?: Configuration * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. * @param {Array} [excludeItemTypes] Optional. If specified, results will be excluded based on item type. This allows multiple, comma delimited. * @param {Array} [includeItemTypes] Optional. If specified, results will be included based on item type. This allows multiple, comma delimited. - * @param {Array} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited. - * @param {Array} [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. + * @param {Array} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited. + * @param {Array} [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. * @param {boolean} [enableUserData] Optional. Include user data. * @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type. * @param {Array} [enableImageTypes] Optional. The image types to include in the output. @@ -102,7 +106,7 @@ export const YearsApiAxiosParamCreator = function (configuration?: Configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getYears: async (startIndex?: number, limit?: number, sortOrder?: Array, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, mediaTypes?: Array, sortBy?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, userId?: string, recursive?: boolean, enableImages?: boolean, options: AxiosRequestConfig = {}): Promise => { + getYears: async (startIndex?: number, limit?: number, sortOrder?: Array, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, mediaTypes?: Array, sortBy?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, userId?: string, recursive?: boolean, enableImages?: boolean, options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/Years`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -221,8 +225,8 @@ export const YearsApiFp = function(configuration?: Configuration) { * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. * @param {Array} [excludeItemTypes] Optional. If specified, results will be excluded based on item type. This allows multiple, comma delimited. * @param {Array} [includeItemTypes] Optional. If specified, results will be included based on item type. This allows multiple, comma delimited. - * @param {Array} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited. - * @param {Array} [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. + * @param {Array} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited. + * @param {Array} [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. * @param {boolean} [enableUserData] Optional. Include user data. * @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type. * @param {Array} [enableImageTypes] Optional. The image types to include in the output. @@ -232,7 +236,7 @@ export const YearsApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getYears(startIndex?: number, limit?: number, sortOrder?: Array, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, mediaTypes?: Array, sortBy?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, userId?: string, recursive?: boolean, enableImages?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async getYears(startIndex?: number, limit?: number, sortOrder?: Array, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, mediaTypes?: Array, sortBy?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, userId?: string, recursive?: boolean, enableImages?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getYears(startIndex, limit, sortOrder, parentId, fields, excludeItemTypes, includeItemTypes, mediaTypes, sortBy, enableUserData, imageTypeLimit, enableImageTypes, userId, recursive, enableImages, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -267,8 +271,8 @@ export const YearsApiFactory = function (configuration?: Configuration, basePath * @param {Array} [fields] Optional. Specify additional fields of information to return in the output. * @param {Array} [excludeItemTypes] Optional. If specified, results will be excluded based on item type. This allows multiple, comma delimited. * @param {Array} [includeItemTypes] Optional. If specified, results will be included based on item type. This allows multiple, comma delimited. - * @param {Array} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited. - * @param {Array} [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. + * @param {Array} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited. + * @param {Array} [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. * @param {boolean} [enableUserData] Optional. Include user data. * @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type. * @param {Array} [enableImageTypes] Optional. The image types to include in the output. @@ -278,7 +282,7 @@ export const YearsApiFactory = function (configuration?: Configuration, basePath * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getYears(startIndex?: number, limit?: number, sortOrder?: Array, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, mediaTypes?: Array, sortBy?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, userId?: string, recursive?: boolean, enableImages?: boolean, options?: any): AxiosPromise { + getYears(startIndex?: number, limit?: number, sortOrder?: Array, parentId?: string, fields?: Array, excludeItemTypes?: Array, includeItemTypes?: Array, mediaTypes?: Array, sortBy?: Array, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array, userId?: string, recursive?: boolean, enableImages?: boolean, options?: any): AxiosPromise { return localVarFp.getYears(startIndex, limit, sortOrder, parentId, fields, excludeItemTypes, includeItemTypes, mediaTypes, sortBy, enableUserData, imageTypeLimit, enableImageTypes, userId, recursive, enableImages, options).then((request) => request(axios, basePath)); }, }; @@ -362,17 +366,17 @@ export interface YearsApiGetYearsRequest { /** * Optional. Filter by MediaType. Allows multiple, comma delimited. - * @type {Array} + * @type {Array} * @memberof YearsApiGetYears */ - readonly mediaTypes?: Array + readonly mediaTypes?: Array /** * 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. - * @type {Array} + * @type {Array} * @memberof YearsApiGetYears */ - readonly sortBy?: Array + readonly sortBy?: Array /** * Optional. Include user data. diff --git a/src/generated-client/models/activity-log-entry-message.ts b/src/generated-client/models/activity-log-entry-message.ts new file mode 100644 index 00000000..fe9ac528 --- /dev/null +++ b/src/generated-client/models/activity-log-entry-message.ts @@ -0,0 +1,43 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { ActivityLogEntry } from './activity-log-entry'; +import { SessionMessageType } from './session-message-type'; + +/** + * Activity log created message. + * @export + * @interface ActivityLogEntryMessage + */ +export interface ActivityLogEntryMessage { + /** + * Gets or sets the data. + * @type {Array} + * @memberof ActivityLogEntryMessage + */ + 'Data'?: Array | null; + /** + * Gets or sets the message id. + * @type {string} + * @memberof ActivityLogEntryMessage + */ + 'MessageId'?: string; + /** + * + * @type {SessionMessageType} + * @memberof ActivityLogEntryMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/activity-log-entry-start-message.ts b/src/generated-client/models/activity-log-entry-start-message.ts new file mode 100644 index 00000000..33743eef --- /dev/null +++ b/src/generated-client/models/activity-log-entry-start-message.ts @@ -0,0 +1,36 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { SessionMessageType } from './session-message-type'; + +/** + * Activity log entry start message. Data is the timing data encoded as \"$initialDelay,$interval\" in ms. + * @export + * @interface ActivityLogEntryStartMessage + */ +export interface ActivityLogEntryStartMessage { + /** + * Gets or sets the data. + * @type {string} + * @memberof ActivityLogEntryStartMessage + */ + 'Data'?: string | null; + /** + * + * @type {SessionMessageType} + * @memberof ActivityLogEntryStartMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/activity-log-entry-stop-message.ts b/src/generated-client/models/activity-log-entry-stop-message.ts new file mode 100644 index 00000000..57b76a1f --- /dev/null +++ b/src/generated-client/models/activity-log-entry-stop-message.ts @@ -0,0 +1,30 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { SessionMessageType } from './session-message-type'; + +/** + * Activity log entry stop message. + * @export + * @interface ActivityLogEntryStopMessage + */ +export interface ActivityLogEntryStopMessage { + /** + * + * @type {SessionMessageType} + * @memberof ActivityLogEntryStopMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/audio-spatial-format.ts b/src/generated-client/models/audio-spatial-format.ts new file mode 100644 index 00000000..839484ca --- /dev/null +++ b/src/generated-client/models/audio-spatial-format.ts @@ -0,0 +1,31 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + + +/** + * An enum representing formats of spatial audio. + * @export + * @enum {string} + */ + +export const AudioSpatialFormat = { + None: 'None', + DolbyAtmos: 'DolbyAtmos', + Dtsx: 'DTSX' +} as const; + +export type AudioSpatialFormat = typeof AudioSpatialFormat[keyof typeof AudioSpatialFormat]; + + + diff --git a/src/generated-client/models/authenticate-user-by-name.ts b/src/generated-client/models/authenticate-user-by-name.ts index 0d4e4197..d134ac5d 100644 --- a/src/generated-client/models/authenticate-user-by-name.ts +++ b/src/generated-client/models/authenticate-user-by-name.ts @@ -31,12 +31,5 @@ export interface AuthenticateUserByName { * @memberof AuthenticateUserByName */ 'Pw'?: string | null; - /** - * Gets or sets the sha1-hashed password. - * @type {string} - * @memberof AuthenticateUserByName - * @deprecated - */ - 'Password'?: string | null; } diff --git a/src/generated-client/models/base-item-dto.ts b/src/generated-client/models/base-item-dto.ts index e701a58a..fa14d98b 100644 --- a/src/generated-client/models/base-item-dto.ts +++ b/src/generated-client/models/base-item-dto.ts @@ -17,18 +17,22 @@ import { BaseItemKind } from './base-item-kind'; import { BaseItemPerson } from './base-item-person'; import { ChannelType } from './channel-type'; import { ChapterInfo } from './chapter-info'; +import { CollectionType } from './collection-type'; import { DayOfWeek } from './day-of-week'; import { ExternalUrl } from './external-url'; +import { ExtraType } from './extra-type'; import { ImageOrientation } from './image-orientation'; import { IsoType } from './iso-type'; import { LocationType } from './location-type'; import { MediaSourceInfo } from './media-source-info'; import { MediaStream } from './media-stream'; +import { MediaType } from './media-type'; import { MediaUrl } from './media-url'; import { MetadataField } from './metadata-field'; import { NameGuidPair } from './name-guid-pair'; import { PlayAccess } from './play-access'; import { ProgramAudio } from './program-audio'; +import { TrickplayInfo } from './trickplay-info'; import { UserItemDataDto } from './user-item-data-dto'; import { Video3DFormat } from './video3-dformat'; import { VideoType } from './video-type'; @@ -95,10 +99,10 @@ export interface BaseItemDto { 'DateLastMediaAdded'?: string | null; /** * - * @type {string} + * @type {ExtraType} * @memberof BaseItemDto */ - 'ExtraType'?: string | null; + 'ExtraType'?: ExtraType; /** * * @type {number} @@ -129,6 +133,12 @@ export interface BaseItemDto { * @memberof BaseItemDto */ 'CanDownload'?: boolean | null; + /** + * + * @type {boolean} + * @memberof BaseItemDto + */ + 'HasLyrics'?: boolean | null; /** * * @type {boolean} @@ -147,12 +157,6 @@ export interface BaseItemDto { * @memberof BaseItemDto */ 'PreferredMetadataCountryCode'?: string | null; - /** - * Gets or sets a value indicating whether [supports synchronize]. - * @type {boolean} - * @memberof BaseItemDto - */ - 'SupportsSync'?: boolean | null; /** * * @type {string} @@ -388,13 +392,13 @@ export interface BaseItemDto { */ 'GenreItems'?: Array | null; /** - * Gets or sets wether the item has a logo, this will hold the Id of the Parent that has one. + * Gets or sets whether the item has a logo, this will hold the Id of the Parent that has one. * @type {string} * @memberof BaseItemDto */ 'ParentLogoItemId'?: string | null; /** - * Gets or sets wether the item has any backdrops, this will hold the Id of the Parent that has one. + * Gets or sets whether the item has any backdrops, this will hold the Id of the Parent that has one. * @type {string} * @memberof BaseItemDto */ @@ -508,11 +512,11 @@ export interface BaseItemDto { */ 'Album'?: string | null; /** - * Gets or sets the type of the collection. - * @type {string} + * + * @type {CollectionType} * @memberof BaseItemDto */ - 'CollectionType'?: string | null; + 'CollectionType'?: CollectionType; /** * Gets or sets the display order. * @type {string} @@ -604,7 +608,7 @@ export interface BaseItemDto { */ 'ParentLogoImageTag'?: string | null; /** - * Gets or sets wether the item has fan art, this will hold the Id of the Parent that has one. + * Gets or sets whether the item has fan art, this will hold the Id of the Parent that has one. * @type {string} * @memberof BaseItemDto */ @@ -663,6 +667,12 @@ export interface BaseItemDto { * @memberof BaseItemDto */ 'Chapters'?: Array | null; + /** + * Gets or sets the trickplay manifest. + * @type {{ [key: string]: { [key: string]: TrickplayInfo; }; }} + * @memberof BaseItemDto + */ + 'Trickplay'?: { [key: string]: { [key: string]: TrickplayInfo; }; } | null; /** * * @type {LocationType} @@ -676,11 +686,11 @@ export interface BaseItemDto { */ 'IsoType'?: IsoType; /** - * Gets or sets the type of the media. - * @type {string} + * + * @type {MediaType} * @memberof BaseItemDto */ - 'MediaType'?: string | null; + 'MediaType'?: MediaType; /** * Gets or sets the end date. * @type {string} @@ -939,6 +949,12 @@ export interface BaseItemDto { * @memberof BaseItemDto */ 'TimerId'?: string | null; + /** + * Gets or sets the gain required for audio normalization. + * @type {number} + * @memberof BaseItemDto + */ + 'NormalizationGain'?: number | null; /** * * @type {BaseItemDto} diff --git a/src/generated-client/models/base-item-person.ts b/src/generated-client/models/base-item-person.ts index 1d6914c8..8de47057 100644 --- a/src/generated-client/models/base-item-person.ts +++ b/src/generated-client/models/base-item-person.ts @@ -13,6 +13,7 @@ import { BaseItemPersonImageBlurHashes } from './base-item-person-image-blur-hashes'; +import { PersonKind } from './person-kind'; /** * This is used by the api to get information about a Person within a BaseItem. @@ -39,11 +40,11 @@ export interface BaseItemPerson { */ 'Role'?: string | null; /** - * Gets or sets the type. - * @type {string} + * + * @type {PersonKind} * @memberof BaseItemPerson */ - 'Type'?: string | null; + 'Type'?: PersonKind; /** * Gets or sets the primary image tag. * @type {string} diff --git a/src/generated-client/models/cast-receiver-application.ts b/src/generated-client/models/cast-receiver-application.ts new file mode 100644 index 00000000..717cb74d --- /dev/null +++ b/src/generated-client/models/cast-receiver-application.ts @@ -0,0 +1,35 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + + +/** + * The cast receiver application model. + * @export + * @interface CastReceiverApplication + */ +export interface CastReceiverApplication { + /** + * Gets or sets the cast receiver application id. + * @type {string} + * @memberof CastReceiverApplication + */ + 'Id'?: string; + /** + * Gets or sets the cast receiver application name. + * @type {string} + * @memberof CastReceiverApplication + */ + 'Name'?: string; +} + diff --git a/src/generated-client/models/client-capabilities-dto.ts b/src/generated-client/models/client-capabilities-dto.ts index 9452d4d7..674fde84 100644 --- a/src/generated-client/models/client-capabilities-dto.ts +++ b/src/generated-client/models/client-capabilities-dto.ts @@ -14,6 +14,7 @@ import { DeviceProfile } from './device-profile'; import { GeneralCommandType } from './general-command-type'; +import { MediaType } from './media-type'; /** * Client capabilities dto. @@ -23,10 +24,10 @@ import { GeneralCommandType } from './general-command-type'; export interface ClientCapabilitiesDto { /** * Gets or sets the list of playable media types. - * @type {Array} + * @type {Array} * @memberof ClientCapabilitiesDto */ - 'PlayableMediaTypes'?: Array; + 'PlayableMediaTypes'?: Array; /** * Gets or sets the list of supported commands. * @type {Array} @@ -39,30 +40,12 @@ export interface ClientCapabilitiesDto { * @memberof ClientCapabilitiesDto */ 'SupportsMediaControl'?: boolean; - /** - * Gets or sets a value indicating whether session supports content uploading. - * @type {boolean} - * @memberof ClientCapabilitiesDto - */ - 'SupportsContentUploading'?: boolean; - /** - * Gets or sets the message callback url. - * @type {string} - * @memberof ClientCapabilitiesDto - */ - 'MessageCallbackUrl'?: string | null; /** * Gets or sets a value indicating whether session supports a persistent identifier. * @type {boolean} * @memberof ClientCapabilitiesDto */ 'SupportsPersistentIdentifier'?: boolean; - /** - * Gets or sets a value indicating whether session supports sync. - * @type {boolean} - * @memberof ClientCapabilitiesDto - */ - 'SupportsSync'?: boolean; /** * * @type {DeviceProfile} @@ -81,5 +64,19 @@ export interface ClientCapabilitiesDto { * @memberof ClientCapabilitiesDto */ 'IconUrl'?: string | null; + /** + * + * @type {boolean} + * @memberof ClientCapabilitiesDto + * @deprecated + */ + 'SupportsContentUploading'?: boolean | null; + /** + * + * @type {boolean} + * @memberof ClientCapabilitiesDto + * @deprecated + */ + 'SupportsSync'?: boolean | null; } diff --git a/src/generated-client/models/client-capabilities.ts b/src/generated-client/models/client-capabilities.ts index 7795ec8b..063eb78b 100644 --- a/src/generated-client/models/client-capabilities.ts +++ b/src/generated-client/models/client-capabilities.ts @@ -14,6 +14,7 @@ import { DeviceProfile } from './device-profile'; import { GeneralCommandType } from './general-command-type'; +import { MediaType } from './media-type'; /** * @@ -23,10 +24,10 @@ import { GeneralCommandType } from './general-command-type'; export interface ClientCapabilities { /** * - * @type {Array} + * @type {Array} * @memberof ClientCapabilities */ - 'PlayableMediaTypes'?: Array | null; + 'PlayableMediaTypes'?: Array | null; /** * * @type {Array} @@ -39,30 +40,12 @@ export interface ClientCapabilities { * @memberof ClientCapabilities */ 'SupportsMediaControl'?: boolean; - /** - * - * @type {boolean} - * @memberof ClientCapabilities - */ - 'SupportsContentUploading'?: boolean; - /** - * - * @type {string} - * @memberof ClientCapabilities - */ - 'MessageCallbackUrl'?: string | null; /** * * @type {boolean} * @memberof ClientCapabilities */ 'SupportsPersistentIdentifier'?: boolean; - /** - * - * @type {boolean} - * @memberof ClientCapabilities - */ - 'SupportsSync'?: boolean; /** * * @type {DeviceProfile} @@ -81,5 +64,19 @@ export interface ClientCapabilities { * @memberof ClientCapabilities */ 'IconUrl'?: string | null; + /** + * + * @type {boolean} + * @memberof ClientCapabilities + * @deprecated + */ + 'SupportsContentUploading'?: boolean | null; + /** + * + * @type {boolean} + * @memberof ClientCapabilities + * @deprecated + */ + 'SupportsSync'?: boolean | null; } diff --git a/src/generated-client/models/collection-type-options.ts b/src/generated-client/models/collection-type-options.ts index c0fab5ef..b2c9b959 100644 --- a/src/generated-client/models/collection-type-options.ts +++ b/src/generated-client/models/collection-type-options.ts @@ -14,20 +14,20 @@ /** - * + * The collection type options. * @export * @enum {string} */ export const CollectionTypeOptions = { - Movies: 'Movies', - TvShows: 'TvShows', - Music: 'Music', - MusicVideos: 'MusicVideos', - HomeVideos: 'HomeVideos', - BoxSets: 'BoxSets', - Books: 'Books', - Mixed: 'Mixed' + Movies: 'movies', + Tvshows: 'tvshows', + Music: 'music', + Musicvideos: 'musicvideos', + Homevideos: 'homevideos', + Boxsets: 'boxsets', + Books: 'books', + Mixed: 'mixed' } as const; export type CollectionTypeOptions = typeof CollectionTypeOptions[keyof typeof CollectionTypeOptions]; diff --git a/src/generated-client/models/collection-type.ts b/src/generated-client/models/collection-type.ts new file mode 100644 index 00000000..0794bd94 --- /dev/null +++ b/src/generated-client/models/collection-type.ts @@ -0,0 +1,41 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + + +/** + * Collection type. + * @export + * @enum {string} + */ + +export const CollectionType = { + Unknown: 'unknown', + Movies: 'movies', + Tvshows: 'tvshows', + Music: 'music', + Musicvideos: 'musicvideos', + Trailers: 'trailers', + Homevideos: 'homevideos', + Boxsets: 'boxsets', + Books: 'books', + Photos: 'photos', + Livetv: 'livetv', + Playlists: 'playlists', + Folders: 'folders' +} as const; + +export type CollectionType = typeof CollectionType[keyof typeof CollectionType]; + + + diff --git a/src/generated-client/models/container-profile.ts b/src/generated-client/models/container-profile.ts index e2aafa13..fd204d3f 100644 --- a/src/generated-client/models/container-profile.ts +++ b/src/generated-client/models/container-profile.ts @@ -32,7 +32,7 @@ export interface ContainerProfile { * @type {Array} * @memberof ContainerProfile */ - 'Conditions'?: Array | null; + 'Conditions'?: Array; /** * * @type {string} diff --git a/src/generated-client/models/create-playlist-dto.ts b/src/generated-client/models/create-playlist-dto.ts index 9e7603fe..81022b21 100644 --- a/src/generated-client/models/create-playlist-dto.ts +++ b/src/generated-client/models/create-playlist-dto.ts @@ -12,6 +12,8 @@ */ +import { MediaType } from './media-type'; +import { PlaylistUserPermissions } from './playlist-user-permissions'; /** * Create new playlist dto. @@ -24,7 +26,7 @@ export interface CreatePlaylistDto { * @type {string} * @memberof CreatePlaylistDto */ - 'Name'?: string | null; + 'Name'?: string; /** * Gets or sets item ids to add to the playlist. * @type {Array} @@ -38,10 +40,22 @@ export interface CreatePlaylistDto { */ 'UserId'?: string | null; /** - * Gets or sets the media type. - * @type {string} + * + * @type {MediaType} * @memberof CreatePlaylistDto */ - 'MediaType'?: string | null; + 'MediaType'?: MediaType; + /** + * Gets or sets the playlist users. + * @type {Array} + * @memberof CreatePlaylistDto + */ + 'Users'?: Array; + /** + * Gets or sets a value indicating whether the playlist is public. + * @type {boolean} + * @memberof CreatePlaylistDto + */ + 'IsPublic'?: boolean; } diff --git a/src/generated-client/models/create-user-by-name.ts b/src/generated-client/models/create-user-by-name.ts index 3d408d95..360e3cc2 100644 --- a/src/generated-client/models/create-user-by-name.ts +++ b/src/generated-client/models/create-user-by-name.ts @@ -24,7 +24,7 @@ export interface CreateUserByName { * @type {string} * @memberof CreateUserByName */ - 'Name'?: string | null; + 'Name': string; /** * Gets or sets the password. * @type {string} diff --git a/src/generated-client/models/device-info.ts b/src/generated-client/models/device-info.ts index 8aab8c1f..bda83c52 100644 --- a/src/generated-client/models/device-info.ts +++ b/src/generated-client/models/device-info.ts @@ -26,6 +26,12 @@ export interface DeviceInfo { * @memberof DeviceInfo */ 'Name'?: string | null; + /** + * + * @type {string} + * @memberof DeviceInfo + */ + 'CustomName'?: string | null; /** * Gets or sets the access token. * @type {string} diff --git a/src/generated-client/models/device-profile.ts b/src/generated-client/models/device-profile.ts index deb82cec..66f78c9e 100644 --- a/src/generated-client/models/device-profile.ts +++ b/src/generated-client/models/device-profile.ts @@ -14,12 +14,9 @@ import { CodecProfile } from './codec-profile'; import { ContainerProfile } from './container-profile'; -import { DeviceIdentification } from './device-identification'; import { DirectPlayProfile } from './direct-play-profile'; -import { ResponseProfile } from './response-profile'; import { SubtitleProfile } from './subtitle-profile'; import { TranscodingProfile } from './transcoding-profile'; -import { XmlAttribute } from './xml-attribute'; /** * A MediaBrowser.Model.Dlna.DeviceProfile represents a set of metadata which determines which content a certain device is able to play.
Specifically, it defines the supported containers and codecs (video and/or audio, including codec profiles and levels) the device is able to direct play (without transcoding or remuxing), as well as which containers/codecs to transcode to in case it isn\'t. @@ -39,120 +36,6 @@ export interface DeviceProfile { * @memberof DeviceProfile */ 'Id'?: string | null; - /** - * - * @type {DeviceIdentification} - * @memberof DeviceProfile - */ - 'Identification'?: DeviceIdentification; - /** - * Gets or sets the friendly name of the device profile, which can be shown to users. - * @type {string} - * @memberof DeviceProfile - */ - 'FriendlyName'?: string | null; - /** - * Gets or sets the manufacturer of the device which this profile represents. - * @type {string} - * @memberof DeviceProfile - */ - 'Manufacturer'?: string | null; - /** - * Gets or sets an url for the manufacturer of the device which this profile represents. - * @type {string} - * @memberof DeviceProfile - */ - 'ManufacturerUrl'?: string | null; - /** - * Gets or sets the model name of the device which this profile represents. - * @type {string} - * @memberof DeviceProfile - */ - 'ModelName'?: string | null; - /** - * Gets or sets the model description of the device which this profile represents. - * @type {string} - * @memberof DeviceProfile - */ - 'ModelDescription'?: string | null; - /** - * Gets or sets the model number of the device which this profile represents. - * @type {string} - * @memberof DeviceProfile - */ - 'ModelNumber'?: string | null; - /** - * Gets or sets the ModelUrl. - * @type {string} - * @memberof DeviceProfile - */ - 'ModelUrl'?: string | null; - /** - * Gets or sets the serial number of the device which this profile represents. - * @type {string} - * @memberof DeviceProfile - */ - 'SerialNumber'?: string | null; - /** - * Gets or sets a value indicating whether EnableAlbumArtInDidl. - * @type {boolean} - * @memberof DeviceProfile - */ - 'EnableAlbumArtInDidl'?: boolean; - /** - * Gets or sets a value indicating whether EnableSingleAlbumArtLimit. - * @type {boolean} - * @memberof DeviceProfile - */ - 'EnableSingleAlbumArtLimit'?: boolean; - /** - * Gets or sets a value indicating whether EnableSingleSubtitleLimit. - * @type {boolean} - * @memberof DeviceProfile - */ - 'EnableSingleSubtitleLimit'?: boolean; - /** - * Gets or sets the SupportedMediaTypes. - * @type {string} - * @memberof DeviceProfile - */ - 'SupportedMediaTypes'?: string; - /** - * Gets or sets the UserId. - * @type {string} - * @memberof DeviceProfile - */ - 'UserId'?: string | null; - /** - * Gets or sets the AlbumArtPn. - * @type {string} - * @memberof DeviceProfile - */ - 'AlbumArtPn'?: string | null; - /** - * Gets or sets the MaxAlbumArtWidth. - * @type {number} - * @memberof DeviceProfile - */ - 'MaxAlbumArtWidth'?: number | null; - /** - * Gets or sets the MaxAlbumArtHeight. - * @type {number} - * @memberof DeviceProfile - */ - 'MaxAlbumArtHeight'?: number | null; - /** - * Gets or sets the maximum allowed width of embedded icons. - * @type {number} - * @memberof DeviceProfile - */ - 'MaxIconWidth'?: number | null; - /** - * Gets or sets the maximum allowed height of embedded icons. - * @type {number} - * @memberof DeviceProfile - */ - 'MaxIconHeight'?: number | null; /** * Gets or sets the maximum allowed bitrate for all streamed content. * @type {number} @@ -177,54 +60,6 @@ export interface DeviceProfile { * @memberof DeviceProfile */ 'MaxStaticMusicBitrate'?: number | null; - /** - * Gets or sets the content of the aggregationFlags element in the urn:schemas-sonycom:av namespace. - * @type {string} - * @memberof DeviceProfile - */ - 'SonyAggregationFlags'?: string | null; - /** - * Gets or sets the ProtocolInfo. - * @type {string} - * @memberof DeviceProfile - */ - 'ProtocolInfo'?: string | null; - /** - * Gets or sets the TimelineOffsetSeconds. - * @type {number} - * @memberof DeviceProfile - */ - 'TimelineOffsetSeconds'?: number; - /** - * Gets or sets a value indicating whether RequiresPlainVideoItems. - * @type {boolean} - * @memberof DeviceProfile - */ - 'RequiresPlainVideoItems'?: boolean; - /** - * Gets or sets a value indicating whether RequiresPlainFolders. - * @type {boolean} - * @memberof DeviceProfile - */ - 'RequiresPlainFolders'?: boolean; - /** - * Gets or sets a value indicating whether EnableMSMediaReceiverRegistrar. - * @type {boolean} - * @memberof DeviceProfile - */ - 'EnableMSMediaReceiverRegistrar'?: boolean; - /** - * Gets or sets a value indicating whether IgnoreTranscodeByteRangeRequests. - * @type {boolean} - * @memberof DeviceProfile - */ - 'IgnoreTranscodeByteRangeRequests'?: boolean; - /** - * Gets or sets the XmlRootAttributes. - * @type {Array} - * @memberof DeviceProfile - */ - 'XmlRootAttributes'?: Array; /** * Gets or sets the direct play profiles. * @type {Array} @@ -249,12 +84,6 @@ export interface DeviceProfile { * @memberof DeviceProfile */ 'CodecProfiles'?: Array; - /** - * Gets or sets the ResponseProfiles. - * @type {Array} - * @memberof DeviceProfile - */ - 'ResponseProfiles'?: Array; /** * Gets or sets the subtitle profiles. * @type {Array} diff --git a/src/generated-client/models/dlna-profile-type.ts b/src/generated-client/models/dlna-profile-type.ts index 12cc74b0..9a32ef8c 100644 --- a/src/generated-client/models/dlna-profile-type.ts +++ b/src/generated-client/models/dlna-profile-type.ts @@ -23,7 +23,8 @@ export const DlnaProfileType = { Audio: 'Audio', Video: 'Video', Photo: 'Photo', - Subtitle: 'Subtitle' + Subtitle: 'Subtitle', + Lyric: 'Lyric' } as const; export type DlnaProfileType = typeof DlnaProfileType[keyof typeof DlnaProfileType]; diff --git a/src/generated-client/models/down-mix-stereo-algorithms.ts b/src/generated-client/models/down-mix-stereo-algorithms.ts new file mode 100644 index 00000000..6f4535ab --- /dev/null +++ b/src/generated-client/models/down-mix-stereo-algorithms.ts @@ -0,0 +1,31 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + + +/** + * An enum representing an algorithm to downmix 6ch+ to stereo. Algorithms sourced from https://superuser.com/questions/852400/properly-downmix-5-1-to-stereo-using-ffmpeg/1410620#1410620. + * @export + * @enum {string} + */ + +export const DownMixStereoAlgorithms = { + None: 'None', + Dave750: 'Dave750', + NightmodeDialogue: 'NightmodeDialogue' +} as const; + +export type DownMixStereoAlgorithms = typeof DownMixStereoAlgorithms[keyof typeof DownMixStereoAlgorithms]; + + + diff --git a/src/generated-client/models/encoding-options.ts b/src/generated-client/models/encoding-options.ts index ea08144b..e6b7b7fa 100644 --- a/src/generated-client/models/encoding-options.ts +++ b/src/generated-client/models/encoding-options.ts @@ -12,63 +12,88 @@ */ +import { DownMixStereoAlgorithms } from './down-mix-stereo-algorithms'; /** - * + * Class EncodingOptions. * @export * @interface EncodingOptions */ export interface EncodingOptions { /** - * + * Gets or sets the thread count used for encoding. * @type {number} * @memberof EncodingOptions */ 'EncodingThreadCount'?: number; /** - * + * Gets or sets the temporary transcoding path. * @type {string} * @memberof EncodingOptions */ 'TranscodingTempPath'?: string | null; /** - * + * Gets or sets the path to the fallback font. * @type {string} * @memberof EncodingOptions */ 'FallbackFontPath'?: string | null; /** - * + * Gets or sets a value indicating whether to use the fallback font. * @type {boolean} * @memberof EncodingOptions */ 'EnableFallbackFont'?: boolean; /** - * + * Gets or sets a value indicating whether audio VBR is enabled. + * @type {boolean} + * @memberof EncodingOptions + */ + 'EnableAudioVbr'?: boolean; + /** + * Gets or sets the audio boost applied when downmixing audio. * @type {number} * @memberof EncodingOptions */ 'DownMixAudioBoost'?: number; /** * + * @type {DownMixStereoAlgorithms} + * @memberof EncodingOptions + */ + 'DownMixStereoAlgorithm'?: DownMixStereoAlgorithms; + /** + * Gets or sets the maximum size of the muxing queue. * @type {number} * @memberof EncodingOptions */ 'MaxMuxingQueueSize'?: number; /** - * + * Gets or sets a value indicating whether throttling is enabled. * @type {boolean} * @memberof EncodingOptions */ 'EnableThrottling'?: boolean; /** - * + * Gets or sets the delay after which throttling happens. * @type {number} * @memberof EncodingOptions */ 'ThrottleDelaySeconds'?: number; /** - * + * Gets or sets a value indicating whether segment deletion is enabled. + * @type {boolean} + * @memberof EncodingOptions + */ + 'EnableSegmentDeletion'?: boolean; + /** + * Gets or sets seconds for which segments should be kept before being deleted. + * @type {number} + * @memberof EncodingOptions + */ + 'SegmentKeepSeconds'?: number; + /** + * Gets or sets the hardware acceleration type. * @type {string} * @memberof EncodingOptions */ @@ -86,163 +111,175 @@ export interface EncodingOptions { */ 'EncoderAppPathDisplay'?: string | null; /** - * + * Gets or sets the VA-API device. * @type {string} * @memberof EncodingOptions */ 'VaapiDevice'?: string | null; /** - * + * Gets or sets a value indicating whether tonemapping is enabled. * @type {boolean} * @memberof EncodingOptions */ 'EnableTonemapping'?: boolean; /** - * + * Gets or sets a value indicating whether VPP tonemapping is enabled. * @type {boolean} * @memberof EncodingOptions */ 'EnableVppTonemapping'?: boolean; /** - * + * Gets or sets a value indicating whether videotoolbox tonemapping is enabled. + * @type {boolean} + * @memberof EncodingOptions + */ + 'EnableVideoToolboxTonemapping'?: boolean; + /** + * Gets or sets the tone-mapping algorithm. * @type {string} * @memberof EncodingOptions */ 'TonemappingAlgorithm'?: string | null; /** - * + * Gets or sets the tone-mapping mode. * @type {string} * @memberof EncodingOptions */ 'TonemappingMode'?: string | null; /** - * + * Gets or sets the tone-mapping range. * @type {string} * @memberof EncodingOptions */ 'TonemappingRange'?: string | null; /** - * + * Gets or sets the tone-mapping desaturation. * @type {number} * @memberof EncodingOptions */ 'TonemappingDesat'?: number; /** - * + * Gets or sets the tone-mapping peak. * @type {number} * @memberof EncodingOptions */ 'TonemappingPeak'?: number; /** - * + * Gets or sets the tone-mapping parameters. * @type {number} * @memberof EncodingOptions */ 'TonemappingParam'?: number; /** - * + * Gets or sets the VPP tone-mapping brightness. * @type {number} * @memberof EncodingOptions */ 'VppTonemappingBrightness'?: number; /** - * + * Gets or sets the VPP tone-mapping contrast. * @type {number} * @memberof EncodingOptions */ 'VppTonemappingContrast'?: number; /** - * + * Gets or sets the H264 CRF. * @type {number} * @memberof EncodingOptions */ 'H264Crf'?: number; /** - * + * Gets or sets the H265 CRF. * @type {number} * @memberof EncodingOptions */ 'H265Crf'?: number; /** - * + * Gets or sets the encoder preset. * @type {string} * @memberof EncodingOptions */ 'EncoderPreset'?: string | null; /** - * + * Gets or sets a value indicating whether the framerate is doubled when deinterlacing. * @type {boolean} * @memberof EncodingOptions */ 'DeinterlaceDoubleRate'?: boolean; /** - * + * Gets or sets the deinterlace method. * @type {string} * @memberof EncodingOptions */ 'DeinterlaceMethod'?: string | null; /** - * + * Gets or sets a value indicating whether 10bit HEVC decoding is enabled. * @type {boolean} * @memberof EncodingOptions */ 'EnableDecodingColorDepth10Hevc'?: boolean; /** - * + * Gets or sets a value indicating whether 10bit VP9 decoding is enabled. * @type {boolean} * @memberof EncodingOptions */ 'EnableDecodingColorDepth10Vp9'?: boolean; /** - * + * Gets or sets a value indicating whether the enhanced NVDEC is enabled. * @type {boolean} * @memberof EncodingOptions */ 'EnableEnhancedNvdecDecoder'?: boolean; /** - * + * Gets or sets a value indicating whether the system native hardware decoder should be used. * @type {boolean} * @memberof EncodingOptions */ 'PreferSystemNativeHwDecoder'?: boolean; /** - * + * Gets or sets a value indicating whether the Intel H264 low-power hardware encoder should be used. * @type {boolean} * @memberof EncodingOptions */ 'EnableIntelLowPowerH264HwEncoder'?: boolean; /** - * + * Gets or sets a value indicating whether the Intel HEVC low-power hardware encoder should be used. * @type {boolean} * @memberof EncodingOptions */ 'EnableIntelLowPowerHevcHwEncoder'?: boolean; /** - * + * Gets or sets a value indicating whether hardware encoding is enabled. * @type {boolean} * @memberof EncodingOptions */ 'EnableHardwareEncoding'?: boolean; /** - * + * Gets or sets a value indicating whether HEVC encoding is enabled. * @type {boolean} * @memberof EncodingOptions */ 'AllowHevcEncoding'?: boolean; /** - * + * Gets or sets a value indicating whether AV1 encoding is enabled. + * @type {boolean} + * @memberof EncodingOptions + */ + 'AllowAv1Encoding'?: boolean; + /** + * Gets or sets a value indicating whether subtitle extraction is enabled. * @type {boolean} * @memberof EncodingOptions */ 'EnableSubtitleExtraction'?: boolean; /** - * + * Gets or sets the codecs hardware encoding is used for. * @type {Array} * @memberof EncodingOptions */ 'HardwareDecodingCodecs'?: Array | null; /** - * + * Gets or sets the file extensions on-demand metadata based keyframe extraction is enabled for. * @type {Array} * @memberof EncodingOptions */ diff --git a/src/generated-client/models/external-id-media-type.ts b/src/generated-client/models/external-id-media-type.ts index 2fe7d574..a18e9f71 100644 --- a/src/generated-client/models/external-id-media-type.ts +++ b/src/generated-client/models/external-id-media-type.ts @@ -31,7 +31,8 @@ export const ExternalIdMediaType = { ReleaseGroup: 'ReleaseGroup', Season: 'Season', Series: 'Series', - Track: 'Track' + Track: 'Track', + Book: 'Book' } as const; export type ExternalIdMediaType = typeof ExternalIdMediaType[keyof typeof ExternalIdMediaType]; diff --git a/src/generated-client/models/extra-type.ts b/src/generated-client/models/extra-type.ts new file mode 100644 index 00000000..a1ea20b2 --- /dev/null +++ b/src/generated-client/models/extra-type.ts @@ -0,0 +1,40 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + + +/** + * + * @export + * @enum {string} + */ + +export const ExtraType = { + Unknown: 'Unknown', + Clip: 'Clip', + Trailer: 'Trailer', + BehindTheScenes: 'BehindTheScenes', + DeletedScene: 'DeletedScene', + Interview: 'Interview', + Scene: 'Scene', + Sample: 'Sample', + ThemeSong: 'ThemeSong', + ThemeVideo: 'ThemeVideo', + Featurette: 'Featurette', + Short: 'Short' +} as const; + +export type ExtraType = typeof ExtraType[keyof typeof ExtraType]; + + + diff --git a/src/generated-client/models/force-keep-alive-message.ts b/src/generated-client/models/force-keep-alive-message.ts new file mode 100644 index 00000000..fdf0ec9f --- /dev/null +++ b/src/generated-client/models/force-keep-alive-message.ts @@ -0,0 +1,42 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { SessionMessageType } from './session-message-type'; + +/** + * Force keep alive websocket messages. + * @export + * @interface ForceKeepAliveMessage + */ +export interface ForceKeepAliveMessage { + /** + * Gets or sets the data. + * @type {number} + * @memberof ForceKeepAliveMessage + */ + 'Data'?: number; + /** + * Gets or sets the message id. + * @type {string} + * @memberof ForceKeepAliveMessage + */ + 'MessageId'?: string; + /** + * + * @type {SessionMessageType} + * @memberof ForceKeepAliveMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/general-command-message.ts b/src/generated-client/models/general-command-message.ts new file mode 100644 index 00000000..3aecac50 --- /dev/null +++ b/src/generated-client/models/general-command-message.ts @@ -0,0 +1,43 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { GeneralCommand } from './general-command'; +import { SessionMessageType } from './session-message-type'; + +/** + * General command websocket message. + * @export + * @interface GeneralCommandMessage + */ +export interface GeneralCommandMessage { + /** + * + * @type {GeneralCommand} + * @memberof GeneralCommandMessage + */ + 'Data'?: GeneralCommand; + /** + * Gets or sets the message id. + * @type {string} + * @memberof GeneralCommandMessage + */ + 'MessageId'?: string; + /** + * + * @type {SessionMessageType} + * @memberof GeneralCommandMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/general-command-type.ts b/src/generated-client/models/general-command-type.ts index 853a7c79..dc6cea32 100644 --- a/src/generated-client/models/general-command-type.ts +++ b/src/generated-client/models/general-command-type.ts @@ -61,7 +61,8 @@ export const GeneralCommandType = { PlayNext: 'PlayNext', ToggleOsdMenu: 'ToggleOsdMenu', Play: 'Play', - SetMaxStreamingBitrate: 'SetMaxStreamingBitrate' + SetMaxStreamingBitrate: 'SetMaxStreamingBitrate', + SetPlaybackOrder: 'SetPlaybackOrder' } as const; export type GeneralCommandType = typeof GeneralCommandType[keyof typeof GeneralCommandType]; diff --git a/src/generated-client/models/get-programs-dto.ts b/src/generated-client/models/get-programs-dto.ts index ea5ac00c..4d7b477b 100644 --- a/src/generated-client/models/get-programs-dto.ts +++ b/src/generated-client/models/get-programs-dto.ts @@ -14,6 +14,7 @@ import { ImageType } from './image-type'; import { ItemFields } from './item-fields'; +import { ItemSortBy } from './item-sort-by'; import { SortOrder } from './sort-order'; /** @@ -33,7 +34,7 @@ export interface GetProgramsDto { * @type {string} * @memberof GetProgramsDto */ - 'UserId'?: string; + 'UserId'?: string | null; /** * Gets or sets the minimum premiere start date. Optional. * @type {string} @@ -114,10 +115,10 @@ export interface GetProgramsDto { 'Limit'?: number | null; /** * Gets or sets specify one or more sort orders, comma delimited. Options: Name, StartDate. Optional. - * @type {Array} + * @type {Array} * @memberof GetProgramsDto */ - 'SortBy'?: Array; + 'SortBy'?: Array; /** * Gets or sets sort Order - Ascending,Descending. * @type {Array} diff --git a/src/generated-client/models/group-info-dto-group-update.ts b/src/generated-client/models/group-info-dto-group-update.ts new file mode 100644 index 00000000..6d2b0de8 --- /dev/null +++ b/src/generated-client/models/group-info-dto-group-update.ts @@ -0,0 +1,43 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { GroupInfoDto } from './group-info-dto'; +import { GroupUpdateType } from './group-update-type'; + +/** + * Class GroupUpdate. + * @export + * @interface GroupInfoDtoGroupUpdate + */ +export interface GroupInfoDtoGroupUpdate { + /** + * Gets the group identifier. + * @type {string} + * @memberof GroupInfoDtoGroupUpdate + */ + 'GroupId'?: string; + /** + * + * @type {GroupUpdateType} + * @memberof GroupInfoDtoGroupUpdate + */ + 'Type'?: GroupUpdateType; + /** + * + * @type {GroupInfoDto} + * @memberof GroupInfoDtoGroupUpdate + */ + 'Data'?: GroupInfoDto; +} + diff --git a/src/generated-client/models/group-state-update-group-update.ts b/src/generated-client/models/group-state-update-group-update.ts new file mode 100644 index 00000000..da7240b4 --- /dev/null +++ b/src/generated-client/models/group-state-update-group-update.ts @@ -0,0 +1,43 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { GroupStateUpdate } from './group-state-update'; +import { GroupUpdateType } from './group-update-type'; + +/** + * Class GroupUpdate. + * @export + * @interface GroupStateUpdateGroupUpdate + */ +export interface GroupStateUpdateGroupUpdate { + /** + * Gets the group identifier. + * @type {string} + * @memberof GroupStateUpdateGroupUpdate + */ + 'GroupId'?: string; + /** + * + * @type {GroupUpdateType} + * @memberof GroupStateUpdateGroupUpdate + */ + 'Type'?: GroupUpdateType; + /** + * + * @type {GroupStateUpdate} + * @memberof GroupStateUpdateGroupUpdate + */ + 'Data'?: GroupStateUpdate; +} + diff --git a/src/generated-client/models/group-state-update.ts b/src/generated-client/models/group-state-update.ts new file mode 100644 index 00000000..6a9b0129 --- /dev/null +++ b/src/generated-client/models/group-state-update.ts @@ -0,0 +1,37 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { GroupStateType } from './group-state-type'; +import { PlaybackRequestType } from './playback-request-type'; + +/** + * Class GroupStateUpdate. + * @export + * @interface GroupStateUpdate + */ +export interface GroupStateUpdate { + /** + * + * @type {GroupStateType} + * @memberof GroupStateUpdate + */ + 'State'?: GroupStateType; + /** + * + * @type {PlaybackRequestType} + * @memberof GroupStateUpdate + */ + 'Reason'?: PlaybackRequestType; +} + diff --git a/src/generated-client/models/group-update.ts b/src/generated-client/models/group-update.ts new file mode 100644 index 00000000..36c318b8 --- /dev/null +++ b/src/generated-client/models/group-update.ts @@ -0,0 +1,29 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { GroupInfoDtoGroupUpdate } from './group-info-dto-group-update'; +import { GroupStateUpdateGroupUpdate } from './group-state-update-group-update'; +import { GroupUpdateType } from './group-update-type'; +import { PlayQueueUpdate } from './play-queue-update'; +import { PlayQueueUpdateGroupUpdate } from './play-queue-update-group-update'; +import { StringGroupUpdate } from './string-group-update'; + +/** + * @type GroupUpdate + * Group update without data. + * @export + */ +export type GroupUpdate = GroupInfoDtoGroupUpdate | GroupStateUpdateGroupUpdate | PlayQueueUpdateGroupUpdate | StringGroupUpdate; + + diff --git a/src/generated-client/models/hardware-encoding-type.ts b/src/generated-client/models/hardware-encoding-type.ts index 2b785d93..af4d112b 100644 --- a/src/generated-client/models/hardware-encoding-type.ts +++ b/src/generated-client/models/hardware-encoding-type.ts @@ -25,7 +25,8 @@ export const HardwareEncodingType = { Nvenc: 'NVENC', V4L2M2M: 'V4L2M2M', Vaapi: 'VAAPI', - VideoToolBox: 'VideoToolBox' + VideoToolBox: 'VideoToolBox', + Rkmpp: 'RKMPP' } as const; export type HardwareEncodingType = typeof HardwareEncodingType[keyof typeof HardwareEncodingType]; diff --git a/src/generated-client/models/image-format.ts b/src/generated-client/models/image-format.ts index 30c55858..676a09f4 100644 --- a/src/generated-client/models/image-format.ts +++ b/src/generated-client/models/image-format.ts @@ -24,7 +24,8 @@ export const ImageFormat = { Gif: 'Gif', Jpg: 'Jpg', Png: 'Png', - Webp: 'Webp' + Webp: 'Webp', + Svg: 'Svg' } as const; export type ImageFormat = typeof ImageFormat[keyof typeof ImageFormat]; diff --git a/src/generated-client/models/image-resolution.ts b/src/generated-client/models/image-resolution.ts new file mode 100644 index 00000000..c7c1a74e --- /dev/null +++ b/src/generated-client/models/image-resolution.ts @@ -0,0 +1,37 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + + +/** + * Enum ImageResolution. + * @export + * @enum {string} + */ + +export const ImageResolution = { + MatchSource: 'MatchSource', + P144: 'P144', + P240: 'P240', + P360: 'P360', + P480: 'P480', + P720: 'P720', + P1080: 'P1080', + P1440: 'P1440', + P2160: 'P2160' +} as const; + +export type ImageResolution = typeof ImageResolution[keyof typeof ImageResolution]; + + + diff --git a/src/generated-client/models/inbound-keep-alive-message.ts b/src/generated-client/models/inbound-keep-alive-message.ts new file mode 100644 index 00000000..e6a6ca11 --- /dev/null +++ b/src/generated-client/models/inbound-keep-alive-message.ts @@ -0,0 +1,30 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { SessionMessageType } from './session-message-type'; + +/** + * Keep alive websocket messages. + * @export + * @interface InboundKeepAliveMessage + */ +export interface InboundKeepAliveMessage { + /** + * + * @type {SessionMessageType} + * @memberof InboundKeepAliveMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/inbound-web-socket-message.ts b/src/generated-client/models/inbound-web-socket-message.ts new file mode 100644 index 00000000..1b66cd4f --- /dev/null +++ b/src/generated-client/models/inbound-web-socket-message.ts @@ -0,0 +1,31 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { ActivityLogEntryStartMessage } from './activity-log-entry-start-message'; +import { ActivityLogEntryStopMessage } from './activity-log-entry-stop-message'; +import { InboundKeepAliveMessage } from './inbound-keep-alive-message'; +import { ScheduledTasksInfoStartMessage } from './scheduled-tasks-info-start-message'; +import { ScheduledTasksInfoStopMessage } from './scheduled-tasks-info-stop-message'; +import { SessionMessageType } from './session-message-type'; +import { SessionsStartMessage } from './sessions-start-message'; +import { SessionsStopMessage } from './sessions-stop-message'; + +/** + * @type InboundWebSocketMessage + * Represents the list of possible inbound websocket types + * @export + */ +export type InboundWebSocketMessage = ActivityLogEntryStartMessage | ActivityLogEntryStopMessage | InboundKeepAliveMessage | ScheduledTasksInfoStartMessage | ScheduledTasksInfoStopMessage | SessionsStartMessage | SessionsStopMessage; + + diff --git a/src/generated-client/models/index.ts b/src/generated-client/models/index.ts index 1c013bfd..a17ec3be 100644 --- a/src/generated-client/models/index.ts +++ b/src/generated-client/models/index.ts @@ -1,19 +1,20 @@ export * from './access-schedule'; export * from './activity-log-entry'; +export * from './activity-log-entry-message'; export * from './activity-log-entry-query-result'; +export * from './activity-log-entry-start-message'; +export * from './activity-log-entry-stop-message'; export * from './add-virtual-folder-dto'; -export * from './admin-notification-dto'; export * from './album-info'; export * from './album-info-remote-search-query'; export * from './all-theme-media-result'; -export * from './architecture'; export * from './artist-info'; export * from './artist-info-remote-search-query'; +export * from './audio-spatial-format'; export * from './authenticate-user-by-name'; export * from './authentication-info'; export * from './authentication-info-query-result'; export * from './authentication-result'; -export * from './base-item'; export * from './base-item-dto'; export * from './base-item-dto-image-blur-hashes'; export * from './base-item-dto-query-result'; @@ -26,6 +27,7 @@ export * from './box-set-info'; export * from './box-set-info-remote-search-query'; export * from './branding-options'; export * from './buffer-request-dto'; +export * from './cast-receiver-application'; export * from './channel-features'; export * from './channel-item-sort-field'; export * from './channel-mapping-options-dto'; @@ -39,11 +41,11 @@ export * from './client-log-document-response-dto'; export * from './codec-profile'; export * from './codec-type'; export * from './collection-creation-result'; +export * from './collection-type'; export * from './collection-type-options'; export * from './config-image-types'; export * from './configuration-page-info'; export * from './container-profile'; -export * from './control-response'; export * from './country-info'; export * from './create-playlist-dto'; export * from './create-user-by-name'; @@ -51,18 +53,15 @@ export * from './culture-dto'; export * from './day-of-week'; export * from './day-pattern'; export * from './default-directory-browser-info-dto'; -export * from './device-identification'; export * from './device-info'; export * from './device-info-query-result'; export * from './device-options'; export * from './device-options-dto'; export * from './device-profile'; -export * from './device-profile-info'; -export * from './device-profile-type'; export * from './direct-play-profile'; export * from './display-preferences-dto'; -export * from './dlna-options'; export * from './dlna-profile-type'; +export * from './down-mix-stereo-algorithms'; export * from './dynamic-day-of-week'; export * from './embedded-subtitle-options'; export * from './encoding-context'; @@ -71,44 +70,52 @@ export * from './end-point-info'; export * from './external-id-info'; export * from './external-id-media-type'; export * from './external-url'; -export * from './ffmpeg-location'; +export * from './extra-type'; export * from './file-system-entry-info'; export * from './file-system-entry-type'; export * from './font-file'; +export * from './force-keep-alive-message'; export * from './forgot-password-action'; export * from './forgot-password-dto'; export * from './forgot-password-pin-dto'; export * from './forgot-password-result'; export * from './general-command'; +export * from './general-command-message'; export * from './general-command-type'; export * from './get-programs-dto'; export * from './group-info-dto'; +export * from './group-info-dto-group-update'; export * from './group-queue-mode'; export * from './group-repeat-mode'; export * from './group-shuffle-mode'; export * from './group-state-type'; +export * from './group-state-update'; +export * from './group-state-update-group-update'; +export * from './group-update'; export * from './group-update-type'; export * from './guide-info'; export * from './hardware-encoding-type'; -export * from './header-match-type'; -export * from './http-header-info'; export * from './iplugin'; export * from './ignore-wait-request-dto'; -export * from './image-by-name-info'; export * from './image-format'; export * from './image-info'; export * from './image-option'; export * from './image-orientation'; export * from './image-provider-info'; +export * from './image-resolution'; export * from './image-saving-convention'; export * from './image-type'; +export * from './inbound-keep-alive-message'; +export * from './inbound-web-socket-message'; export * from './installation-info'; export * from './iso-type'; export * from './item-counts'; export * from './item-fields'; export * from './item-filter'; +export * from './item-sort-by'; export * from './join-group-request-dto'; export * from './keep-until'; +export * from './library-changed-message'; export * from './library-option-info-dto'; export * from './library-options'; export * from './library-options-result-dto'; @@ -124,15 +131,19 @@ export * from './localization-option'; export * from './location-type'; export * from './log-file'; export * from './log-level'; +export * from './lyric-dto'; +export * from './lyric-line'; +export * from './lyric-metadata'; export * from './media-attachment'; -export * from './media-encoder-path-dto'; export * from './media-path-dto'; export * from './media-path-info'; export * from './media-protocol'; export * from './media-source-info'; export * from './media-source-type'; export * from './media-stream'; +export * from './media-stream-protocol'; export * from './media-stream-type'; +export * from './media-type'; export * from './media-update-info-dto'; export * from './media-update-info-path-dto'; export * from './media-url'; @@ -153,41 +164,50 @@ export * from './name-value-pair'; export * from './network-configuration'; export * from './new-group-request-dto'; export * from './next-item-request-dto'; -export * from './notification-dto'; -export * from './notification-level'; -export * from './notification-option'; -export * from './notification-options'; -export * from './notification-result-dto'; -export * from './notification-type-info'; -export * from './notifications-summary-dto'; -export * from './object-group-update'; export * from './open-live-stream-dto'; +export * from './outbound-keep-alive-message'; +export * from './outbound-web-socket-message'; export * from './package-info'; export * from './parental-rating'; export * from './path-substitution'; +export * from './person-kind'; export * from './person-lookup-info'; export * from './person-lookup-info-remote-search-query'; export * from './pin-redeem-result'; export * from './ping-request-dto'; export * from './play-access'; export * from './play-command'; +export * from './play-message'; export * from './play-method'; +export * from './play-queue-update'; +export * from './play-queue-update-group-update'; +export * from './play-queue-update-reason'; export * from './play-request'; export * from './play-request-dto'; export * from './playback-error-code'; export * from './playback-info-dto'; export * from './playback-info-response'; +export * from './playback-order'; export * from './playback-progress-info'; +export * from './playback-request-type'; export * from './playback-start-info'; export * from './playback-stop-info'; export * from './player-state-info'; export * from './playlist-creation-result'; +export * from './playlist-user-permissions'; export * from './playstate-command'; +export * from './playstate-message'; export * from './playstate-request'; export * from './plugin-info'; +export * from './plugin-installation-cancelled-message'; +export * from './plugin-installation-completed-message'; +export * from './plugin-installation-failed-message'; +export * from './plugin-installing-message'; export * from './plugin-status'; +export * from './plugin-uninstalled-message'; export * from './previous-item-request-dto'; export * from './problem-details'; +export * from './process-priority-class'; export * from './profile-condition'; export * from './profile-condition-type'; export * from './profile-condition-value'; @@ -204,31 +224,43 @@ export * from './ready-request-dto'; export * from './recommendation-dto'; export * from './recommendation-type'; export * from './recording-status'; +export * from './refresh-progress-message'; export * from './remote-image-info'; export * from './remote-image-result'; +export * from './remote-lyric-info-dto'; export * from './remote-search-result'; export * from './remote-subtitle-info'; export * from './remove-from-playlist-request-dto'; export * from './repeat-mode'; export * from './repository-info'; -export * from './response-profile'; +export * from './restart-required-message'; +export * from './scheduled-task-ended-message'; +export * from './scheduled-tasks-info-message'; +export * from './scheduled-tasks-info-start-message'; +export * from './scheduled-tasks-info-stop-message'; export * from './scroll-direction'; export * from './search-hint'; export * from './search-hint-result'; export * from './seek-request-dto'; export * from './send-command'; export * from './send-command-type'; -export * from './send-to-user-type'; export * from './series-info'; export * from './series-info-remote-search-query'; export * from './series-status'; +export * from './series-timer-cancelled-message'; +export * from './series-timer-created-message'; export * from './series-timer-info-dto'; export * from './series-timer-info-dto-query-result'; export * from './server-configuration'; export * from './server-discovery-info'; +export * from './server-restarting-message'; +export * from './server-shutting-down-message'; export * from './session-info'; export * from './session-message-type'; export * from './session-user-info'; +export * from './sessions-message'; +export * from './sessions-start-message'; +export * from './sessions-stop-message'; export * from './set-channel-mapping-dto'; export * from './set-playlist-item-request-dto'; export * from './set-repeat-mode-request-dto'; @@ -239,10 +271,14 @@ export * from './special-view-option-dto'; export * from './startup-configuration-dto'; export * from './startup-remote-access-dto'; export * from './startup-user-dto'; +export * from './string-group-update'; export * from './subtitle-delivery-method'; export * from './subtitle-options'; export * from './subtitle-playback-mode'; export * from './subtitle-profile'; +export * from './sync-play-command-message'; +export * from './sync-play-group-update-command-message'; +export * from './sync-play-queue-item'; export * from './sync-play-user-access-type'; export * from './system-info'; export * from './task-completion-status'; @@ -251,6 +287,8 @@ export * from './task-result'; export * from './task-state'; export * from './task-trigger-info'; export * from './theme-media-result'; +export * from './timer-cancelled-message'; +export * from './timer-created-message'; export * from './timer-event-info'; export * from './timer-info-dto'; export * from './timer-info-dto-query-result'; @@ -261,25 +299,36 @@ export * from './transcode-seek-info'; export * from './transcoding-info'; export * from './transcoding-profile'; export * from './transport-stream-timestamp'; +export * from './trickplay-info'; +export * from './trickplay-options'; +export * from './trickplay-scan-behavior'; export * from './tuner-channel-mapping'; export * from './tuner-host-info'; export * from './type-options'; export * from './unrated-item'; export * from './update-library-options-dto'; export * from './update-media-path-request-dto'; -export * from './update-user-easy-password'; +export * from './update-playlist-dto'; +export * from './update-playlist-user-dto'; +export * from './update-user-item-data-dto'; export * from './update-user-password'; export * from './upload-subtitle-dto'; export * from './user-configuration'; +export * from './user-data-change-info'; +export * from './user-data-changed-message'; +export * from './user-deleted-message'; export * from './user-dto'; export * from './user-item-data-dto'; export * from './user-policy'; +export * from './user-updated-message'; export * from './utc-time-response'; export * from './validate-path-dto'; export * from './version-info'; export * from './video3-dformat'; +export * from './video-range'; +export * from './video-range-type'; export * from './video-type'; export * from './virtual-folder-info'; export * from './wake-on-lan-info'; +export * from './web-socket-message'; export * from './xbmc-metadata-options'; -export * from './xml-attribute'; diff --git a/src/generated-client/models/item-fields.ts b/src/generated-client/models/item-fields.ts index 83deeab3..bde07107 100644 --- a/src/generated-client/models/item-fields.ts +++ b/src/generated-client/models/item-fields.ts @@ -25,6 +25,7 @@ export const ItemFields = { CanDownload: 'CanDownload', ChannelInfo: 'ChannelInfo', Chapters: 'Chapters', + Trickplay: 'Trickplay', ChildCount: 'ChildCount', CumulativeRunTimeTicks: 'CumulativeRunTimeTicks', CustomRating: 'CustomRating', @@ -55,8 +56,6 @@ export const ItemFields = { SortName: 'SortName', SpecialEpisodeNumbers: 'SpecialEpisodeNumbers', Studios: 'Studios', - BasicSyncInfo: 'BasicSyncInfo', - SyncInfo: 'SyncInfo', Taglines: 'Taglines', Tags: 'Tags', RemoteTrailers: 'RemoteTrailers', diff --git a/src/generated-client/models/item-sort-by.ts b/src/generated-client/models/item-sort-by.ts new file mode 100644 index 00000000..4a7e03a5 --- /dev/null +++ b/src/generated-client/models/item-sort-by.ts @@ -0,0 +1,60 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + + +/** + * These represent sort orders. + * @export + * @enum {string} + */ + +export const ItemSortBy = { + Default: 'Default', + AiredEpisodeOrder: 'AiredEpisodeOrder', + Album: 'Album', + AlbumArtist: 'AlbumArtist', + Artist: 'Artist', + DateCreated: 'DateCreated', + OfficialRating: 'OfficialRating', + DatePlayed: 'DatePlayed', + PremiereDate: 'PremiereDate', + StartDate: 'StartDate', + SortName: 'SortName', + Name: 'Name', + Random: 'Random', + Runtime: 'Runtime', + CommunityRating: 'CommunityRating', + ProductionYear: 'ProductionYear', + PlayCount: 'PlayCount', + CriticRating: 'CriticRating', + IsFolder: 'IsFolder', + IsUnplayed: 'IsUnplayed', + IsPlayed: 'IsPlayed', + SeriesSortName: 'SeriesSortName', + VideoBitRate: 'VideoBitRate', + AirTime: 'AirTime', + Studio: 'Studio', + IsFavoriteOrLiked: 'IsFavoriteOrLiked', + DateLastContentAdded: 'DateLastContentAdded', + SeriesDatePlayed: 'SeriesDatePlayed', + ParentIndexNumber: 'ParentIndexNumber', + IndexNumber: 'IndexNumber', + SimilarityScore: 'SimilarityScore', + SearchScore: 'SearchScore' +} as const; + +export type ItemSortBy = typeof ItemSortBy[keyof typeof ItemSortBy]; + + + diff --git a/src/generated-client/models/library-changed-message.ts b/src/generated-client/models/library-changed-message.ts new file mode 100644 index 00000000..4f98fc5b --- /dev/null +++ b/src/generated-client/models/library-changed-message.ts @@ -0,0 +1,43 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { LibraryUpdateInfo } from './library-update-info'; +import { SessionMessageType } from './session-message-type'; + +/** + * Library changed message. + * @export + * @interface LibraryChangedMessage + */ +export interface LibraryChangedMessage { + /** + * + * @type {LibraryUpdateInfo} + * @memberof LibraryChangedMessage + */ + 'Data'?: LibraryUpdateInfo; + /** + * Gets or sets the message id. + * @type {string} + * @memberof LibraryChangedMessage + */ + 'MessageId'?: string; + /** + * + * @type {SessionMessageType} + * @memberof LibraryChangedMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/library-options.ts b/src/generated-client/models/library-options.ts index 734aa6ab..a75b7355 100644 --- a/src/generated-client/models/library-options.ts +++ b/src/generated-client/models/library-options.ts @@ -22,6 +22,12 @@ import { TypeOptions } from './type-options'; * @interface LibraryOptions */ export interface LibraryOptions { + /** + * + * @type {boolean} + * @memberof LibraryOptions + */ + 'Enabled'?: boolean; /** * * @type {boolean} @@ -34,6 +40,12 @@ export interface LibraryOptions { * @memberof LibraryOptions */ 'EnableRealtimeMonitor'?: boolean; + /** + * + * @type {boolean} + * @memberof LibraryOptions + */ + 'EnableLUFSScan'?: boolean; /** * * @type {boolean} @@ -46,6 +58,18 @@ export interface LibraryOptions { * @memberof LibraryOptions */ 'ExtractChapterImagesDuringLibraryScan'?: boolean; + /** + * + * @type {boolean} + * @memberof LibraryOptions + */ + 'EnableTrickplayImageExtraction'?: boolean; + /** + * + * @type {boolean} + * @memberof LibraryOptions + */ + 'ExtractTrickplayImagesDuringLibraryScan'?: boolean; /** * * @type {Array} @@ -77,6 +101,12 @@ export interface LibraryOptions { * @memberof LibraryOptions */ 'EnableEmbeddedTitles'?: boolean; + /** + * + * @type {boolean} + * @memberof LibraryOptions + */ + 'EnableEmbeddedExtrasTitles'?: boolean; /** * * @type {boolean} @@ -167,6 +197,12 @@ export interface LibraryOptions { * @memberof LibraryOptions */ 'SaveSubtitlesWithMedia'?: boolean; + /** + * + * @type {boolean} + * @memberof LibraryOptions + */ + 'SaveLyricsWithMedia'?: boolean; /** * * @type {boolean} diff --git a/src/generated-client/models/live-tv-options.ts b/src/generated-client/models/live-tv-options.ts index 78c30ade..7e185cc2 100644 --- a/src/generated-client/models/live-tv-options.ts +++ b/src/generated-client/models/live-tv-options.ts @@ -99,5 +99,17 @@ export interface LiveTvOptions { * @memberof LiveTvOptions */ 'RecordingPostProcessorArguments'?: string | null; + /** + * + * @type {boolean} + * @memberof LiveTvOptions + */ + 'SaveRecordingNFO'?: boolean; + /** + * + * @type {boolean} + * @memberof LiveTvOptions + */ + 'SaveRecordingImages'?: boolean; } diff --git a/src/generated-client/models/log-file.ts b/src/generated-client/models/log-file.ts index 09117360..893d3126 100644 --- a/src/generated-client/models/log-file.ts +++ b/src/generated-client/models/log-file.ts @@ -42,6 +42,6 @@ export interface LogFile { * @type {string} * @memberof LogFile */ - 'Name'?: string | null; + 'Name'?: string; } diff --git a/src/generated-client/models/lyric-dto.ts b/src/generated-client/models/lyric-dto.ts new file mode 100644 index 00000000..10e54f1f --- /dev/null +++ b/src/generated-client/models/lyric-dto.ts @@ -0,0 +1,37 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { LyricLine } from './lyric-line'; +import { LyricMetadata } from './lyric-metadata'; + +/** + * LyricResponse model. + * @export + * @interface LyricDto + */ +export interface LyricDto { + /** + * + * @type {LyricMetadata} + * @memberof LyricDto + */ + 'Metadata'?: LyricMetadata; + /** + * Gets or sets a collection of individual lyric lines. + * @type {Array} + * @memberof LyricDto + */ + 'Lyrics'?: Array; +} + diff --git a/src/generated-client/models/lyric-line.ts b/src/generated-client/models/lyric-line.ts new file mode 100644 index 00000000..6b19e566 --- /dev/null +++ b/src/generated-client/models/lyric-line.ts @@ -0,0 +1,35 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + + +/** + * Lyric model. + * @export + * @interface LyricLine + */ +export interface LyricLine { + /** + * Gets the text of this lyric line. + * @type {string} + * @memberof LyricLine + */ + 'Text'?: string; + /** + * Gets the start time in ticks. + * @type {number} + * @memberof LyricLine + */ + 'Start'?: number | null; +} + diff --git a/src/generated-client/models/lyric-metadata.ts b/src/generated-client/models/lyric-metadata.ts new file mode 100644 index 00000000..f6ddfafc --- /dev/null +++ b/src/generated-client/models/lyric-metadata.ts @@ -0,0 +1,83 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + + +/** + * LyricMetadata model. + * @export + * @interface LyricMetadata + */ +export interface LyricMetadata { + /** + * Gets or sets the song artist. + * @type {string} + * @memberof LyricMetadata + */ + 'Artist'?: string | null; + /** + * Gets or sets the album this song is on. + * @type {string} + * @memberof LyricMetadata + */ + 'Album'?: string | null; + /** + * Gets or sets the title of the song. + * @type {string} + * @memberof LyricMetadata + */ + 'Title'?: string | null; + /** + * Gets or sets the author of the lyric data. + * @type {string} + * @memberof LyricMetadata + */ + 'Author'?: string | null; + /** + * Gets or sets the length of the song in ticks. + * @type {number} + * @memberof LyricMetadata + */ + 'Length'?: number | null; + /** + * Gets or sets who the LRC file was created by. + * @type {string} + * @memberof LyricMetadata + */ + 'By'?: string | null; + /** + * Gets or sets the lyric offset compared to audio in ticks. + * @type {number} + * @memberof LyricMetadata + */ + 'Offset'?: number | null; + /** + * Gets or sets the software used to create the LRC file. + * @type {string} + * @memberof LyricMetadata + */ + 'Creator'?: string | null; + /** + * Gets or sets the version of the creator used. + * @type {string} + * @memberof LyricMetadata + */ + 'Version'?: string | null; + /** + * Gets or sets a value indicating whether this lyric is synced. + * @type {boolean} + * @memberof LyricMetadata + */ + 'IsSynced'?: boolean | null; +} + diff --git a/src/generated-client/models/media-source-info.ts b/src/generated-client/models/media-source-info.ts index b29dc79a..c39b5d2b 100644 --- a/src/generated-client/models/media-source-info.ts +++ b/src/generated-client/models/media-source-info.ts @@ -17,6 +17,7 @@ import { MediaAttachment } from './media-attachment'; import { MediaProtocol } from './media-protocol'; import { MediaSourceType } from './media-source-type'; import { MediaStream } from './media-stream'; +import { MediaStreamProtocol } from './media-stream-protocol'; import { TransportStreamTimestamp } from './transport-stream-timestamp'; import { Video3DFormat } from './video3-dformat'; import { VideoType } from './video-type'; @@ -251,10 +252,10 @@ export interface MediaSourceInfo { 'TranscodingUrl'?: string | null; /** * - * @type {string} + * @type {MediaStreamProtocol} * @memberof MediaSourceInfo */ - 'TranscodingSubProtocol'?: string | null; + 'TranscodingSubProtocol'?: MediaStreamProtocol; /** * * @type {string} diff --git a/src/generated-client/models/media-stream-protocol.ts b/src/generated-client/models/media-stream-protocol.ts new file mode 100644 index 00000000..258f3b6f --- /dev/null +++ b/src/generated-client/models/media-stream-protocol.ts @@ -0,0 +1,30 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + + +/** + * Media streaming protocol. Lowercase for backwards compatibility. + * @export + * @enum {string} + */ + +export const MediaStreamProtocol = { + Http: 'http', + Hls: 'hls' +} as const; + +export type MediaStreamProtocol = typeof MediaStreamProtocol[keyof typeof MediaStreamProtocol]; + + + diff --git a/src/generated-client/models/media-stream-type.ts b/src/generated-client/models/media-stream-type.ts index a16ad47e..c60a1b9c 100644 --- a/src/generated-client/models/media-stream-type.ts +++ b/src/generated-client/models/media-stream-type.ts @@ -24,7 +24,8 @@ export const MediaStreamType = { Video: 'Video', Subtitle: 'Subtitle', EmbeddedImage: 'EmbeddedImage', - Data: 'Data' + Data: 'Data', + Lyric: 'Lyric' } as const; export type MediaStreamType = typeof MediaStreamType[keyof typeof MediaStreamType]; diff --git a/src/generated-client/models/media-stream.ts b/src/generated-client/models/media-stream.ts index c62c4c24..d6ce9771 100644 --- a/src/generated-client/models/media-stream.ts +++ b/src/generated-client/models/media-stream.ts @@ -12,8 +12,11 @@ */ +import { AudioSpatialFormat } from './audio-spatial-format'; import { MediaStreamType } from './media-stream-type'; import { SubtitleDeliveryMethod } from './subtitle-delivery-method'; +import { VideoRange } from './video-range'; +import { VideoRangeType } from './video-range-type'; /** * Class MediaStream. @@ -136,23 +139,29 @@ export interface MediaStream { */ 'Title'?: string | null; /** - * Gets the video range. - * @type {string} + * + * @type {VideoRange} * @memberof MediaStream */ - 'VideoRange'?: string | null; + 'VideoRange'?: VideoRange; /** - * Gets the video range type. - * @type {string} + * + * @type {VideoRangeType} * @memberof MediaStream */ - 'VideoRangeType'?: string | null; + 'VideoRangeType'?: VideoRangeType; /** * Gets the video dovi title. * @type {string} * @memberof MediaStream */ 'VideoDoViTitle'?: string | null; + /** + * + * @type {AudioSpatialFormat} + * @memberof MediaStream + */ + 'AudioSpatialFormat'?: AudioSpatialFormat; /** * * @type {string} @@ -177,6 +186,12 @@ export interface MediaStream { * @memberof MediaStream */ 'LocalizedExternal'?: string | null; + /** + * + * @type {string} + * @memberof MediaStream + */ + 'LocalizedHearingImpaired'?: string | null; /** * * @type {string} @@ -255,6 +270,12 @@ export interface MediaStream { * @memberof MediaStream */ 'IsForced'?: boolean; + /** + * Gets or sets a value indicating whether this instance is for the hearing impaired. + * @type {boolean} + * @memberof MediaStream + */ + 'IsHearingImpaired'?: boolean; /** * Gets or sets the height. * @type {number} diff --git a/src/generated-client/models/media-type.ts b/src/generated-client/models/media-type.ts new file mode 100644 index 00000000..0addb4fd --- /dev/null +++ b/src/generated-client/models/media-type.ts @@ -0,0 +1,33 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + + +/** + * Media types. + * @export + * @enum {string} + */ + +export const MediaType = { + Unknown: 'Unknown', + Video: 'Video', + Audio: 'Audio', + Photo: 'Photo', + Book: 'Book' +} as const; + +export type MediaType = typeof MediaType[keyof typeof MediaType]; + + + diff --git a/src/generated-client/models/metadata-editor-info.ts b/src/generated-client/models/metadata-editor-info.ts index a2f70253..a416877d 100644 --- a/src/generated-client/models/metadata-editor-info.ts +++ b/src/generated-client/models/metadata-editor-info.ts @@ -12,6 +12,7 @@ */ +import { CollectionType } from './collection-type'; import { CountryInfo } from './country-info'; import { CultureDto } from './culture-dto'; import { ExternalIdInfo } from './external-id-info'; @@ -50,10 +51,10 @@ export interface MetadataEditorInfo { 'ExternalIdInfos'?: Array; /** * - * @type {string} + * @type {CollectionType} * @memberof MetadataEditorInfo */ - 'ContentType'?: string | null; + 'ContentType'?: CollectionType; /** * * @type {Array} diff --git a/src/generated-client/models/network-configuration.ts b/src/generated-client/models/network-configuration.ts index a8f302f2..1599a63b 100644 --- a/src/generated-client/models/network-configuration.ts +++ b/src/generated-client/models/network-configuration.ts @@ -14,11 +14,23 @@ /** - * Defines the Jellyfin.Networking.Configuration.NetworkConfiguration. + * Defines the MediaBrowser.Common.Net.NetworkConfiguration. * @export * @interface NetworkConfiguration */ export interface NetworkConfiguration { + /** + * Gets or sets a value used to specify the URL prefix that your Jellyfin instance can be accessed at. + * @type {string} + * @memberof NetworkConfiguration + */ + 'BaseUrl'?: string; + /** + * Gets or sets a value indicating whether to use HTTPS. + * @type {boolean} + * @memberof NetworkConfiguration + */ + 'EnableHttps'?: boolean; /** * Gets or sets a value indicating whether the server should force connections over HTTPS. * @type {boolean} @@ -32,161 +44,41 @@ export interface NetworkConfiguration { */ 'CertificatePath'?: string; /** - * Gets or sets the password required to access the X.509 certificate data in the file specified by Jellyfin.Networking.Configuration.NetworkConfiguration.CertificatePath. + * Gets or sets the password required to access the X.509 certificate data in the file specified by MediaBrowser.Common.Net.NetworkConfiguration.CertificatePath. * @type {string} * @memberof NetworkConfiguration */ 'CertificatePassword'?: string; /** - * Gets or sets a value used to specify the URL prefix that your Jellyfin instance can be accessed at. - * @type {string} + * Gets or sets the internal HTTP server port. + * @type {number} * @memberof NetworkConfiguration */ - 'BaseUrl'?: string; + 'InternalHttpPort'?: number; + /** + * Gets or sets the internal HTTPS server port. + * @type {number} + * @memberof NetworkConfiguration + */ + 'InternalHttpsPort'?: number; + /** + * Gets or sets the public HTTP port. + * @type {number} + * @memberof NetworkConfiguration + */ + 'PublicHttpPort'?: number; /** * Gets or sets the public HTTPS port. * @type {number} * @memberof NetworkConfiguration */ 'PublicHttpsPort'?: number; - /** - * Gets or sets the HTTP server port number. - * @type {number} - * @memberof NetworkConfiguration - */ - 'HttpServerPortNumber'?: number; - /** - * Gets or sets the HTTPS server port number. - * @type {number} - * @memberof NetworkConfiguration - */ - 'HttpsPortNumber'?: number; - /** - * Gets or sets a value indicating whether to use HTTPS. - * @type {boolean} - * @memberof NetworkConfiguration - */ - 'EnableHttps'?: boolean; - /** - * Gets or sets the public mapped port. - * @type {number} - * @memberof NetworkConfiguration - */ - 'PublicPort'?: number; - /** - * Gets or sets a value indicating whether the http port should be mapped as part of UPnP automatic port forwarding. - * @type {boolean} - * @memberof NetworkConfiguration - */ - 'UPnPCreateHttpPortMap'?: boolean; - /** - * Gets or sets the UDPPortRange. - * @type {string} - * @memberof NetworkConfiguration - */ - 'UDPPortRange'?: string; - /** - * Gets or sets a value indicating whether gets or sets IPV6 capability. - * @type {boolean} - * @memberof NetworkConfiguration - */ - 'EnableIPV6'?: boolean; - /** - * Gets or sets a value indicating whether gets or sets IPV4 capability. - * @type {boolean} - * @memberof NetworkConfiguration - */ - 'EnableIPV4'?: boolean; - /** - * Gets or sets a value indicating whether detailed SSDP logs are sent to the console/log. \"Emby.Dlna\": \"Debug\" must be set in logging.default.json for this property to have any effect. - * @type {boolean} - * @memberof NetworkConfiguration - */ - 'EnableSSDPTracing'?: boolean; - /** - * Gets or sets the SSDPTracingFilter Gets or sets a value indicating whether an IP address is to be used to filter the detailed ssdp logs that are being sent to the console/log. If the setting \"Emby.Dlna\": \"Debug\" msut be set in logging.default.json for this property to work. - * @type {string} - * @memberof NetworkConfiguration - */ - 'SSDPTracingFilter'?: string; - /** - * Gets or sets the number of times SSDP UDP messages are sent. - * @type {number} - * @memberof NetworkConfiguration - */ - 'UDPSendCount'?: number; - /** - * Gets or sets the delay between each groups of SSDP messages (in ms). - * @type {number} - * @memberof NetworkConfiguration - */ - 'UDPSendDelay'?: number; - /** - * Gets or sets a value indicating whether address names that match Jellyfin.Networking.Configuration.NetworkConfiguration.VirtualInterfaceNames should be Ignore for the purposes of binding. - * @type {boolean} - * @memberof NetworkConfiguration - */ - 'IgnoreVirtualInterfaces'?: boolean; - /** - * Gets or sets a value indicating the interfaces that should be ignored. The list can be comma separated. . - * @type {string} - * @memberof NetworkConfiguration - */ - 'VirtualInterfaceNames'?: string; - /** - * Gets or sets the time (in seconds) between the pings of SSDP gateway monitor. - * @type {number} - * @memberof NetworkConfiguration - */ - 'GatewayMonitorPeriod'?: number; - /** - * Gets a value indicating whether multi-socket binding is available. - * @type {boolean} - * @memberof NetworkConfiguration - */ - 'EnableMultiSocketBinding'?: boolean; - /** - * Gets or sets a value indicating whether all IPv6 interfaces should be treated as on the internal network. Depending on the address range implemented ULA ranges might not be used. - * @type {boolean} - * @memberof NetworkConfiguration - */ - 'TrustAllIP6Interfaces'?: boolean; - /** - * Gets or sets the ports that HDHomerun uses. - * @type {string} - * @memberof NetworkConfiguration - */ - 'HDHomerunPortRange'?: string; - /** - * Gets or sets the PublishedServerUriBySubnet Gets or sets PublishedServerUri to advertise for specific subnets. - * @type {Array} - * @memberof NetworkConfiguration - */ - 'PublishedServerUriBySubnet'?: Array; - /** - * Gets or sets a value indicating whether Autodiscovery tracing is enabled. - * @type {boolean} - * @memberof NetworkConfiguration - */ - 'AutoDiscoveryTracing'?: boolean; /** * Gets or sets a value indicating whether Autodiscovery is enabled. * @type {boolean} * @memberof NetworkConfiguration */ 'AutoDiscovery'?: boolean; - /** - * Gets or sets the filter for remote IP connectivity. Used in conjuntion with . - * @type {Array} - * @memberof NetworkConfiguration - */ - 'RemoteIPFilter'?: Array; - /** - * Gets or sets a value indicating whether contains a blacklist or a whitelist. Default is a whitelist. - * @type {boolean} - * @memberof NetworkConfiguration - */ - 'IsRemoteIPFilterBlacklist'?: boolean; /** * Gets or sets a value indicating whether to enable automatic port forwarding. * @type {boolean} @@ -194,7 +86,19 @@ export interface NetworkConfiguration { */ 'EnableUPnP'?: boolean; /** - * Gets or sets a value indicating whether access outside of the LAN is permitted. + * Gets or sets a value indicating whether IPv6 is enabled. + * @type {boolean} + * @memberof NetworkConfiguration + */ + 'EnableIPv4'?: boolean; + /** + * Gets or sets a value indicating whether IPv6 is enabled. + * @type {boolean} + * @memberof NetworkConfiguration + */ + 'EnableIPv6'?: boolean; + /** + * Gets or sets a value indicating whether access from outside of the LAN is permitted. * @type {boolean} * @memberof NetworkConfiguration */ @@ -212,16 +116,46 @@ export interface NetworkConfiguration { */ 'LocalNetworkAddresses'?: Array; /** - * Gets or sets the known proxies. If the proxy is a network, it\'s added to the KnownNetworks. + * Gets or sets the known proxies. * @type {Array} * @memberof NetworkConfiguration */ 'KnownProxies'?: Array; + /** + * Gets or sets a value indicating whether address names that match MediaBrowser.Common.Net.NetworkConfiguration.VirtualInterfaceNames should be ignored for the purposes of binding. + * @type {boolean} + * @memberof NetworkConfiguration + */ + 'IgnoreVirtualInterfaces'?: boolean; + /** + * Gets or sets a value indicating the interface name prefixes that should be ignored. The list can be comma separated and values are case-insensitive. . + * @type {Array} + * @memberof NetworkConfiguration + */ + 'VirtualInterfaceNames'?: Array; /** * Gets or sets a value indicating whether the published server uri is based on information in HTTP requests. * @type {boolean} * @memberof NetworkConfiguration */ 'EnablePublishedServerUriByRequest'?: boolean; + /** + * Gets or sets the PublishedServerUriBySubnet Gets or sets PublishedServerUri to advertise for specific subnets. + * @type {Array} + * @memberof NetworkConfiguration + */ + 'PublishedServerUriBySubnet'?: Array; + /** + * Gets or sets the filter for remote IP connectivity. Used in conjunction with . + * @type {Array} + * @memberof NetworkConfiguration + */ + 'RemoteIPFilter'?: Array; + /** + * Gets or sets a value indicating whether contains a blacklist or a whitelist. Default is a whitelist. + * @type {boolean} + * @memberof NetworkConfiguration + */ + 'IsRemoteIPFilterBlacklist'?: boolean; } diff --git a/src/generated-client/models/outbound-keep-alive-message.ts b/src/generated-client/models/outbound-keep-alive-message.ts new file mode 100644 index 00000000..561b44b5 --- /dev/null +++ b/src/generated-client/models/outbound-keep-alive-message.ts @@ -0,0 +1,36 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { SessionMessageType } from './session-message-type'; + +/** + * Keep alive websocket messages. + * @export + * @interface OutboundKeepAliveMessage + */ +export interface OutboundKeepAliveMessage { + /** + * Gets or sets the message id. + * @type {string} + * @memberof OutboundKeepAliveMessage + */ + 'MessageId'?: string; + /** + * + * @type {SessionMessageType} + * @memberof OutboundKeepAliveMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/outbound-web-socket-message.ts b/src/generated-client/models/outbound-web-socket-message.ts new file mode 100644 index 00000000..c9d3a05b --- /dev/null +++ b/src/generated-client/models/outbound-web-socket-message.ts @@ -0,0 +1,53 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { ActivityLogEntryMessage } from './activity-log-entry-message'; +import { ForceKeepAliveMessage } from './force-keep-alive-message'; +import { GeneralCommandMessage } from './general-command-message'; +import { LibraryChangedMessage } from './library-changed-message'; +import { OutboundKeepAliveMessage } from './outbound-keep-alive-message'; +import { PlayMessage } from './play-message'; +import { PlaystateMessage } from './playstate-message'; +import { PluginInstallationCancelledMessage } from './plugin-installation-cancelled-message'; +import { PluginInstallationCompletedMessage } from './plugin-installation-completed-message'; +import { PluginInstallationFailedMessage } from './plugin-installation-failed-message'; +import { PluginInstallingMessage } from './plugin-installing-message'; +import { PluginUninstalledMessage } from './plugin-uninstalled-message'; +import { RefreshProgressMessage } from './refresh-progress-message'; +import { RestartRequiredMessage } from './restart-required-message'; +import { ScheduledTaskEndedMessage } from './scheduled-task-ended-message'; +import { ScheduledTasksInfoMessage } from './scheduled-tasks-info-message'; +import { SeriesTimerCancelledMessage } from './series-timer-cancelled-message'; +import { SeriesTimerCreatedMessage } from './series-timer-created-message'; +import { ServerRestartingMessage } from './server-restarting-message'; +import { ServerShuttingDownMessage } from './server-shutting-down-message'; +import { SessionMessageType } from './session-message-type'; +import { SessionsMessage } from './sessions-message'; +import { SyncPlayCommandMessage } from './sync-play-command-message'; +import { SyncPlayGroupUpdateCommandMessage } from './sync-play-group-update-command-message'; +import { TimerCancelledMessage } from './timer-cancelled-message'; +import { TimerCreatedMessage } from './timer-created-message'; +import { UserDataChangedMessage } from './user-data-changed-message'; +import { UserDeletedMessage } from './user-deleted-message'; +import { UserDto } from './user-dto'; +import { UserUpdatedMessage } from './user-updated-message'; + +/** + * @type OutboundWebSocketMessage + * Represents the list of possible outbound websocket types + * @export + */ +export type OutboundWebSocketMessage = ActivityLogEntryMessage | ForceKeepAliveMessage | GeneralCommandMessage | LibraryChangedMessage | OutboundKeepAliveMessage | PlayMessage | PlaystateMessage | PluginInstallationCancelledMessage | PluginInstallationCompletedMessage | PluginInstallationFailedMessage | PluginInstallingMessage | PluginUninstalledMessage | RefreshProgressMessage | RestartRequiredMessage | ScheduledTaskEndedMessage | ScheduledTasksInfoMessage | SeriesTimerCancelledMessage | SeriesTimerCreatedMessage | ServerRestartingMessage | ServerShuttingDownMessage | SessionsMessage | SyncPlayCommandMessage | SyncPlayGroupUpdateCommandMessage | TimerCancelledMessage | TimerCreatedMessage | UserDataChangedMessage | UserDeletedMessage | UserUpdatedMessage; + + diff --git a/src/generated-client/models/parental-rating.ts b/src/generated-client/models/parental-rating.ts index 2ff4fc4c..85359c5c 100644 --- a/src/generated-client/models/parental-rating.ts +++ b/src/generated-client/models/parental-rating.ts @@ -30,6 +30,6 @@ export interface ParentalRating { * @type {number} * @memberof ParentalRating */ - 'Value'?: number; + 'Value'?: number | null; } diff --git a/src/generated-client/models/person-kind.ts b/src/generated-client/models/person-kind.ts new file mode 100644 index 00000000..4c5f0260 --- /dev/null +++ b/src/generated-client/models/person-kind.ts @@ -0,0 +1,53 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + + +/** + * The person kind. + * @export + * @enum {string} + */ + +export const PersonKind = { + Unknown: 'Unknown', + Actor: 'Actor', + Director: 'Director', + Composer: 'Composer', + Writer: 'Writer', + GuestStar: 'GuestStar', + Producer: 'Producer', + Conductor: 'Conductor', + Lyricist: 'Lyricist', + Arranger: 'Arranger', + Engineer: 'Engineer', + Mixer: 'Mixer', + Remixer: 'Remixer', + Creator: 'Creator', + Artist: 'Artist', + AlbumArtist: 'AlbumArtist', + Author: 'Author', + Illustrator: 'Illustrator', + Penciller: 'Penciller', + Inker: 'Inker', + Colorist: 'Colorist', + Letterer: 'Letterer', + CoverArtist: 'CoverArtist', + Editor: 'Editor', + Translator: 'Translator' +} as const; + +export type PersonKind = typeof PersonKind[keyof typeof PersonKind]; + + + diff --git a/src/generated-client/models/play-message.ts b/src/generated-client/models/play-message.ts new file mode 100644 index 00000000..9cf8d3b9 --- /dev/null +++ b/src/generated-client/models/play-message.ts @@ -0,0 +1,43 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { PlayRequest } from './play-request'; +import { SessionMessageType } from './session-message-type'; + +/** + * Play command websocket message. + * @export + * @interface PlayMessage + */ +export interface PlayMessage { + /** + * + * @type {PlayRequest} + * @memberof PlayMessage + */ + 'Data'?: PlayRequest; + /** + * Gets or sets the message id. + * @type {string} + * @memberof PlayMessage + */ + 'MessageId'?: string; + /** + * + * @type {SessionMessageType} + * @memberof PlayMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/play-queue-update-group-update.ts b/src/generated-client/models/play-queue-update-group-update.ts new file mode 100644 index 00000000..7d170869 --- /dev/null +++ b/src/generated-client/models/play-queue-update-group-update.ts @@ -0,0 +1,43 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { GroupUpdateType } from './group-update-type'; +import { PlayQueueUpdate } from './play-queue-update'; + +/** + * Class GroupUpdate. + * @export + * @interface PlayQueueUpdateGroupUpdate + */ +export interface PlayQueueUpdateGroupUpdate { + /** + * Gets the group identifier. + * @type {string} + * @memberof PlayQueueUpdateGroupUpdate + */ + 'GroupId'?: string; + /** + * + * @type {GroupUpdateType} + * @memberof PlayQueueUpdateGroupUpdate + */ + 'Type'?: GroupUpdateType; + /** + * + * @type {PlayQueueUpdate} + * @memberof PlayQueueUpdateGroupUpdate + */ + 'Data'?: PlayQueueUpdate; +} + diff --git a/src/generated-client/models/play-queue-update-reason.ts b/src/generated-client/models/play-queue-update-reason.ts new file mode 100644 index 00000000..ea7820f3 --- /dev/null +++ b/src/generated-client/models/play-queue-update-reason.ts @@ -0,0 +1,38 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + + +/** + * Enum PlayQueueUpdateReason. + * @export + * @enum {string} + */ + +export const PlayQueueUpdateReason = { + NewPlaylist: 'NewPlaylist', + SetCurrentItem: 'SetCurrentItem', + RemoveItems: 'RemoveItems', + MoveItem: 'MoveItem', + Queue: 'Queue', + QueueNext: 'QueueNext', + NextItem: 'NextItem', + PreviousItem: 'PreviousItem', + RepeatMode: 'RepeatMode', + ShuffleMode: 'ShuffleMode' +} as const; + +export type PlayQueueUpdateReason = typeof PlayQueueUpdateReason[keyof typeof PlayQueueUpdateReason]; + + + diff --git a/src/generated-client/models/play-queue-update.ts b/src/generated-client/models/play-queue-update.ts new file mode 100644 index 00000000..f83db7da --- /dev/null +++ b/src/generated-client/models/play-queue-update.ts @@ -0,0 +1,75 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { GroupRepeatMode } from './group-repeat-mode'; +import { GroupShuffleMode } from './group-shuffle-mode'; +import { PlayQueueUpdateReason } from './play-queue-update-reason'; +import { SyncPlayQueueItem } from './sync-play-queue-item'; + +/** + * Class PlayQueueUpdate. + * @export + * @interface PlayQueueUpdate + */ +export interface PlayQueueUpdate { + /** + * + * @type {PlayQueueUpdateReason} + * @memberof PlayQueueUpdate + */ + 'Reason'?: PlayQueueUpdateReason; + /** + * Gets the UTC time of the last change to the playing queue. + * @type {string} + * @memberof PlayQueueUpdate + */ + 'LastUpdate'?: string; + /** + * Gets the playlist. + * @type {Array} + * @memberof PlayQueueUpdate + */ + 'Playlist'?: Array; + /** + * Gets the playing item index in the playlist. + * @type {number} + * @memberof PlayQueueUpdate + */ + 'PlayingItemIndex'?: number; + /** + * Gets the start position ticks. + * @type {number} + * @memberof PlayQueueUpdate + */ + 'StartPositionTicks'?: number; + /** + * Gets a value indicating whether the current item is playing. + * @type {boolean} + * @memberof PlayQueueUpdate + */ + 'IsPlaying'?: boolean; + /** + * + * @type {GroupShuffleMode} + * @memberof PlayQueueUpdate + */ + 'ShuffleMode'?: GroupShuffleMode; + /** + * + * @type {GroupRepeatMode} + * @memberof PlayQueueUpdate + */ + 'RepeatMode'?: GroupRepeatMode; +} + diff --git a/src/generated-client/models/playback-order.ts b/src/generated-client/models/playback-order.ts new file mode 100644 index 00000000..8574591e --- /dev/null +++ b/src/generated-client/models/playback-order.ts @@ -0,0 +1,30 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + + +/** + * Enum PlaybackOrder. + * @export + * @enum {string} + */ + +export const PlaybackOrder = { + Default: 'Default', + Shuffle: 'Shuffle' +} as const; + +export type PlaybackOrder = typeof PlaybackOrder[keyof typeof PlaybackOrder]; + + + diff --git a/src/generated-client/models/playback-progress-info.ts b/src/generated-client/models/playback-progress-info.ts index aab94dbb..bb59b445 100644 --- a/src/generated-client/models/playback-progress-info.ts +++ b/src/generated-client/models/playback-progress-info.ts @@ -14,6 +14,7 @@ import { BaseItemDto } from './base-item-dto'; import { PlayMethod } from './play-method'; +import { PlaybackOrder } from './playback-order'; import { QueueItem } from './queue-item'; import { RepeatMode } from './repeat-mode'; @@ -131,6 +132,12 @@ export interface PlaybackProgressInfo { * @memberof PlaybackProgressInfo */ 'RepeatMode'?: RepeatMode; + /** + * + * @type {PlaybackOrder} + * @memberof PlaybackProgressInfo + */ + 'PlaybackOrder'?: PlaybackOrder; /** * * @type {Array} diff --git a/src/generated-client/models/playback-request-type.ts b/src/generated-client/models/playback-request-type.ts new file mode 100644 index 00000000..2efa5cf2 --- /dev/null +++ b/src/generated-client/models/playback-request-type.ts @@ -0,0 +1,45 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + + +/** + * Enum PlaybackRequestType. + * @export + * @enum {string} + */ + +export const PlaybackRequestType = { + Play: 'Play', + SetPlaylistItem: 'SetPlaylistItem', + RemoveFromPlaylist: 'RemoveFromPlaylist', + MovePlaylistItem: 'MovePlaylistItem', + Queue: 'Queue', + Unpause: 'Unpause', + Pause: 'Pause', + Stop: 'Stop', + Seek: 'Seek', + Buffer: 'Buffer', + Ready: 'Ready', + NextItem: 'NextItem', + PreviousItem: 'PreviousItem', + SetRepeatMode: 'SetRepeatMode', + SetShuffleMode: 'SetShuffleMode', + Ping: 'Ping', + IgnoreWait: 'IgnoreWait' +} as const; + +export type PlaybackRequestType = typeof PlaybackRequestType[keyof typeof PlaybackRequestType]; + + + diff --git a/src/generated-client/models/playback-start-info.ts b/src/generated-client/models/playback-start-info.ts index 08d52a2b..a13f6739 100644 --- a/src/generated-client/models/playback-start-info.ts +++ b/src/generated-client/models/playback-start-info.ts @@ -14,6 +14,7 @@ import { BaseItemDto } from './base-item-dto'; import { PlayMethod } from './play-method'; +import { PlaybackOrder } from './playback-order'; import { QueueItem } from './queue-item'; import { RepeatMode } from './repeat-mode'; @@ -131,6 +132,12 @@ export interface PlaybackStartInfo { * @memberof PlaybackStartInfo */ 'RepeatMode'?: RepeatMode; + /** + * + * @type {PlaybackOrder} + * @memberof PlaybackStartInfo + */ + 'PlaybackOrder'?: PlaybackOrder; /** * * @type {Array} diff --git a/src/generated-client/models/player-state-info.ts b/src/generated-client/models/player-state-info.ts index a27c51bf..167dd1bc 100644 --- a/src/generated-client/models/player-state-info.ts +++ b/src/generated-client/models/player-state-info.ts @@ -13,6 +13,7 @@ import { PlayMethod } from './play-method'; +import { PlaybackOrder } from './playback-order'; import { RepeatMode } from './repeat-mode'; /** @@ -81,6 +82,12 @@ export interface PlayerStateInfo { * @memberof PlayerStateInfo */ 'RepeatMode'?: RepeatMode; + /** + * + * @type {PlaybackOrder} + * @memberof PlayerStateInfo + */ + 'PlaybackOrder'?: PlaybackOrder; /** * Gets or sets the now playing live stream identifier. * @type {string} diff --git a/src/generated-client/models/playlist-user-permissions.ts b/src/generated-client/models/playlist-user-permissions.ts new file mode 100644 index 00000000..7ce531f2 --- /dev/null +++ b/src/generated-client/models/playlist-user-permissions.ts @@ -0,0 +1,35 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + + +/** + * Class to hold data on user permissions for playlists. + * @export + * @interface PlaylistUserPermissions + */ +export interface PlaylistUserPermissions { + /** + * Gets or sets the user id. + * @type {string} + * @memberof PlaylistUserPermissions + */ + 'UserId'?: string; + /** + * Gets or sets a value indicating whether the user has edit permissions. + * @type {boolean} + * @memberof PlaylistUserPermissions + */ + 'CanEdit'?: boolean; +} + diff --git a/src/generated-client/models/playstate-message.ts b/src/generated-client/models/playstate-message.ts new file mode 100644 index 00000000..a7af6fa5 --- /dev/null +++ b/src/generated-client/models/playstate-message.ts @@ -0,0 +1,43 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { PlaystateRequest } from './playstate-request'; +import { SessionMessageType } from './session-message-type'; + +/** + * Playstate message. + * @export + * @interface PlaystateMessage + */ +export interface PlaystateMessage { + /** + * + * @type {PlaystateRequest} + * @memberof PlaystateMessage + */ + 'Data'?: PlaystateRequest; + /** + * Gets or sets the message id. + * @type {string} + * @memberof PlaystateMessage + */ + 'MessageId'?: string; + /** + * + * @type {SessionMessageType} + * @memberof PlaystateMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/plugin-installation-cancelled-message.ts b/src/generated-client/models/plugin-installation-cancelled-message.ts new file mode 100644 index 00000000..c67d6f74 --- /dev/null +++ b/src/generated-client/models/plugin-installation-cancelled-message.ts @@ -0,0 +1,43 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { InstallationInfo } from './installation-info'; +import { SessionMessageType } from './session-message-type'; + +/** + * Plugin installation cancelled message. + * @export + * @interface PluginInstallationCancelledMessage + */ +export interface PluginInstallationCancelledMessage { + /** + * + * @type {InstallationInfo} + * @memberof PluginInstallationCancelledMessage + */ + 'Data'?: InstallationInfo; + /** + * Gets or sets the message id. + * @type {string} + * @memberof PluginInstallationCancelledMessage + */ + 'MessageId'?: string; + /** + * + * @type {SessionMessageType} + * @memberof PluginInstallationCancelledMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/plugin-installation-completed-message.ts b/src/generated-client/models/plugin-installation-completed-message.ts new file mode 100644 index 00000000..6b3251bd --- /dev/null +++ b/src/generated-client/models/plugin-installation-completed-message.ts @@ -0,0 +1,43 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { InstallationInfo } from './installation-info'; +import { SessionMessageType } from './session-message-type'; + +/** + * Plugin installation completed message. + * @export + * @interface PluginInstallationCompletedMessage + */ +export interface PluginInstallationCompletedMessage { + /** + * + * @type {InstallationInfo} + * @memberof PluginInstallationCompletedMessage + */ + 'Data'?: InstallationInfo; + /** + * Gets or sets the message id. + * @type {string} + * @memberof PluginInstallationCompletedMessage + */ + 'MessageId'?: string; + /** + * + * @type {SessionMessageType} + * @memberof PluginInstallationCompletedMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/plugin-installation-failed-message.ts b/src/generated-client/models/plugin-installation-failed-message.ts new file mode 100644 index 00000000..4a9d27e3 --- /dev/null +++ b/src/generated-client/models/plugin-installation-failed-message.ts @@ -0,0 +1,43 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { InstallationInfo } from './installation-info'; +import { SessionMessageType } from './session-message-type'; + +/** + * Plugin installation failed message. + * @export + * @interface PluginInstallationFailedMessage + */ +export interface PluginInstallationFailedMessage { + /** + * + * @type {InstallationInfo} + * @memberof PluginInstallationFailedMessage + */ + 'Data'?: InstallationInfo; + /** + * Gets or sets the message id. + * @type {string} + * @memberof PluginInstallationFailedMessage + */ + 'MessageId'?: string; + /** + * + * @type {SessionMessageType} + * @memberof PluginInstallationFailedMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/plugin-installing-message.ts b/src/generated-client/models/plugin-installing-message.ts new file mode 100644 index 00000000..db43e09f --- /dev/null +++ b/src/generated-client/models/plugin-installing-message.ts @@ -0,0 +1,43 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { InstallationInfo } from './installation-info'; +import { SessionMessageType } from './session-message-type'; + +/** + * Package installing message. + * @export + * @interface PluginInstallingMessage + */ +export interface PluginInstallingMessage { + /** + * + * @type {InstallationInfo} + * @memberof PluginInstallingMessage + */ + 'Data'?: InstallationInfo; + /** + * Gets or sets the message id. + * @type {string} + * @memberof PluginInstallingMessage + */ + 'MessageId'?: string; + /** + * + * @type {SessionMessageType} + * @memberof PluginInstallingMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/plugin-uninstalled-message.ts b/src/generated-client/models/plugin-uninstalled-message.ts new file mode 100644 index 00000000..b7f00b95 --- /dev/null +++ b/src/generated-client/models/plugin-uninstalled-message.ts @@ -0,0 +1,43 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { PluginInfo } from './plugin-info'; +import { SessionMessageType } from './session-message-type'; + +/** + * Plugin uninstalled message. + * @export + * @interface PluginUninstalledMessage + */ +export interface PluginUninstalledMessage { + /** + * + * @type {PluginInfo} + * @memberof PluginUninstalledMessage + */ + 'Data'?: PluginInfo; + /** + * Gets or sets the message id. + * @type {string} + * @memberof PluginUninstalledMessage + */ + 'MessageId'?: string; + /** + * + * @type {SessionMessageType} + * @memberof PluginUninstalledMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/process-priority-class.ts b/src/generated-client/models/process-priority-class.ts new file mode 100644 index 00000000..9439f50f --- /dev/null +++ b/src/generated-client/models/process-priority-class.ts @@ -0,0 +1,34 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + + +/** + * + * @export + * @enum {string} + */ + +export const ProcessPriorityClass = { + Normal: 'Normal', + Idle: 'Idle', + High: 'High', + RealTime: 'RealTime', + BelowNormal: 'BelowNormal', + AboveNormal: 'AboveNormal' +} as const; + +export type ProcessPriorityClass = typeof ProcessPriorityClass[keyof typeof ProcessPriorityClass]; + + + diff --git a/src/generated-client/models/public-system-info.ts b/src/generated-client/models/public-system-info.ts index 23ddef33..0a19e7e4 100644 --- a/src/generated-client/models/public-system-info.ts +++ b/src/generated-client/models/public-system-info.ts @@ -47,6 +47,7 @@ export interface PublicSystemInfo { * Gets or sets the operating system. * @type {string} * @memberof PublicSystemInfo + * @deprecated */ 'OperatingSystem'?: string | null; /** diff --git a/src/generated-client/models/refresh-progress-message.ts b/src/generated-client/models/refresh-progress-message.ts new file mode 100644 index 00000000..23ed7c5d --- /dev/null +++ b/src/generated-client/models/refresh-progress-message.ts @@ -0,0 +1,42 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { SessionMessageType } from './session-message-type'; + +/** + * Refresh progress message. + * @export + * @interface RefreshProgressMessage + */ +export interface RefreshProgressMessage { + /** + * Gets or sets the data. + * @type {{ [key: string]: string; }} + * @memberof RefreshProgressMessage + */ + 'Data'?: { [key: string]: string; } | null; + /** + * Gets or sets the message id. + * @type {string} + * @memberof RefreshProgressMessage + */ + 'MessageId'?: string; + /** + * + * @type {SessionMessageType} + * @memberof RefreshProgressMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/remote-lyric-info-dto.ts b/src/generated-client/models/remote-lyric-info-dto.ts new file mode 100644 index 00000000..9407e73d --- /dev/null +++ b/src/generated-client/models/remote-lyric-info-dto.ts @@ -0,0 +1,42 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { LyricDto } from './lyric-dto'; + +/** + * The remote lyric info dto. + * @export + * @interface RemoteLyricInfoDto + */ +export interface RemoteLyricInfoDto { + /** + * Gets or sets the id for the lyric. + * @type {string} + * @memberof RemoteLyricInfoDto + */ + 'Id'?: string; + /** + * Gets the provider name. + * @type {string} + * @memberof RemoteLyricInfoDto + */ + 'ProviderName'?: string; + /** + * + * @type {LyricDto} + * @memberof RemoteLyricInfoDto + */ + 'Lyrics'?: LyricDto; +} + diff --git a/src/generated-client/models/remote-subtitle-info.ts b/src/generated-client/models/remote-subtitle-info.ts index 5e9a8d18..2bf03674 100644 --- a/src/generated-client/models/remote-subtitle-info.ts +++ b/src/generated-client/models/remote-subtitle-info.ts @@ -73,6 +73,12 @@ export interface RemoteSubtitleInfo { * @memberof RemoteSubtitleInfo */ 'CommunityRating'?: number | null; + /** + * + * @type {number} + * @memberof RemoteSubtitleInfo + */ + 'FrameRate'?: number | null; /** * * @type {number} @@ -85,5 +91,29 @@ export interface RemoteSubtitleInfo { * @memberof RemoteSubtitleInfo */ 'IsHashMatch'?: boolean | null; + /** + * + * @type {boolean} + * @memberof RemoteSubtitleInfo + */ + 'AiTranslated'?: boolean | null; + /** + * + * @type {boolean} + * @memberof RemoteSubtitleInfo + */ + 'MachineTranslated'?: boolean | null; + /** + * + * @type {boolean} + * @memberof RemoteSubtitleInfo + */ + 'Forced'?: boolean | null; + /** + * + * @type {boolean} + * @memberof RemoteSubtitleInfo + */ + 'HearingImpaired'?: boolean | null; } diff --git a/src/generated-client/models/remove-from-playlist-request-dto.ts b/src/generated-client/models/remove-from-playlist-request-dto.ts index a71f8d08..815ca1dc 100644 --- a/src/generated-client/models/remove-from-playlist-request-dto.ts +++ b/src/generated-client/models/remove-from-playlist-request-dto.ts @@ -20,7 +20,7 @@ */ export interface RemoveFromPlaylistRequestDto { /** - * Gets or sets the playlist identifiers ot the items. Ignored when clearing the playlist. + * Gets or sets the playlist identifiers of the items. Ignored when clearing the playlist. * @type {Array} * @memberof RemoveFromPlaylistRequestDto */ diff --git a/src/generated-client/models/restart-required-message.ts b/src/generated-client/models/restart-required-message.ts new file mode 100644 index 00000000..e8338840 --- /dev/null +++ b/src/generated-client/models/restart-required-message.ts @@ -0,0 +1,36 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { SessionMessageType } from './session-message-type'; + +/** + * Restart required. + * @export + * @interface RestartRequiredMessage + */ +export interface RestartRequiredMessage { + /** + * Gets or sets the message id. + * @type {string} + * @memberof RestartRequiredMessage + */ + 'MessageId'?: string; + /** + * + * @type {SessionMessageType} + * @memberof RestartRequiredMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/scheduled-task-ended-message.ts b/src/generated-client/models/scheduled-task-ended-message.ts new file mode 100644 index 00000000..2e746e96 --- /dev/null +++ b/src/generated-client/models/scheduled-task-ended-message.ts @@ -0,0 +1,43 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { SessionMessageType } from './session-message-type'; +import { TaskResult } from './task-result'; + +/** + * Scheduled task ended message. + * @export + * @interface ScheduledTaskEndedMessage + */ +export interface ScheduledTaskEndedMessage { + /** + * + * @type {TaskResult} + * @memberof ScheduledTaskEndedMessage + */ + 'Data'?: TaskResult; + /** + * Gets or sets the message id. + * @type {string} + * @memberof ScheduledTaskEndedMessage + */ + 'MessageId'?: string; + /** + * + * @type {SessionMessageType} + * @memberof ScheduledTaskEndedMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/scheduled-tasks-info-message.ts b/src/generated-client/models/scheduled-tasks-info-message.ts new file mode 100644 index 00000000..7f74ed39 --- /dev/null +++ b/src/generated-client/models/scheduled-tasks-info-message.ts @@ -0,0 +1,43 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { SessionMessageType } from './session-message-type'; +import { TaskInfo } from './task-info'; + +/** + * Scheduled tasks info message. + * @export + * @interface ScheduledTasksInfoMessage + */ +export interface ScheduledTasksInfoMessage { + /** + * Gets or sets the data. + * @type {Array} + * @memberof ScheduledTasksInfoMessage + */ + 'Data'?: Array | null; + /** + * Gets or sets the message id. + * @type {string} + * @memberof ScheduledTasksInfoMessage + */ + 'MessageId'?: string; + /** + * + * @type {SessionMessageType} + * @memberof ScheduledTasksInfoMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/scheduled-tasks-info-start-message.ts b/src/generated-client/models/scheduled-tasks-info-start-message.ts new file mode 100644 index 00000000..f0d33b79 --- /dev/null +++ b/src/generated-client/models/scheduled-tasks-info-start-message.ts @@ -0,0 +1,36 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { SessionMessageType } from './session-message-type'; + +/** + * Scheduled tasks info start message. Data is the timing data encoded as \"$initialDelay,$interval\" in ms. + * @export + * @interface ScheduledTasksInfoStartMessage + */ +export interface ScheduledTasksInfoStartMessage { + /** + * Gets or sets the data. + * @type {string} + * @memberof ScheduledTasksInfoStartMessage + */ + 'Data'?: string | null; + /** + * + * @type {SessionMessageType} + * @memberof ScheduledTasksInfoStartMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/scheduled-tasks-info-stop-message.ts b/src/generated-client/models/scheduled-tasks-info-stop-message.ts new file mode 100644 index 00000000..9d207f13 --- /dev/null +++ b/src/generated-client/models/scheduled-tasks-info-stop-message.ts @@ -0,0 +1,30 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { SessionMessageType } from './session-message-type'; + +/** + * Scheduled tasks info stop message. + * @export + * @interface ScheduledTasksInfoStopMessage + */ +export interface ScheduledTasksInfoStopMessage { + /** + * + * @type {SessionMessageType} + * @memberof ScheduledTasksInfoStopMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/search-hint.ts b/src/generated-client/models/search-hint.ts index 475787a9..db5793aa 100644 --- a/src/generated-client/models/search-hint.ts +++ b/src/generated-client/models/search-hint.ts @@ -12,6 +12,8 @@ */ +import { BaseItemKind } from './base-item-kind'; +import { MediaType } from './media-type'; /** * Class SearchHintResult. @@ -23,10 +25,11 @@ export interface SearchHint { * Gets or sets the item id. * @type {string} * @memberof SearchHint + * @deprecated */ 'ItemId'?: string; /** - * + * Gets or sets the item id. * @type {string} * @memberof SearchHint */ @@ -36,13 +39,13 @@ export interface SearchHint { * @type {string} * @memberof SearchHint */ - 'Name'?: string | null; + 'Name'?: string; /** * Gets or sets the matched term. * @type {string} * @memberof SearchHint */ - 'MatchedTerm'?: string | null; + 'MatchedTerm'?: string; /** * Gets or sets the index number. * @type {number} @@ -92,13 +95,13 @@ export interface SearchHint { */ 'BackdropImageItemId'?: string | null; /** - * Gets or sets the type. - * @type {string} + * + * @type {BaseItemKind} * @memberof SearchHint */ - 'Type'?: string | null; + 'Type'?: BaseItemKind; /** - * + * Gets or sets a value indicating whether this instance is folder. * @type {boolean} * @memberof SearchHint */ @@ -110,19 +113,19 @@ export interface SearchHint { */ 'RunTimeTicks'?: number | null; /** - * Gets or sets the type of the media. - * @type {string} + * + * @type {MediaType} * @memberof SearchHint */ - 'MediaType'?: string | null; + 'MediaType'?: MediaType; /** - * + * Gets or sets the start date. * @type {string} * @memberof SearchHint */ 'StartDate'?: string | null; /** - * + * Gets or sets the end date. * @type {string} * @memberof SearchHint */ @@ -134,7 +137,7 @@ export interface SearchHint { */ 'Series'?: string | null; /** - * + * Gets or sets the status. * @type {string} * @memberof SearchHint */ @@ -146,11 +149,11 @@ export interface SearchHint { */ 'Album'?: string | null; /** - * + * Gets or sets the album id. * @type {string} * @memberof SearchHint */ - 'AlbumId'?: string; + 'AlbumId'?: string | null; /** * Gets or sets the album artist. * @type {string} @@ -162,7 +165,7 @@ export interface SearchHint { * @type {Array} * @memberof SearchHint */ - 'Artists'?: Array | null; + 'Artists'?: Array; /** * Gets or sets the song count. * @type {number} @@ -180,7 +183,7 @@ export interface SearchHint { * @type {string} * @memberof SearchHint */ - 'ChannelId'?: string; + 'ChannelId'?: string | null; /** * Gets or sets the name of the channel. * @type {string} diff --git a/src/generated-client/models/series-status.ts b/src/generated-client/models/series-status.ts index de2ecba7..fd73c7a4 100644 --- a/src/generated-client/models/series-status.ts +++ b/src/generated-client/models/series-status.ts @@ -14,14 +14,15 @@ /** - * Enum SeriesStatus. + * The status of a series. * @export * @enum {string} */ export const SeriesStatus = { Continuing: 'Continuing', - Ended: 'Ended' + Ended: 'Ended', + Unreleased: 'Unreleased' } as const; export type SeriesStatus = typeof SeriesStatus[keyof typeof SeriesStatus]; diff --git a/src/generated-client/models/series-timer-cancelled-message.ts b/src/generated-client/models/series-timer-cancelled-message.ts new file mode 100644 index 00000000..09b7c131 --- /dev/null +++ b/src/generated-client/models/series-timer-cancelled-message.ts @@ -0,0 +1,43 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { SessionMessageType } from './session-message-type'; +import { TimerEventInfo } from './timer-event-info'; + +/** + * Series timer cancelled message. + * @export + * @interface SeriesTimerCancelledMessage + */ +export interface SeriesTimerCancelledMessage { + /** + * + * @type {TimerEventInfo} + * @memberof SeriesTimerCancelledMessage + */ + 'Data'?: TimerEventInfo; + /** + * Gets or sets the message id. + * @type {string} + * @memberof SeriesTimerCancelledMessage + */ + 'MessageId'?: string; + /** + * + * @type {SessionMessageType} + * @memberof SeriesTimerCancelledMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/series-timer-created-message.ts b/src/generated-client/models/series-timer-created-message.ts new file mode 100644 index 00000000..a0d238c7 --- /dev/null +++ b/src/generated-client/models/series-timer-created-message.ts @@ -0,0 +1,43 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { SessionMessageType } from './session-message-type'; +import { TimerEventInfo } from './timer-event-info'; + +/** + * Series timer created message. + * @export + * @interface SeriesTimerCreatedMessage + */ +export interface SeriesTimerCreatedMessage { + /** + * + * @type {TimerEventInfo} + * @memberof SeriesTimerCreatedMessage + */ + 'Data'?: TimerEventInfo; + /** + * Gets or sets the message id. + * @type {string} + * @memberof SeriesTimerCreatedMessage + */ + 'MessageId'?: string; + /** + * + * @type {SessionMessageType} + * @memberof SeriesTimerCreatedMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/server-configuration.ts b/src/generated-client/models/server-configuration.ts index 6c89fe9b..55935ace 100644 --- a/src/generated-client/models/server-configuration.ts +++ b/src/generated-client/models/server-configuration.ts @@ -12,11 +12,14 @@ */ +import { CastReceiverApplication } from './cast-receiver-application'; +import { ImageResolution } from './image-resolution'; import { ImageSavingConvention } from './image-saving-convention'; import { MetadataOptions } from './metadata-options'; import { NameValuePair } from './name-value-pair'; import { PathSubstitution } from './path-substitution'; import { RepositoryInfo } from './repository-info'; +import { TrickplayOptions } from './trickplay-options'; /** * Represents the server configuration. @@ -162,12 +165,24 @@ export interface ServerConfiguration { * @memberof ServerConfiguration */ 'MaxAudiobookResume'?: number; + /** + * Gets or sets the threshold in minutes after a inactive session gets closed automatically. If set to 0 the check for inactive sessions gets disabled. + * @type {number} + * @memberof ServerConfiguration + */ + 'InactiveSessionThreshold'?: number; /** * Gets or sets the delay in seconds that we will wait after a file system change to try and discover what has been added/removed Some delay is necessary with some items because their creation is not atomic. It involves the creation of several different directories and files. * @type {number} * @memberof ServerConfiguration */ 'LibraryMonitorDelay'?: number; + /** + * Gets or sets the duration in seconds that we will wait after a library updated event before executing the library changed notification. + * @type {number} + * @memberof ServerConfiguration + */ + 'LibraryUpdateDuration'?: number; /** * * @type {ImageSavingConvention} @@ -312,5 +327,35 @@ export interface ServerConfiguration { * @memberof ServerConfiguration */ 'AllowClientLogUpload'?: boolean; + /** + * Gets or sets the dummy chapter duration in seconds, use 0 (zero) or less to disable generation alltogether. + * @type {number} + * @memberof ServerConfiguration + */ + 'DummyChapterDuration'?: number; + /** + * + * @type {ImageResolution} + * @memberof ServerConfiguration + */ + 'ChapterImageResolution'?: ImageResolution; + /** + * Gets or sets the limit for parallel image encoding. + * @type {number} + * @memberof ServerConfiguration + */ + 'ParallelImageEncodingLimit'?: number; + /** + * Gets or sets the list of cast receiver applications. + * @type {Array} + * @memberof ServerConfiguration + */ + 'CastReceiverApplications'?: Array; + /** + * + * @type {TrickplayOptions} + * @memberof ServerConfiguration + */ + 'TrickplayOptions'?: TrickplayOptions; } diff --git a/src/generated-client/models/server-restarting-message.ts b/src/generated-client/models/server-restarting-message.ts new file mode 100644 index 00000000..34b98af9 --- /dev/null +++ b/src/generated-client/models/server-restarting-message.ts @@ -0,0 +1,36 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { SessionMessageType } from './session-message-type'; + +/** + * Server restarting down message. + * @export + * @interface ServerRestartingMessage + */ +export interface ServerRestartingMessage { + /** + * Gets or sets the message id. + * @type {string} + * @memberof ServerRestartingMessage + */ + 'MessageId'?: string; + /** + * + * @type {SessionMessageType} + * @memberof ServerRestartingMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/server-shutting-down-message.ts b/src/generated-client/models/server-shutting-down-message.ts new file mode 100644 index 00000000..b42601b2 --- /dev/null +++ b/src/generated-client/models/server-shutting-down-message.ts @@ -0,0 +1,36 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { SessionMessageType } from './session-message-type'; + +/** + * Server shutting down message. + * @export + * @interface ServerShuttingDownMessage + */ +export interface ServerShuttingDownMessage { + /** + * Gets or sets the message id. + * @type {string} + * @memberof ServerShuttingDownMessage + */ + 'MessageId'?: string; + /** + * + * @type {SessionMessageType} + * @memberof ServerShuttingDownMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/session-info.ts b/src/generated-client/models/session-info.ts index 6b6e4caa..e8c09195 100644 --- a/src/generated-client/models/session-info.ts +++ b/src/generated-client/models/session-info.ts @@ -12,10 +12,10 @@ */ -import { BaseItem } from './base-item'; import { BaseItemDto } from './base-item-dto'; import { ClientCapabilities } from './client-capabilities'; import { GeneralCommandType } from './general-command-type'; +import { MediaType } from './media-type'; import { PlayerStateInfo } from './player-state-info'; import { QueueItem } from './queue-item'; import { SessionUserInfo } from './session-user-info'; @@ -53,10 +53,10 @@ export interface SessionInfo { 'RemoteEndPoint'?: string | null; /** * Gets the playable media types. - * @type {Array} + * @type {Array} * @memberof SessionInfo */ - 'PlayableMediaTypes'?: Array | null; + 'PlayableMediaTypes'?: Array | null; /** * Gets or sets the id. * @type {string} @@ -93,6 +93,12 @@ export interface SessionInfo { * @memberof SessionInfo */ 'LastPlaybackCheckIn'?: string; + /** + * Gets or sets the last paused date. + * @type {string} + * @memberof SessionInfo + */ + 'LastPausedDate'?: string | null; /** * Gets or sets the name of the device. * @type {string} @@ -111,12 +117,6 @@ export interface SessionInfo { * @memberof SessionInfo */ 'NowPlayingItem'?: BaseItemDto; - /** - * - * @type {BaseItem} - * @memberof SessionInfo - */ - 'FullNowPlayingItem'?: BaseItem; /** * * @type {BaseItemDto} diff --git a/src/generated-client/models/sessions-message.ts b/src/generated-client/models/sessions-message.ts new file mode 100644 index 00000000..d17c0af6 --- /dev/null +++ b/src/generated-client/models/sessions-message.ts @@ -0,0 +1,43 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { SessionInfo } from './session-info'; +import { SessionMessageType } from './session-message-type'; + +/** + * Sessions message. + * @export + * @interface SessionsMessage + */ +export interface SessionsMessage { + /** + * Gets or sets the data. + * @type {Array} + * @memberof SessionsMessage + */ + 'Data'?: Array | null; + /** + * Gets or sets the message id. + * @type {string} + * @memberof SessionsMessage + */ + 'MessageId'?: string; + /** + * + * @type {SessionMessageType} + * @memberof SessionsMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/sessions-start-message.ts b/src/generated-client/models/sessions-start-message.ts new file mode 100644 index 00000000..76e8cd63 --- /dev/null +++ b/src/generated-client/models/sessions-start-message.ts @@ -0,0 +1,36 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { SessionMessageType } from './session-message-type'; + +/** + * Sessions start message. Data is the timing data encoded as \"$initialDelay,$interval\" in ms. + * @export + * @interface SessionsStartMessage + */ +export interface SessionsStartMessage { + /** + * Gets or sets the data. + * @type {string} + * @memberof SessionsStartMessage + */ + 'Data'?: string | null; + /** + * + * @type {SessionMessageType} + * @memberof SessionsStartMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/sessions-stop-message.ts b/src/generated-client/models/sessions-stop-message.ts new file mode 100644 index 00000000..3a99f994 --- /dev/null +++ b/src/generated-client/models/sessions-stop-message.ts @@ -0,0 +1,30 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { SessionMessageType } from './session-message-type'; + +/** + * Sessions stop message. + * @export + * @interface SessionsStopMessage + */ +export interface SessionsStopMessage { + /** + * + * @type {SessionMessageType} + * @memberof SessionsStopMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/string-group-update.ts b/src/generated-client/models/string-group-update.ts new file mode 100644 index 00000000..f1a6ffff --- /dev/null +++ b/src/generated-client/models/string-group-update.ts @@ -0,0 +1,42 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { GroupUpdateType } from './group-update-type'; + +/** + * Class GroupUpdate. + * @export + * @interface StringGroupUpdate + */ +export interface StringGroupUpdate { + /** + * Gets the group identifier. + * @type {string} + * @memberof StringGroupUpdate + */ + 'GroupId'?: string; + /** + * + * @type {GroupUpdateType} + * @memberof StringGroupUpdate + */ + 'Type'?: GroupUpdateType; + /** + * Gets the update data. + * @type {string} + * @memberof StringGroupUpdate + */ + 'Data'?: string; +} + diff --git a/src/generated-client/models/sync-play-command-message.ts b/src/generated-client/models/sync-play-command-message.ts new file mode 100644 index 00000000..c829a135 --- /dev/null +++ b/src/generated-client/models/sync-play-command-message.ts @@ -0,0 +1,43 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { SendCommand } from './send-command'; +import { SessionMessageType } from './session-message-type'; + +/** + * Sync play command. + * @export + * @interface SyncPlayCommandMessage + */ +export interface SyncPlayCommandMessage { + /** + * + * @type {SendCommand} + * @memberof SyncPlayCommandMessage + */ + 'Data'?: SendCommand; + /** + * Gets or sets the message id. + * @type {string} + * @memberof SyncPlayCommandMessage + */ + 'MessageId'?: string; + /** + * + * @type {SessionMessageType} + * @memberof SyncPlayCommandMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/sync-play-group-update-command-message.ts b/src/generated-client/models/sync-play-group-update-command-message.ts new file mode 100644 index 00000000..dd108d91 --- /dev/null +++ b/src/generated-client/models/sync-play-group-update-command-message.ts @@ -0,0 +1,43 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { GroupUpdate } from './group-update'; +import { SessionMessageType } from './session-message-type'; + +/** + * Untyped sync play command. + * @export + * @interface SyncPlayGroupUpdateCommandMessage + */ +export interface SyncPlayGroupUpdateCommandMessage { + /** + * + * @type {GroupUpdate} + * @memberof SyncPlayGroupUpdateCommandMessage + */ + 'Data'?: GroupUpdate; + /** + * Gets or sets the message id. + * @type {string} + * @memberof SyncPlayGroupUpdateCommandMessage + */ + 'MessageId'?: string; + /** + * + * @type {SessionMessageType} + * @memberof SyncPlayGroupUpdateCommandMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/sync-play-queue-item.ts b/src/generated-client/models/sync-play-queue-item.ts new file mode 100644 index 00000000..10fd7cd5 --- /dev/null +++ b/src/generated-client/models/sync-play-queue-item.ts @@ -0,0 +1,35 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + + +/** + * Class QueueItem. + * @export + * @interface SyncPlayQueueItem + */ +export interface SyncPlayQueueItem { + /** + * Gets the item identifier. + * @type {string} + * @memberof SyncPlayQueueItem + */ + 'ItemId'?: string; + /** + * Gets the playlist identifier of the item. + * @type {string} + * @memberof SyncPlayQueueItem + */ + 'PlaylistItemId'?: string; +} + diff --git a/src/generated-client/models/system-info.ts b/src/generated-client/models/system-info.ts index 4dcac415..804cde5e 100644 --- a/src/generated-client/models/system-info.ts +++ b/src/generated-client/models/system-info.ts @@ -12,8 +12,7 @@ */ -import { Architecture } from './architecture'; -import { FFmpegLocation } from './ffmpeg-location'; +import { CastReceiverApplication } from './cast-receiver-application'; import { InstallationInfo } from './installation-info'; /** @@ -50,6 +49,7 @@ export interface SystemInfo { * Gets or sets the operating system. * @type {string} * @memberof SystemInfo + * @deprecated */ 'OperatingSystem'?: string | null; /** @@ -68,6 +68,7 @@ export interface SystemInfo { * Gets or sets the display name of the operating system. * @type {string} * @memberof SystemInfo + * @deprecated */ 'OperatingSystemDisplayName'?: string | null; /** @@ -110,12 +111,14 @@ export interface SystemInfo { * Gets or sets a value indicating whether this instance can self restart. * @type {boolean} * @memberof SystemInfo + * @deprecated */ 'CanSelfRestart'?: boolean; /** * * @type {boolean} * @memberof SystemInfo + * @deprecated */ 'CanLaunchWebBrowser'?: boolean; /** @@ -160,6 +163,12 @@ export interface SystemInfo { * @memberof SystemInfo */ 'TranscodingTempPath'?: string | null; + /** + * Gets or sets the list of cast receiver applications. + * @type {Array} + * @memberof SystemInfo + */ + 'CastReceiverApplications'?: Array | null; /** * Gets or sets a value indicating whether this instance has update available. * @type {boolean} @@ -169,15 +178,17 @@ export interface SystemInfo { 'HasUpdateAvailable'?: boolean; /** * - * @type {FFmpegLocation} + * @type {string} * @memberof SystemInfo + * @deprecated */ - 'EncoderLocation'?: FFmpegLocation; + 'EncoderLocation'?: string | null; /** * - * @type {Architecture} + * @type {string} * @memberof SystemInfo + * @deprecated */ - 'SystemArchitecture'?: Architecture; + 'SystemArchitecture'?: string | null; } diff --git a/src/generated-client/models/timer-cancelled-message.ts b/src/generated-client/models/timer-cancelled-message.ts new file mode 100644 index 00000000..885ee330 --- /dev/null +++ b/src/generated-client/models/timer-cancelled-message.ts @@ -0,0 +1,43 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { SessionMessageType } from './session-message-type'; +import { TimerEventInfo } from './timer-event-info'; + +/** + * Timer cancelled message. + * @export + * @interface TimerCancelledMessage + */ +export interface TimerCancelledMessage { + /** + * + * @type {TimerEventInfo} + * @memberof TimerCancelledMessage + */ + 'Data'?: TimerEventInfo; + /** + * Gets or sets the message id. + * @type {string} + * @memberof TimerCancelledMessage + */ + 'MessageId'?: string; + /** + * + * @type {SessionMessageType} + * @memberof TimerCancelledMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/timer-created-message.ts b/src/generated-client/models/timer-created-message.ts new file mode 100644 index 00000000..daf47a73 --- /dev/null +++ b/src/generated-client/models/timer-created-message.ts @@ -0,0 +1,43 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { SessionMessageType } from './session-message-type'; +import { TimerEventInfo } from './timer-event-info'; + +/** + * Timer created message. + * @export + * @interface TimerCreatedMessage + */ +export interface TimerCreatedMessage { + /** + * + * @type {TimerEventInfo} + * @memberof TimerCreatedMessage + */ + 'Data'?: TimerEventInfo; + /** + * Gets or sets the message id. + * @type {string} + * @memberof TimerCreatedMessage + */ + 'MessageId'?: string; + /** + * + * @type {SessionMessageType} + * @memberof TimerCreatedMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/transcoding-info.ts b/src/generated-client/models/transcoding-info.ts index cfe26993..97dd4aa8 100644 --- a/src/generated-client/models/transcoding-info.ts +++ b/src/generated-client/models/transcoding-info.ts @@ -98,6 +98,12 @@ export interface TranscodingInfo { * @type {Array} * @memberof TranscodingInfo */ - 'TranscodeReasons'?: Array; + 'TranscodeReasons'?: TranscodingInfoTranscodeReasonsEnum; } +export const TranscodingInfoTranscodeReasonsEnum = { +} as const; + +export type TranscodingInfoTranscodeReasonsEnum = typeof TranscodingInfoTranscodeReasonsEnum[keyof typeof TranscodingInfoTranscodeReasonsEnum]; + + diff --git a/src/generated-client/models/transcoding-profile.ts b/src/generated-client/models/transcoding-profile.ts index 1f8b70a6..8ea7d525 100644 --- a/src/generated-client/models/transcoding-profile.ts +++ b/src/generated-client/models/transcoding-profile.ts @@ -14,6 +14,7 @@ import { DlnaProfileType } from './dlna-profile-type'; import { EncodingContext } from './encoding-context'; +import { MediaStreamProtocol } from './media-stream-protocol'; import { ProfileCondition } from './profile-condition'; import { TranscodeSeekInfo } from './transcode-seek-info'; @@ -49,10 +50,10 @@ export interface TranscodingProfile { 'AudioCodec'?: string; /** * - * @type {string} + * @type {MediaStreamProtocol} * @memberof TranscodingProfile */ - 'Protocol'?: string; + 'Protocol'?: MediaStreamProtocol; /** * * @type {boolean} diff --git a/src/generated-client/models/trickplay-info.ts b/src/generated-client/models/trickplay-info.ts new file mode 100644 index 00000000..777c60a0 --- /dev/null +++ b/src/generated-client/models/trickplay-info.ts @@ -0,0 +1,65 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + + +/** + * An entity representing the metadata for a group of trickplay tiles. + * @export + * @interface TrickplayInfo + */ +export interface TrickplayInfo { + /** + * Gets or sets width of an individual thumbnail. + * @type {number} + * @memberof TrickplayInfo + */ + 'Width'?: number; + /** + * Gets or sets height of an individual thumbnail. + * @type {number} + * @memberof TrickplayInfo + */ + 'Height'?: number; + /** + * Gets or sets amount of thumbnails per row. + * @type {number} + * @memberof TrickplayInfo + */ + 'TileWidth'?: number; + /** + * Gets or sets amount of thumbnails per column. + * @type {number} + * @memberof TrickplayInfo + */ + 'TileHeight'?: number; + /** + * Gets or sets total amount of non-black thumbnails. + * @type {number} + * @memberof TrickplayInfo + */ + 'ThumbnailCount'?: number; + /** + * Gets or sets interval in milliseconds between each trickplay thumbnail. + * @type {number} + * @memberof TrickplayInfo + */ + 'Interval'?: number; + /** + * Gets or sets peak bandwith usage in bits per second. + * @type {number} + * @memberof TrickplayInfo + */ + 'Bandwidth'?: number; +} + diff --git a/src/generated-client/models/trickplay-options.ts b/src/generated-client/models/trickplay-options.ts new file mode 100644 index 00000000..356ba6ed --- /dev/null +++ b/src/generated-client/models/trickplay-options.ts @@ -0,0 +1,91 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { ProcessPriorityClass } from './process-priority-class'; +import { TrickplayScanBehavior } from './trickplay-scan-behavior'; + +/** + * Class TrickplayOptions. + * @export + * @interface TrickplayOptions + */ +export interface TrickplayOptions { + /** + * Gets or sets a value indicating whether or not to use HW acceleration. + * @type {boolean} + * @memberof TrickplayOptions + */ + 'EnableHwAcceleration'?: boolean; + /** + * Gets or sets a value indicating whether or not to use HW accelerated MJPEG encoding. + * @type {boolean} + * @memberof TrickplayOptions + */ + 'EnableHwEncoding'?: boolean; + /** + * + * @type {TrickplayScanBehavior} + * @memberof TrickplayOptions + */ + 'ScanBehavior'?: TrickplayScanBehavior; + /** + * + * @type {ProcessPriorityClass} + * @memberof TrickplayOptions + */ + 'ProcessPriority'?: ProcessPriorityClass; + /** + * Gets or sets the interval, in ms, between each new trickplay image. + * @type {number} + * @memberof TrickplayOptions + */ + 'Interval'?: number; + /** + * Gets or sets the target width resolutions, in px, to generates preview images for. + * @type {Array} + * @memberof TrickplayOptions + */ + 'WidthResolutions'?: Array; + /** + * Gets or sets number of tile images to allow in X dimension. + * @type {number} + * @memberof TrickplayOptions + */ + 'TileWidth'?: number; + /** + * Gets or sets number of tile images to allow in Y dimension. + * @type {number} + * @memberof TrickplayOptions + */ + 'TileHeight'?: number; + /** + * Gets or sets the ffmpeg output quality level. + * @type {number} + * @memberof TrickplayOptions + */ + 'Qscale'?: number; + /** + * Gets or sets the jpeg quality to use for image tiles. + * @type {number} + * @memberof TrickplayOptions + */ + 'JpegQuality'?: number; + /** + * Gets or sets the number of threads to be used by ffmpeg. + * @type {number} + * @memberof TrickplayOptions + */ + 'ProcessThreads'?: number; +} + diff --git a/src/generated-client/models/trickplay-scan-behavior.ts b/src/generated-client/models/trickplay-scan-behavior.ts new file mode 100644 index 00000000..47c00e22 --- /dev/null +++ b/src/generated-client/models/trickplay-scan-behavior.ts @@ -0,0 +1,30 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + + +/** + * Enum TrickplayScanBehavior. + * @export + * @enum {string} + */ + +export const TrickplayScanBehavior = { + Blocking: 'Blocking', + NonBlocking: 'NonBlocking' +} as const; + +export type TrickplayScanBehavior = typeof TrickplayScanBehavior[keyof typeof TrickplayScanBehavior]; + + + diff --git a/src/generated-client/models/tuner-host-info.ts b/src/generated-client/models/tuner-host-info.ts index 85512b66..a92425aa 100644 --- a/src/generated-client/models/tuner-host-info.ts +++ b/src/generated-client/models/tuner-host-info.ts @@ -85,5 +85,11 @@ export interface TunerHostInfo { * @memberof TunerHostInfo */ 'UserAgent'?: string | null; + /** + * + * @type {boolean} + * @memberof TunerHostInfo + */ + 'IgnoreDts'?: boolean; } diff --git a/src/generated-client/models/update-playlist-dto.ts b/src/generated-client/models/update-playlist-dto.ts new file mode 100644 index 00000000..11271c8c --- /dev/null +++ b/src/generated-client/models/update-playlist-dto.ts @@ -0,0 +1,48 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { PlaylistUserPermissions } from './playlist-user-permissions'; + +/** + * Update existing playlist dto. Fields set to `null` will not be updated and keep their current values. + * @export + * @interface UpdatePlaylistDto + */ +export interface UpdatePlaylistDto { + /** + * Gets or sets the name of the new playlist. + * @type {string} + * @memberof UpdatePlaylistDto + */ + 'Name'?: string | null; + /** + * Gets or sets item ids of the playlist. + * @type {Array} + * @memberof UpdatePlaylistDto + */ + 'Ids'?: Array | null; + /** + * Gets or sets the playlist users. + * @type {Array} + * @memberof UpdatePlaylistDto + */ + 'Users'?: Array | null; + /** + * Gets or sets a value indicating whether the playlist is public. + * @type {boolean} + * @memberof UpdatePlaylistDto + */ + 'IsPublic'?: boolean | null; +} + diff --git a/src/generated-client/models/update-playlist-user-dto.ts b/src/generated-client/models/update-playlist-user-dto.ts new file mode 100644 index 00000000..35171724 --- /dev/null +++ b/src/generated-client/models/update-playlist-user-dto.ts @@ -0,0 +1,29 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + + +/** + * Update existing playlist user dto. Fields set to `null` will not be updated and keep their current values. + * @export + * @interface UpdatePlaylistUserDto + */ +export interface UpdatePlaylistUserDto { + /** + * Gets or sets a value indicating whether the user can edit the playlist. + * @type {boolean} + * @memberof UpdatePlaylistUserDto + */ + 'CanEdit'?: boolean | null; +} + diff --git a/src/generated-client/models/update-user-item-data-dto.ts b/src/generated-client/models/update-user-item-data-dto.ts new file mode 100644 index 00000000..8e562edc --- /dev/null +++ b/src/generated-client/models/update-user-item-data-dto.ts @@ -0,0 +1,89 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + + +/** + * This is used by the api to get information about a item user data. + * @export + * @interface UpdateUserItemDataDto + */ +export interface UpdateUserItemDataDto { + /** + * Gets or sets the rating. + * @type {number} + * @memberof UpdateUserItemDataDto + */ + 'Rating'?: number | null; + /** + * Gets or sets the played percentage. + * @type {number} + * @memberof UpdateUserItemDataDto + */ + 'PlayedPercentage'?: number | null; + /** + * Gets or sets the unplayed item count. + * @type {number} + * @memberof UpdateUserItemDataDto + */ + 'UnplayedItemCount'?: number | null; + /** + * Gets or sets the playback position ticks. + * @type {number} + * @memberof UpdateUserItemDataDto + */ + 'PlaybackPositionTicks'?: number | null; + /** + * Gets or sets the play count. + * @type {number} + * @memberof UpdateUserItemDataDto + */ + 'PlayCount'?: number | null; + /** + * Gets or sets a value indicating whether this instance is favorite. + * @type {boolean} + * @memberof UpdateUserItemDataDto + */ + 'IsFavorite'?: boolean | null; + /** + * Gets or sets a value indicating whether this MediaBrowser.Model.Dto.UpdateUserItemDataDto is likes. + * @type {boolean} + * @memberof UpdateUserItemDataDto + */ + 'Likes'?: boolean | null; + /** + * Gets or sets the last played date. + * @type {string} + * @memberof UpdateUserItemDataDto + */ + 'LastPlayedDate'?: string | null; + /** + * Gets or sets a value indicating whether this MediaBrowser.Model.Dto.UserItemDataDto is played. + * @type {boolean} + * @memberof UpdateUserItemDataDto + */ + 'Played'?: boolean | null; + /** + * Gets or sets the key. + * @type {string} + * @memberof UpdateUserItemDataDto + */ + 'Key'?: string | null; + /** + * Gets or sets the item identifier. + * @type {string} + * @memberof UpdateUserItemDataDto + */ + 'ItemId'?: string | null; +} + diff --git a/src/generated-client/models/upload-subtitle-dto.ts b/src/generated-client/models/upload-subtitle-dto.ts index f24714c9..b7987146 100644 --- a/src/generated-client/models/upload-subtitle-dto.ts +++ b/src/generated-client/models/upload-subtitle-dto.ts @@ -37,6 +37,12 @@ export interface UploadSubtitleDto { * @memberof UploadSubtitleDto */ 'IsForced': boolean; + /** + * Gets or sets a value indicating whether the subtitle is for hearing impaired. + * @type {boolean} + * @memberof UploadSubtitleDto + */ + 'IsHearingImpaired': boolean; /** * Gets or sets the subtitle data. * @type {string} diff --git a/src/generated-client/models/user-configuration.ts b/src/generated-client/models/user-configuration.ts index e6ed28e2..cdd35d76 100644 --- a/src/generated-client/models/user-configuration.ts +++ b/src/generated-client/models/user-configuration.ts @@ -110,5 +110,11 @@ export interface UserConfiguration { * @memberof UserConfiguration */ 'EnableNextEpisodeAutoPlay'?: boolean; + /** + * Gets or sets the id of the selected cast receiver. + * @type {string} + * @memberof UserConfiguration + */ + 'CastReceiverId'?: string | null; } diff --git a/src/generated-client/models/user-data-change-info.ts b/src/generated-client/models/user-data-change-info.ts new file mode 100644 index 00000000..deaebab2 --- /dev/null +++ b/src/generated-client/models/user-data-change-info.ts @@ -0,0 +1,36 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { UserItemDataDto } from './user-item-data-dto'; + +/** + * Class UserDataChangeInfo. + * @export + * @interface UserDataChangeInfo + */ +export interface UserDataChangeInfo { + /** + * Gets or sets the user id. + * @type {string} + * @memberof UserDataChangeInfo + */ + 'UserId'?: string | null; + /** + * Gets or sets the user data list. + * @type {Array} + * @memberof UserDataChangeInfo + */ + 'UserDataList'?: Array | null; +} + diff --git a/src/generated-client/models/user-data-changed-message.ts b/src/generated-client/models/user-data-changed-message.ts new file mode 100644 index 00000000..c33dbddd --- /dev/null +++ b/src/generated-client/models/user-data-changed-message.ts @@ -0,0 +1,43 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { SessionMessageType } from './session-message-type'; +import { UserDataChangeInfo } from './user-data-change-info'; + +/** + * User data changed message. + * @export + * @interface UserDataChangedMessage + */ +export interface UserDataChangedMessage { + /** + * + * @type {UserDataChangeInfo} + * @memberof UserDataChangedMessage + */ + 'Data'?: UserDataChangeInfo; + /** + * Gets or sets the message id. + * @type {string} + * @memberof UserDataChangedMessage + */ + 'MessageId'?: string; + /** + * + * @type {SessionMessageType} + * @memberof UserDataChangedMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/user-deleted-message.ts b/src/generated-client/models/user-deleted-message.ts new file mode 100644 index 00000000..cdb41960 --- /dev/null +++ b/src/generated-client/models/user-deleted-message.ts @@ -0,0 +1,42 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { SessionMessageType } from './session-message-type'; + +/** + * User deleted message. + * @export + * @interface UserDeletedMessage + */ +export interface UserDeletedMessage { + /** + * Gets or sets the data. + * @type {string} + * @memberof UserDeletedMessage + */ + 'Data'?: string; + /** + * Gets or sets the message id. + * @type {string} + * @memberof UserDeletedMessage + */ + 'MessageId'?: string; + /** + * + * @type {SessionMessageType} + * @memberof UserDeletedMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/user-dto.ts b/src/generated-client/models/user-dto.ts index 85fb3ab1..77be0ffd 100644 --- a/src/generated-client/models/user-dto.ts +++ b/src/generated-client/models/user-dto.ts @@ -67,6 +67,7 @@ export interface UserDto { * Gets or sets a value indicating whether this instance has configured easy password. * @type {boolean} * @memberof UserDto + * @deprecated */ 'HasConfiguredEasyPassword'?: boolean; /** diff --git a/src/generated-client/models/user-policy.ts b/src/generated-client/models/user-policy.ts index 6e2ac4ce..d8adaf2d 100644 --- a/src/generated-client/models/user-policy.ts +++ b/src/generated-client/models/user-policy.ts @@ -34,6 +34,24 @@ export interface UserPolicy { * @memberof UserPolicy */ 'IsHidden'?: boolean; + /** + * Gets or sets a value indicating whether this instance can manage collections. + * @type {boolean} + * @memberof UserPolicy + */ + 'EnableCollectionManagement'?: boolean; + /** + * Gets or sets a value indicating whether this instance can manage subtitles. + * @type {boolean} + * @memberof UserPolicy + */ + 'EnableSubtitleManagement'?: boolean; + /** + * Gets or sets a value indicating whether this user can manage lyrics. + * @type {boolean} + * @memberof UserPolicy + */ + 'EnableLyricManagement'?: boolean; /** * Gets or sets a value indicating whether this instance is disabled. * @type {boolean} @@ -52,6 +70,12 @@ export interface UserPolicy { * @memberof UserPolicy */ 'BlockedTags'?: Array | null; + /** + * + * @type {Array} + * @memberof UserPolicy + */ + 'AllowedTags'?: Array | null; /** * * @type {boolean} @@ -243,13 +267,13 @@ export interface UserPolicy { * @type {string} * @memberof UserPolicy */ - 'AuthenticationProviderId'?: string | null; + 'AuthenticationProviderId': string; /** * * @type {string} * @memberof UserPolicy */ - 'PasswordResetProviderId'?: string | null; + 'PasswordResetProviderId': string; /** * * @type {SyncPlayUserAccessType} diff --git a/src/generated-client/models/user-updated-message.ts b/src/generated-client/models/user-updated-message.ts new file mode 100644 index 00000000..c50a774b --- /dev/null +++ b/src/generated-client/models/user-updated-message.ts @@ -0,0 +1,43 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { SessionMessageType } from './session-message-type'; +import { UserDto } from './user-dto'; + +/** + * User updated message. + * @export + * @interface UserUpdatedMessage + */ +export interface UserUpdatedMessage { + /** + * + * @type {UserDto} + * @memberof UserUpdatedMessage + */ + 'Data'?: UserDto; + /** + * Gets or sets the message id. + * @type {string} + * @memberof UserUpdatedMessage + */ + 'MessageId'?: string; + /** + * + * @type {SessionMessageType} + * @memberof UserUpdatedMessage + */ + 'MessageType'?: SessionMessageType; +} + diff --git a/src/generated-client/models/video-range-type.ts b/src/generated-client/models/video-range-type.ts new file mode 100644 index 00000000..9a72c169 --- /dev/null +++ b/src/generated-client/models/video-range-type.ts @@ -0,0 +1,37 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + + +/** + * An enum representing types of video ranges. + * @export + * @enum {string} + */ + +export const VideoRangeType = { + Unknown: 'Unknown', + Sdr: 'SDR', + Hdr10: 'HDR10', + Hlg: 'HLG', + Dovi: 'DOVI', + DoviWithHdr10: 'DOVIWithHDR10', + DoviWithHlg: 'DOVIWithHLG', + DoviWithSdr: 'DOVIWithSDR', + Hdr10Plus: 'HDR10Plus' +} as const; + +export type VideoRangeType = typeof VideoRangeType[keyof typeof VideoRangeType]; + + + diff --git a/src/generated-client/models/video-range.ts b/src/generated-client/models/video-range.ts new file mode 100644 index 00000000..c42a4c68 --- /dev/null +++ b/src/generated-client/models/video-range.ts @@ -0,0 +1,31 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + + +/** + * An enum representing video ranges. + * @export + * @enum {string} + */ + +export const VideoRange = { + Unknown: 'Unknown', + Sdr: 'SDR', + Hdr: 'HDR' +} as const; + +export type VideoRange = typeof VideoRange[keyof typeof VideoRange]; + + + diff --git a/src/generated-client/models/web-socket-message.ts b/src/generated-client/models/web-socket-message.ts new file mode 100644 index 00000000..cf631cae --- /dev/null +++ b/src/generated-client/models/web-socket-message.ts @@ -0,0 +1,27 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit the class manually. + * + * Jellyfin API + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + + +import { InboundWebSocketMessage } from './inbound-web-socket-message'; +import { OutboundWebSocketMessage } from './outbound-web-socket-message'; +import { SessionMessageType } from './session-message-type'; +import { UserDto } from './user-dto'; + +/** + * @type WebSocketMessage + * Represents the possible websocket types + * @export + */ +export type WebSocketMessage = InboundWebSocketMessage | OutboundWebSocketMessage; + + diff --git a/src/utils/api/__tests__/api.test.ts b/src/utils/api/__tests__/api.test.ts index c3056a22..c548d222 100644 --- a/src/utils/api/__tests__/api.test.ts +++ b/src/utils/api/__tests__/api.test.ts @@ -5,12 +5,12 @@ */ import { describe, it, expect } from 'vitest'; -import { getActivityLogApi, getApiKeyApi, getArtistsApi, getAudioApi, getBrandingApi, getChannelsApi, getClientLogApi, getCollectionApi, getConfigurationApi, getDashboardApi, getDevicesApi, getDisplayPreferencesApi, getDlnaApi, getDlnaServerApi, getDynamicHlsApi, getEnvironmentApi, getFilterApi, getGenresApi, getHlsSegmentApi, getImageApi, getImageByNameApi, getInstantMixApi, getItemLookupApi, getItemRefreshApi, getItemUpdateApi, getItemsApi, getLibraryApi, getLibraryStructureApi, getLiveTvApi, getLocalizationApi, getMediaInfoApi, getMoviesApi, getMusicGenresApi, getNotificationsApi, getPackageApi, getPersonsApi, getPlaylistsApi, getPlaystateApi, getPluginsApi, getQuickConnectApi, getRemoteImageApi, getScheduledTasksApi, getSearchApi, getSessionApi, getStartupApi, getStudiosApi, getSubtitleApi, getSuggestionsApi, getSyncPlayApi, getSystemApi, getTimeSyncApi, getTmdbApi, getTrailersApi, getTvShowsApi, getUniversalAudioApi, getUserApi, getUserLibraryApi, getUserViewsApi, getVideoAttachmentsApi, getVideosApi, getYearsApi } from '..'; +import { getActivityLogApi, getApiKeyApi, getArtistsApi, getAudioApi, getBrandingApi, getChannelsApi, getClientLogApi, getCollectionApi, getConfigurationApi, getDashboardApi, getDevicesApi, getDisplayPreferencesApi, getDynamicHlsApi, getEnvironmentApi, getFilterApi, getGenresApi, getHlsSegmentApi, getImageApi, getInstantMixApi, getItemLookupApi, getItemRefreshApi, getItemUpdateApi, getItemsApi, getLibraryApi, getLibraryStructureApi, getLiveTvApi, getLocalizationApi, getLyricsApi, getMediaInfoApi, getMoviesApi, getMusicGenresApi, getPackageApi, getPersonsApi, getPlaylistsApi, getPlaystateApi, getPluginsApi, getQuickConnectApi, getRemoteImageApi, getScheduledTasksApi, getSearchApi, getSessionApi, getStartupApi, getStudiosApi, getSubtitleApi, getSuggestionsApi, getSyncPlayApi, getSystemApi, getTimeSyncApi, getTmdbApi, getTrailersApi, getTrickplayApi, getTvShowsApi, getUniversalAudioApi, getUserApi, getUserLibraryApi, getUserViewsApi, getVideoAttachmentsApi, getVideosApi, getYearsApi } from '..'; import { SERVER_URL, TEST_CLIENT, TEST_DEVICE } from '../../../__helpers__/common'; import { Api } from '../../../api'; -import { ActivityLogApi, ApiKeyApi, ArtistsApi, AudioApi, BrandingApi, ChannelsApi, ClientLogApi, CollectionApi, ConfigurationApi, DashboardApi, DevicesApi, DisplayPreferencesApi, DlnaApi, DlnaServerApi, DynamicHlsApi, EnvironmentApi, FilterApi, GenresApi, HlsSegmentApi, ImageApi, ImageByNameApi, InstantMixApi, ItemLookupApi, ItemRefreshApi, ItemsApi, ItemUpdateApi, LibraryApi, LibraryStructureApi, LiveTvApi, LocalizationApi, MediaInfoApi, MoviesApi, MusicGenresApi, NotificationsApi, PackageApi, PersonsApi, PlaylistsApi, PlaystateApi, PluginsApi, QuickConnectApi, RemoteImageApi, ScheduledTasksApi, SearchApi, SessionApi, StartupApi, StudiosApi, SubtitleApi, SuggestionsApi, SyncPlayApi, SystemApi, TimeSyncApi, TmdbApi, TrailersApi, TvShowsApi, UniversalAudioApi, UserApi, UserLibraryApi, UserViewsApi, VideoAttachmentsApi, VideosApi, YearsApi } from '../../../generated-client/api'; +import { ActivityLogApi, ApiKeyApi, ArtistsApi, AudioApi, BrandingApi, ChannelsApi, ClientLogApi, CollectionApi, ConfigurationApi, DashboardApi, DevicesApi, DisplayPreferencesApi, DynamicHlsApi, EnvironmentApi, FilterApi, GenresApi, HlsSegmentApi, ImageApi, InstantMixApi, ItemLookupApi, ItemRefreshApi, ItemsApi, ItemUpdateApi, LibraryApi, LibraryStructureApi, LiveTvApi, LocalizationApi, LyricsApi, MediaInfoApi, MoviesApi, MusicGenresApi, PackageApi, PersonsApi, PlaylistsApi, PlaystateApi, PluginsApi, QuickConnectApi, RemoteImageApi, ScheduledTasksApi, SearchApi, SessionApi, StartupApi, StudiosApi, SubtitleApi, SuggestionsApi, SyncPlayApi, SystemApi, TimeSyncApi, TmdbApi, TrailersApi, TrickplayApi, TvShowsApi, UniversalAudioApi, UserApi, UserLibraryApi, UserViewsApi, VideoAttachmentsApi, VideosApi, YearsApi } from '../../../generated-client/api'; /** * Api helper function tests. @@ -33,15 +33,12 @@ describe('Api Utilities', () => { expect(getDashboardApi(api)).toBeInstanceOf(DashboardApi); expect(getDevicesApi(api)).toBeInstanceOf(DevicesApi); expect(getDisplayPreferencesApi(api)).toBeInstanceOf(DisplayPreferencesApi); - expect(getDlnaApi(api)).toBeInstanceOf(DlnaApi); - expect(getDlnaServerApi(api)).toBeInstanceOf(DlnaServerApi); expect(getDynamicHlsApi(api)).toBeInstanceOf(DynamicHlsApi); expect(getEnvironmentApi(api)).toBeInstanceOf(EnvironmentApi); expect(getFilterApi(api)).toBeInstanceOf(FilterApi); expect(getGenresApi(api)).toBeInstanceOf(GenresApi); expect(getHlsSegmentApi(api)).toBeInstanceOf(HlsSegmentApi); expect(getImageApi(api)).toBeInstanceOf(ImageApi); - expect(getImageByNameApi(api)).toBeInstanceOf(ImageByNameApi); expect(getInstantMixApi(api)).toBeInstanceOf(InstantMixApi); expect(getItemLookupApi(api)).toBeInstanceOf(ItemLookupApi); expect(getItemRefreshApi(api)).toBeInstanceOf(ItemRefreshApi); @@ -51,10 +48,10 @@ describe('Api Utilities', () => { expect(getLibraryStructureApi(api)).toBeInstanceOf(LibraryStructureApi); expect(getLiveTvApi(api)).toBeInstanceOf(LiveTvApi); expect(getLocalizationApi(api)).toBeInstanceOf(LocalizationApi); + expect(getLyricsApi(api)).toBeInstanceOf(LyricsApi); expect(getMediaInfoApi(api)).toBeInstanceOf(MediaInfoApi); expect(getMoviesApi(api)).toBeInstanceOf(MoviesApi); expect(getMusicGenresApi(api)).toBeInstanceOf(MusicGenresApi); - expect(getNotificationsApi(api)).toBeInstanceOf(NotificationsApi); expect(getPackageApi(api)).toBeInstanceOf(PackageApi); expect(getPersonsApi(api)).toBeInstanceOf(PersonsApi); expect(getPlaylistsApi(api)).toBeInstanceOf(PlaylistsApi); @@ -74,6 +71,7 @@ describe('Api Utilities', () => { expect(getTimeSyncApi(api)).toBeInstanceOf(TimeSyncApi); expect(getTmdbApi(api)).toBeInstanceOf(TmdbApi); expect(getTrailersApi(api)).toBeInstanceOf(TrailersApi); + expect(getTrickplayApi(api)).toBeInstanceOf(TrickplayApi); expect(getTvShowsApi(api)).toBeInstanceOf(TvShowsApi); expect(getUniversalAudioApi(api)).toBeInstanceOf(UniversalAudioApi); expect(getUserApi(api)).toBeInstanceOf(UserApi); diff --git a/src/utils/api/image-by-name-api.ts b/src/utils/api/image-by-name-api.ts deleted file mode 100644 index 5bc5bd8f..00000000 --- a/src/utils/api/image-by-name-api.ts +++ /dev/null @@ -1,12 +0,0 @@ -/** - * This Source Code Form is subject to the terms of the Mozilla Public - * License, v. 2.0. If a copy of the MPL was not distributed with this - * file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -import type { Api } from '../../api'; -import { ImageByNameApi } from '../../generated-client/api/image-by-name-api'; - -export function getImageByNameApi(api: Api): ImageByNameApi { - return new ImageByNameApi(api.configuration, undefined, api.axiosInstance); -} diff --git a/src/utils/api/index.ts b/src/utils/api/index.ts index 156b3ada..9fb783c7 100644 --- a/src/utils/api/index.ts +++ b/src/utils/api/index.ts @@ -16,15 +16,12 @@ export * from './configuration-api'; export * from './dashboard-api'; export * from './devices-api'; export * from './display-preferences-api'; -export * from './dlna-api'; -export * from './dlna-server-api'; export * from './dynamic-hls-api'; export * from './environment-api'; export * from './filter-api'; export * from './genres-api'; export * from './hls-segment-api'; export * from './image-api'; -export * from './image-by-name-api'; export * from './instant-mix-api'; export * from './item-lookup-api'; export * from './item-refresh-api'; @@ -34,10 +31,10 @@ export * from './library-api'; export * from './library-structure-api'; export * from './live-tv-api'; export * from './localization-api'; +export * from './lyrics-api'; export * from './media-info-api'; export * from './movies-api'; export * from './music-genres-api'; -export * from './notifications-api'; export * from './package-api'; export * from './persons-api'; export * from './playlists-api'; @@ -57,6 +54,7 @@ export * from './system-api'; export * from './time-sync-api'; export * from './tmdb-api'; export * from './trailers-api'; +export * from './trickplay-api'; export * from './tv-shows-api'; export * from './universal-audio-api'; export * from './user-api'; diff --git a/src/utils/api/dlna-api.ts b/src/utils/api/lyrics-api.ts similarity index 56% rename from src/utils/api/dlna-api.ts rename to src/utils/api/lyrics-api.ts index b5ed3c1b..9fb88f76 100644 --- a/src/utils/api/dlna-api.ts +++ b/src/utils/api/lyrics-api.ts @@ -5,8 +5,8 @@ */ import type { Api } from '../../api'; -import { DlnaApi } from '../../generated-client/api/dlna-api'; +import { LyricsApi } from '../../generated-client/api/lyrics-api'; -export function getDlnaApi(api: Api): DlnaApi { - return new DlnaApi(api.configuration, undefined, api.axiosInstance); +export function getLyricsApi(api: Api): LyricsApi { + return new LyricsApi(api.configuration, undefined, api.axiosInstance); } diff --git a/src/utils/api/notifications-api.ts b/src/utils/api/notifications-api.ts deleted file mode 100644 index e5b856bb..00000000 --- a/src/utils/api/notifications-api.ts +++ /dev/null @@ -1,12 +0,0 @@ -/** - * This Source Code Form is subject to the terms of the Mozilla Public - * License, v. 2.0. If a copy of the MPL was not distributed with this - * file, You can obtain one at http://mozilla.org/MPL/2.0/. - */ - -import type { Api } from '../../api'; -import { NotificationsApi } from '../../generated-client/api/notifications-api'; - -export function getNotificationsApi(api: Api): NotificationsApi { - return new NotificationsApi(api.configuration, undefined, api.axiosInstance); -} diff --git a/src/utils/api/dlna-server-api.ts b/src/utils/api/trickplay-api.ts similarity index 54% rename from src/utils/api/dlna-server-api.ts rename to src/utils/api/trickplay-api.ts index 90c33cc8..6cabedd1 100644 --- a/src/utils/api/dlna-server-api.ts +++ b/src/utils/api/trickplay-api.ts @@ -5,8 +5,8 @@ */ import type { Api } from '../../api'; -import { DlnaServerApi } from '../../generated-client/api/dlna-server-api'; +import { TrickplayApi } from '../../generated-client/api/trickplay-api'; -export function getDlnaServerApi(api: Api): DlnaServerApi { - return new DlnaServerApi(api.configuration, undefined, api.axiosInstance); +export function getTrickplayApi(api: Api): TrickplayApi { + return new TrickplayApi(api.configuration, undefined, api.axiosInstance); } diff --git a/src/versions.ts b/src/versions.ts index 6cb88957..1d39f7e0 100644 --- a/src/versions.ts +++ b/src/versions.ts @@ -5,7 +5,7 @@ */ /** The current API version of the generated client. */ -export const API_VERSION = '10.8.13'; +export const API_VERSION = '10.9.1'; /** The minimum supported server version. */ export const MINIMUM_VERSION = '10.8.1';