Merge pull request #694 from jellyfin/openapi-update-0

Update OpenAPI to 10.9.0
This commit is contained in:
Bill Thornton 2024-05-14 14:53:17 -04:00 committed by GitHub
commit d2aca7c3be
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
164 changed files with 6678 additions and 5066 deletions

4
openapi.json vendored
View File

@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:0ef41c6408992817d9a3be00aa0266ba19b92757fb51f48c8d5332a08bf5e4b3
size 853085
oid sha256:fd06ef9c4b4d7071278563d5843a7f02834390f155ea5309ca13d06817c74b38
size 850061

View File

@ -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

View File

@ -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';

View File

@ -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<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
* @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
* @param {Array<string>} [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<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
* @param {Array<SortOrder>} [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<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<string>, genres?: Array<string>, genreIds?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, studioIds?: Array<string>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<string>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
getAlbumArtists: async (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, genres?: Array<string>, genreIds?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, studioIds?: Array<string>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
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<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
* @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
* @param {Array<string>} [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<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
* @param {Array<SortOrder>} [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<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<string>, genres?: Array<string>, genreIds?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, studioIds?: Array<string>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<string>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
getArtists: async (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, genres?: Array<string>, genreIds?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, studioIds?: Array<string>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
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<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
* @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
* @param {Array<string>} [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<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
* @param {Array<SortOrder>} [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<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<string>, genres?: Array<string>, genreIds?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, studioIds?: Array<string>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<string>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
async getAlbumArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, genres?: Array<string>, genreIds?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, studioIds?: Array<string>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
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<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
* @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
* @param {Array<string>} [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<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
* @param {Array<SortOrder>} [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<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<string>, genres?: Array<string>, genreIds?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, studioIds?: Array<string>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<string>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
async getArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, genres?: Array<string>, genreIds?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, studioIds?: Array<string>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
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<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
* @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
* @param {Array<string>} [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<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
* @param {Array<SortOrder>} [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<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<string>, genres?: Array<string>, genreIds?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, studioIds?: Array<string>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<string>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
getAlbumArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, genres?: Array<string>, genreIds?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, studioIds?: Array<string>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
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<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
* @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
* @param {Array<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
* @param {Array<string>} [genreIds] Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.
* @param {Array<string>} [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<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
* @param {Array<SortOrder>} [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<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<string>, genres?: Array<string>, genreIds?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, studioIds?: Array<string>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<string>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
getArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, genres?: Array<string>, genreIds?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, studioIds?: Array<string>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
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<string>}
* @type {Array<MediaType>}
* @memberof ArtistsApiGetAlbumArtists
*/
readonly mediaTypes?: Array<string>
readonly mediaTypes?: Array<MediaType>
/**
* 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<string>}
* @type {Array<ItemSortBy>}
* @memberof ArtistsApiGetAlbumArtists
*/
readonly sortBy?: Array<string>
readonly sortBy?: Array<ItemSortBy>
/**
* Sort Order - Ascending,Descending.
@ -1009,10 +1013,10 @@ export interface ArtistsApiGetArtistsRequest {
/**
* Optional filter by MediaType. Allows multiple, comma delimited.
* @type {Array<string>}
* @type {Array<MediaType>}
* @memberof ArtistsApiGetArtists
*/
readonly mediaTypes?: Array<string>
readonly mediaTypes?: Array<MediaType>
/**
* 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<string>}
* @type {Array<ItemSortBy>}
* @memberof ArtistsApiGetArtists
*/
readonly sortBy?: Array<string>
readonly sortBy?: Array<ItemSortBy>
/**
* Sort Order - Ascending,Descending.

View File

@ -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
*/

View File

@ -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>} [sortOrder] Optional. Sort Order - Ascending,Descending.
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
* @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
* @param {Array<ItemFields>} [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<SortOrder>, filters?: Array<ItemFilter>, sortBy?: Array<string>, fields?: Array<ItemFields>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
getChannelItems: async (channelId: string, folderId?: string, userId?: string, startIndex?: number, limit?: number, sortOrder?: Array<SortOrder>, filters?: Array<ItemFilter>, sortBy?: Array<ItemSortBy>, fields?: Array<ItemFields>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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>} [sortOrder] Optional. Sort Order - Ascending,Descending.
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
* @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
* @param {Array<ItemFields>} [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<SortOrder>, filters?: Array<ItemFilter>, sortBy?: Array<string>, fields?: Array<ItemFields>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
async getChannelItems(channelId: string, folderId?: string, userId?: string, startIndex?: number, limit?: number, sortOrder?: Array<SortOrder>, filters?: Array<ItemFilter>, sortBy?: Array<ItemSortBy>, fields?: Array<ItemFields>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
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>} [sortOrder] Optional. Sort Order - Ascending,Descending.
* @param {Array<ItemFilter>} [filters] Optional. Specify additional filters to apply.
* @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
* @param {Array<ItemFields>} [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<SortOrder>, filters?: Array<ItemFilter>, sortBy?: Array<string>, fields?: Array<ItemFields>, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
getChannelItems(channelId: string, folderId?: string, userId?: string, startIndex?: number, limit?: number, sortOrder?: Array<SortOrder>, filters?: Array<ItemFilter>, sortBy?: Array<ItemSortBy>, fields?: Array<ItemFields>, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
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<string>}
* @type {Array<ItemSortBy>}
* @memberof ChannelsApiGetChannelItems
*/
readonly sortBy?: Array<string>
readonly sortBy?: Array<ItemSortBy>
/**
* Optional. Specify additional fields of information to return in the output.

View File

@ -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<RequestArgs> => {
// 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<void>> {
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<void> {
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<void> {
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.

View File

@ -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<RequestArgs> => {
getDevices: async (userId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
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<DeviceInfoQueryResult>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getDevices(supportsSync, userId, options);
async getDevices(userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceInfoQueryResult>> {
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<DeviceInfoQueryResult> {
return localVarFp.getDevices(supportsSync, userId, options).then((request) => request(axios, basePath));
getDevices(userId?: string, options?: any): AxiosPromise<DeviceInfoQueryResult> {
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));
}
/**

View File

@ -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<RequestArgs> => {
getDisplayPreferences: async (displayPreferencesId: string, client: string, userId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<RequestArgs> => {
updateDisplayPreferences: async (displayPreferencesId: string, client: string, displayPreferencesDto: DisplayPreferencesDto, userId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<DisplayPreferencesDto>> {
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<DisplayPreferencesDto>> {
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<void>> {
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<void>> {
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<DisplayPreferencesDto> {
return localVarFp.getDisplayPreferences(displayPreferencesId, userId, client, options).then((request) => request(axios, basePath));
getDisplayPreferences(displayPreferencesId: string, client: string, userId?: string, options?: any): AxiosPromise<DisplayPreferencesDto> {
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<void> {
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<void> {
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));
}
}

View File

@ -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<RequestArgs> => {
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<RequestArgs> => {
// 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<RequestArgs> => {
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<RequestArgs> => {
// 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<any>> {
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<any>> {
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<any>> {
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<any>> {
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<any> {
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<any> {
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<any> {
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<any> {
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));
}
}

View File

@ -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<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
* @param {Array<string>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
* @param {Array<MediaType>} [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<BaseItemKind>, mediaTypes?: Array<string>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
getQueryFiltersLegacy: async (userId?: string, parentId?: string, includeItemTypes?: Array<BaseItemKind>, mediaTypes?: Array<MediaType>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
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<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
* @param {Array<string>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
* @param {Array<MediaType>} [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<BaseItemKind>, mediaTypes?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryFiltersLegacy>> {
async getQueryFiltersLegacy(userId?: string, parentId?: string, includeItemTypes?: Array<BaseItemKind>, mediaTypes?: Array<MediaType>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryFiltersLegacy>> {
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<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
* @param {Array<string>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
* @param {Array<MediaType>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getQueryFiltersLegacy(userId?: string, parentId?: string, includeItemTypes?: Array<BaseItemKind>, mediaTypes?: Array<string>, options?: any): AxiosPromise<QueryFiltersLegacy> {
getQueryFiltersLegacy(userId?: string, parentId?: string, includeItemTypes?: Array<BaseItemKind>, mediaTypes?: Array<MediaType>, options?: any): AxiosPromise<QueryFiltersLegacy> {
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<string>}
* @type {Array<MediaType>}
* @memberof FilterApiGetQueryFiltersLegacy
*/
readonly mediaTypes?: Array<string>
readonly mediaTypes?: Array<MediaType>
}
/**

View File

@ -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<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
* @param {Array<SortOrder>} [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<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<string>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
getGenres: async (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
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<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
* @param {Array<SortOrder>} [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<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<string>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
async getGenres(startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
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<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
* @param {Array<SortOrder>} [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<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<string>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
getGenres(startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
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<string>}
* @type {Array<ItemSortBy>}
* @memberof GenresApiGetGenres
*/
readonly sortBy?: Array<string>
readonly sortBy?: Array<ItemSortBy>
/**
* Sort Order - Ascending,Descending.

File diff suppressed because it is too large Load Diff

View File

@ -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<ItemFields>} [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<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<ItemFields>} [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<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<ItemFields>} [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<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<ItemFields>} [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<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<ItemFields>} [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<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<ItemFields>} [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<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getInstantMixFromAlbum(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options);
async getInstantMixFromAlbum(itemId: string, userId?: string, limit?: number, fields?: Array<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
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<ItemFields>} [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<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getInstantMixFromArtists(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options);
async getInstantMixFromArtists(itemId: string, userId?: string, limit?: number, fields?: Array<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
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<ItemFields>} [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<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getInstantMixFromItem(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options);
async getInstantMixFromItem(itemId: string, userId?: string, limit?: number, fields?: Array<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
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<ItemFields>} [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<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getInstantMixFromPlaylist(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options);
async getInstantMixFromPlaylist(itemId: string, userId?: string, limit?: number, fields?: Array<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
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<ItemFields>} [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<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getInstantMixFromSong(id, userId, limit, fields, enableImages, enableUserData, imageTypeLimit, enableImageTypes, options);
async getInstantMixFromSong(itemId: string, userId?: string, limit?: number, fields?: Array<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
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<ItemFields>} [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<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
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<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
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<ItemFields>} [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<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
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<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
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<ItemFields>} [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<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
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<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
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<ItemFields>} [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<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
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<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
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<ItemFields>} [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<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
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<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
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));
}
}

File diff suppressed because it is too large Load Diff

View File

@ -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<RequestArgs> => {
getLibraryOptionsInfo: async (libraryContentType?: CollectionType, isNewLibrary?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
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<LibraryOptionsResultDto>> {
async getLibraryOptionsInfo(libraryContentType?: CollectionType, isNewLibrary?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LibraryOptionsResultDto>> {
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<LibraryOptionsResultDto> {
getLibraryOptionsInfo(libraryContentType?: CollectionType, isNewLibrary?: boolean, options?: any): AxiosPromise<LibraryOptionsResultDto> {
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.

View File

@ -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<ImageType>} [enableImageTypes] \&quot;Optional. The image types to include in the output.
* @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output.
* @param {boolean} [enableUserData] Optional. Include user data.
* @param {Array<string>} [sortBy] Optional. Key to sort by.
* @param {Array<ItemSortBy>} [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<ImageType>, fields?: Array<ItemFields>, enableUserData?: boolean, sortBy?: Array<string>, sortOrder?: SortOrder, enableFavoriteSorting?: boolean, addCurrentProgram?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
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<ImageType>, fields?: Array<ItemFields>, enableUserData?: boolean, sortBy?: Array<ItemSortBy>, sortOrder?: SortOrder, enableFavoriteSorting?: boolean, addCurrentProgram?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
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<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate.
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate.
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
* @param {Array<string>} [genres] The genres to return guide information for.
* @param {Array<string>} [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<string>, 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<string>, sortOrder?: Array<SortOrder>, genres?: Array<string>, genreIds?: Array<string>, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, seriesTimerId?: string, librarySeriesId?: string, fields?: Array<ItemFields>, enableTotalRecordCount?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
getLiveTvPrograms: async (channelIds?: Array<string>, 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<ItemSortBy>, sortOrder?: Array<SortOrder>, genres?: Array<string>, genreIds?: Array<string>, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, seriesTimerId?: string, librarySeriesId?: string, fields?: Array<ItemFields>, enableTotalRecordCount?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
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<ImageType>} [enableImageTypes] \&quot;Optional. The image types to include in the output.
* @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output.
* @param {boolean} [enableUserData] Optional. Include user data.
* @param {Array<string>} [sortBy] Optional. Key to sort by.
* @param {Array<ItemSortBy>} [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<ImageType>, fields?: Array<ItemFields>, enableUserData?: boolean, sortBy?: Array<string>, sortOrder?: SortOrder, enableFavoriteSorting?: boolean, addCurrentProgram?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
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<ImageType>, fields?: Array<ItemFields>, enableUserData?: boolean, sortBy?: Array<ItemSortBy>, sortOrder?: SortOrder, enableFavoriteSorting?: boolean, addCurrentProgram?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
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<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate.
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate.
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
* @param {Array<string>} [genres] The genres to return guide information for.
* @param {Array<string>} [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<string>, 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<string>, sortOrder?: Array<SortOrder>, genres?: Array<string>, genreIds?: Array<string>, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, seriesTimerId?: string, librarySeriesId?: string, fields?: Array<ItemFields>, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
async getLiveTvPrograms(channelIds?: Array<string>, 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<ItemSortBy>, sortOrder?: Array<SortOrder>, genres?: Array<string>, genreIds?: Array<string>, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, seriesTimerId?: string, librarySeriesId?: string, fields?: Array<ItemFields>, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
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<ImageType>} [enableImageTypes] \&quot;Optional. The image types to include in the output.
* @param {Array<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output.
* @param {boolean} [enableUserData] Optional. Include user data.
* @param {Array<string>} [sortBy] Optional. Key to sort by.
* @param {Array<ItemSortBy>} [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<ImageType>, fields?: Array<ItemFields>, enableUserData?: boolean, sortBy?: Array<string>, sortOrder?: SortOrder, enableFavoriteSorting?: boolean, addCurrentProgram?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
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<ImageType>, fields?: Array<ItemFields>, enableUserData?: boolean, sortBy?: Array<ItemSortBy>, sortOrder?: SortOrder, enableFavoriteSorting?: boolean, addCurrentProgram?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
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<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate.
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate.
* @param {Array<SortOrder>} [sortOrder] Sort Order - Ascending,Descending.
* @param {Array<string>} [genres] The genres to return guide information for.
* @param {Array<string>} [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<string>, 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<string>, sortOrder?: Array<SortOrder>, genres?: Array<string>, genreIds?: Array<string>, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, seriesTimerId?: string, librarySeriesId?: string, fields?: Array<ItemFields>, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
getLiveTvPrograms(channelIds?: Array<string>, 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<ItemSortBy>, sortOrder?: Array<SortOrder>, genres?: Array<string>, genreIds?: Array<string>, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, seriesTimerId?: string, librarySeriesId?: string, fields?: Array<ItemFields>, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
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<string>}
* @type {Array<ItemSortBy>}
* @memberof LiveTvApiGetLiveTvChannels
*/
readonly sortBy?: Array<string>
readonly sortBy?: Array<ItemSortBy>
/**
* Optional. Sort order.
@ -3781,10 +3783,10 @@ export interface LiveTvApiGetLiveTvProgramsRequest {
/**
* Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate.
* @type {Array<string>}
* @type {Array<ItemSortBy>}
* @memberof LiveTvApiGetLiveTvPrograms
*/
readonly sortBy?: Array<string>
readonly sortBy?: Array<ItemSortBy>
/**
* Sort Order - Ascending,Descending.

View File

@ -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<RequestArgs> => {
// 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<RequestArgs> => {
// 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<RequestArgs> => {
// 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<RequestArgs> => {
// 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<RequestArgs> => {
// 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<RequestArgs> => {
// 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<void>> {
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<LyricDto>> {
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<LyricDto>> {
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<LyricDto>> {
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<Array<RemoteLyricInfoDto>>> {
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<LyricDto>> {
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<void> {
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<LyricDto> {
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<LyricDto> {
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<LyricDto> {
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<Array<RemoteLyricInfoDto>> {
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<LyricDto> {
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));
}
}

View File

@ -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<RequestArgs> => {
getPlaybackInfo: async (itemId: string, userId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<PlaybackInfoResponse>> {
async getPlaybackInfo(itemId: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlaybackInfoResponse>> {
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<PlaybackInfoResponse> {
getPlaybackInfo(itemId: string, userId?: string, options?: any): AxiosPromise<PlaybackInfoResponse> {
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
}
/**

View File

@ -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<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
* @param {Array<SortOrder>} [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<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<string>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
getMusicGenres: async (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
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<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
* @param {Array<SortOrder>} [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<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<string>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
async getMusicGenres(startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
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<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited.
* @param {Array<SortOrder>} [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<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<string>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
getMusicGenres(startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, sortBy?: Array<ItemSortBy>, sortOrder?: Array<SortOrder>, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
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<string>}
* @type {Array<ItemSortBy>}
* @memberof MusicGenresApiGetMusicGenres
*/
readonly sortBy?: Array<string>
readonly sortBy?: Array<ItemSortBy>
/**
* Sort Order - Ascending,Descending.

View File

@ -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<string>, userId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
addItemToPlaylist: async (playlistId: string, ids?: Array<string>, userId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<string>} [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<string>, userId?: string, mediaType?: string, createPlaylistDto?: CreatePlaylistDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
createPlaylist: async (name?: string, ids?: Array<string>, userId?: string, mediaType?: MediaType, createPlaylistDto?: CreatePlaylistDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
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<ItemFields>} [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<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
getPlaylistItems: async (playlistId: string, userId?: string, startIndex?: number, limit?: number, fields?: Array<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<RequestArgs> => {
// 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<RequestArgs> => {
// 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<string>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
removeItemFromPlaylist: async (playlistId: string, entryIds?: Array<string>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<RequestArgs> => {
// 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<RequestArgs> => {
// 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<RequestArgs> => {
// 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<string>, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.addToPlaylist(playlistId, ids, userId, options);
async addItemToPlaylist(playlistId: string, ids?: Array<string>, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
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<string>} [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<string>, userId?: string, mediaType?: string, createPlaylistDto?: CreatePlaylistDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlaylistCreationResult>> {
async createPlaylist(name?: string, ids?: Array<string>, userId?: string, mediaType?: MediaType, createPlaylistDto?: CreatePlaylistDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlaylistCreationResult>> {
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<ItemFields>} [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<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
async getPlaylistItems(playlistId: string, userId?: string, startIndex?: number, limit?: number, fields?: Array<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
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<PlaylistUserPermissions>> {
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<Array<PlaylistUserPermissions>>> {
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<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.removeFromPlaylist(playlistId, entryIds, options);
async removeItemFromPlaylist(playlistId: string, entryIds?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
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<void>> {
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<void>> {
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<void>> {
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<string>, userId?: string, options?: any): AxiosPromise<void> {
return localVarFp.addToPlaylist(playlistId, ids, userId, options).then((request) => request(axios, basePath));
addItemToPlaylist(playlistId: string, ids?: Array<string>, userId?: string, options?: any): AxiosPromise<void> {
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<string>} [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<string>, userId?: string, mediaType?: string, createPlaylistDto?: CreatePlaylistDto, options?: any): AxiosPromise<PlaylistCreationResult> {
createPlaylist(name?: string, ids?: Array<string>, userId?: string, mediaType?: MediaType, createPlaylistDto?: CreatePlaylistDto, options?: any): AxiosPromise<PlaylistCreationResult> {
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<ItemFields>} [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<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
getPlaylistItems(playlistId: string, userId?: string, startIndex?: number, limit?: number, fields?: Array<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
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<PlaylistUserPermissions> {
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<Array<PlaylistUserPermissions>> {
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<string>, options?: any): AxiosPromise<void> {
return localVarFp.removeFromPlaylist(playlistId, entryIds, options).then((request) => request(axios, basePath));
removeItemFromPlaylist(playlistId: string, entryIds?: Array<string>, options?: any): AxiosPromise<void> {
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<void> {
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<void> {
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<void> {
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<string>}
* @memberof PlaylistsApiAddToPlaylist
* @memberof PlaylistsApiAddItemToPlaylist
*/
readonly ids?: Array<string>
/**
* 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<ImageType>
}
/**
* 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<string>}
* @memberof PlaylistsApiRemoveFromPlaylist
* @memberof PlaylistsApiRemoveItemFromPlaylist
*/
readonly entryIds?: Array<string>
}
/**
* 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));
}
}

View File

@ -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<RequestArgs> => {
// verify required parameter 'userId' is not null or undefined
assertParamExists('markPlayedItem', 'userId', userId)
markPlayedItem: async (itemId: string, userId?: string, datePlayed?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<RequestArgs> => {
// verify required parameter 'userId' is not null or undefined
assertParamExists('markUnplayedItem', 'userId', userId)
markUnplayedItem: async (itemId: string, userId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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 &#x3D; 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<RequestArgs> => {
// 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<RequestArgs> => {
// 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<RequestArgs> => {
// 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<RequestArgs> => {
// 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<RequestArgs> => {
// 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<RequestArgs> => {
// 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<UserItemDataDto>> {
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<UserItemDataDto>> {
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<UserItemDataDto>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.markUnplayedItem(userId, itemId, options);
async markUnplayedItem(itemId: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>> {
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 &#x3D; 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<void>> {
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<void>> {
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<void>> {
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<void>> {
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<void>> {
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<void>> {
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<UserItemDataDto> {
return localVarFp.markPlayedItem(userId, itemId, datePlayed, options).then((request) => request(axios, basePath));
markPlayedItem(itemId: string, userId?: string, datePlayed?: string, options?: any): AxiosPromise<UserItemDataDto> {
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<UserItemDataDto> {
return localVarFp.markUnplayedItem(userId, itemId, options).then((request) => request(axios, basePath));
markUnplayedItem(itemId: string, userId?: string, options?: any): AxiosPromise<UserItemDataDto> {
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 &#x3D; 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<void> {
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<void> {
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<void> {
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<void> {
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<void> {
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<void> {
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));
}
/**

View File

@ -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<RequestArgs> => {
authorizeQuickConnect: async (code: string, userId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<RequestArgs> => {
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<RequestArgs> => {
getQuickConnectState: async (secret: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<RequestArgs> => {
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<RequestArgs> => {
initiateQuickConnect: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
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<boolean>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.authorize(code, options);
async authorizeQuickConnect(code: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>> {
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<boolean>> {
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<QuickConnectResult>> {
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<boolean>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getEnabled(options);
async getQuickConnectState(secret: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuickConnectResult>> {
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<QuickConnectResult>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.initiate(options);
async initiateQuickConnect(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuickConnectResult>> {
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<boolean> {
return localVarFp.authorize(code, options).then((request) => request(axios, basePath));
authorizeQuickConnect(code: string, userId?: string, options?: any): AxiosPromise<boolean> {
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<boolean> {
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<QuickConnectResult> {
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<boolean> {
return localVarFp.getEnabled(options).then((request) => request(axios, basePath));
getQuickConnectState(secret: string, options?: any): AxiosPromise<QuickConnectResult> {
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<QuickConnectResult> {
return localVarFp.initiate(options).then((request) => request(axios, basePath));
initiateQuickConnect(options?: any): AxiosPromise<QuickConnectResult> {
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));
}
}

View File

@ -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\&#39;s library or omit to search all.
* @param {Array<BaseItemKind>} [includeItemTypes] If specified, only results with the specified item types are returned. This allows multiple, comma delimeted.
* @param {Array<BaseItemKind>} [excludeItemTypes] If specified, results with these item types are filtered out. This allows multiple, comma delimeted.
* @param {Array<string>} [mediaTypes] If specified, only results with the specified media types are returned. This allows multiple, comma delimeted.
* @param {Array<BaseItemKind>} [includeItemTypes] If specified, only results with the specified item types are returned. This allows multiple, comma delimited.
* @param {Array<BaseItemKind>} [excludeItemTypes] If specified, results with these item types are filtered out. This allows multiple, comma delimited.
* @param {Array<MediaType>} [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<BaseItemKind>, excludeItemTypes?: Array<BaseItemKind>, mediaTypes?: Array<string>, 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<RequestArgs> => {
getSearchHints: async (searchTerm: string, startIndex?: number, limit?: number, userId?: string, includeItemTypes?: Array<BaseItemKind>, excludeItemTypes?: Array<BaseItemKind>, mediaTypes?: Array<MediaType>, 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<RequestArgs> => {
// 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\&#39;s library or omit to search all.
* @param {Array<BaseItemKind>} [includeItemTypes] If specified, only results with the specified item types are returned. This allows multiple, comma delimeted.
* @param {Array<BaseItemKind>} [excludeItemTypes] If specified, results with these item types are filtered out. This allows multiple, comma delimeted.
* @param {Array<string>} [mediaTypes] If specified, only results with the specified media types are returned. This allows multiple, comma delimeted.
* @param {Array<BaseItemKind>} [includeItemTypes] If specified, only results with the specified item types are returned. This allows multiple, comma delimited.
* @param {Array<BaseItemKind>} [excludeItemTypes] If specified, results with these item types are filtered out. This allows multiple, comma delimited.
* @param {Array<MediaType>} [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<BaseItemKind>, excludeItemTypes?: Array<BaseItemKind>, mediaTypes?: Array<string>, 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<SearchHintResult>> {
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<BaseItemKind>, excludeItemTypes?: Array<BaseItemKind>, mediaTypes?: Array<MediaType>, 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<SearchHintResult>> {
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\&#39;s library or omit to search all.
* @param {Array<BaseItemKind>} [includeItemTypes] If specified, only results with the specified item types are returned. This allows multiple, comma delimeted.
* @param {Array<BaseItemKind>} [excludeItemTypes] If specified, results with these item types are filtered out. This allows multiple, comma delimeted.
* @param {Array<string>} [mediaTypes] If specified, only results with the specified media types are returned. This allows multiple, comma delimeted.
* @param {Array<BaseItemKind>} [includeItemTypes] If specified, only results with the specified item types are returned. This allows multiple, comma delimited.
* @param {Array<BaseItemKind>} [excludeItemTypes] If specified, results with these item types are filtered out. This allows multiple, comma delimited.
* @param {Array<MediaType>} [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<BaseItemKind>, excludeItemTypes?: Array<BaseItemKind>, mediaTypes?: Array<string>, 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<SearchHintResult> {
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<BaseItemKind>, excludeItemTypes?: Array<BaseItemKind>, mediaTypes?: Array<MediaType>, 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<SearchHintResult> {
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\&#39;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<BaseItemKind>}
* @memberof SearchApiGet
* @memberof SearchApiGetSearchHints
*/
readonly includeItemTypes?: Array<BaseItemKind>
/**
* 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<BaseItemKind>}
* @memberof SearchApiGet
* @memberof SearchApiGetSearchHints
*/
readonly excludeItemTypes?: Array<BaseItemKind>
/**
* If specified, only results with the specified media types are returned. This allows multiple, comma delimeted.
* @type {Array<string>}
* @memberof SearchApiGet
* If specified, only results with the specified media types are returned. This allows multiple, comma delimited.
* @type {Array<MediaType>}
* @memberof SearchApiGetSearchHints
*/
readonly mediaTypes?: Array<string>
readonly mediaTypes?: Array<MediaType>
/**
* 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));
}
}

View File

@ -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<string>} [playableMediaTypes] A list of playable media types, comma delimited. Audio, Video, Book, Photo.
* @param {Array<MediaType>} [playableMediaTypes] A list of playable media types, comma delimited. Audio, Video, Book, Photo.
* @param {Array<GeneralCommandType>} [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<string>, supportedCommands?: Array<GeneralCommandType>, supportsMediaControl?: boolean, supportsSync?: boolean, supportsPersistentIdentifier?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
postCapabilities: async (id?: string, playableMediaTypes?: Array<MediaType>, supportedCommands?: Array<GeneralCommandType>, supportsMediaControl?: boolean, supportsPersistentIdentifier?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
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<string>} [playableMediaTypes] A list of playable media types, comma delimited. Audio, Video, Book, Photo.
* @param {Array<MediaType>} [playableMediaTypes] A list of playable media types, comma delimited. Audio, Video, Book, Photo.
* @param {Array<GeneralCommandType>} [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<string>, supportedCommands?: Array<GeneralCommandType>, supportsMediaControl?: boolean, supportsSync?: boolean, supportsPersistentIdentifier?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.postCapabilities(id, playableMediaTypes, supportedCommands, supportsMediaControl, supportsSync, supportsPersistentIdentifier, options);
async postCapabilities(id?: string, playableMediaTypes?: Array<MediaType>, supportedCommands?: Array<GeneralCommandType>, supportsMediaControl?: boolean, supportsPersistentIdentifier?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
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<string>} [playableMediaTypes] A list of playable media types, comma delimited. Audio, Video, Book, Photo.
* @param {Array<MediaType>} [playableMediaTypes] A list of playable media types, comma delimited. Audio, Video, Book, Photo.
* @param {Array<GeneralCommandType>} [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<string>, supportedCommands?: Array<GeneralCommandType>, supportsMediaControl?: boolean, supportsSync?: boolean, supportsPersistentIdentifier?: boolean, options?: any): AxiosPromise<void> {
return localVarFp.postCapabilities(id, playableMediaTypes, supportedCommands, supportsMediaControl, supportsSync, supportsPersistentIdentifier, options).then((request) => request(axios, basePath));
postCapabilities(id?: string, playableMediaTypes?: Array<MediaType>, supportedCommands?: Array<GeneralCommandType>, supportsMediaControl?: boolean, supportsPersistentIdentifier?: boolean, options?: any): AxiosPromise<void> {
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<string>}
* @type {Array<MediaType>}
* @memberof SessionApiPostCapabilities
*/
readonly playableMediaTypes?: Array<string>
readonly playableMediaTypes?: Array<MediaType>
/**
* 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));
}
/**

View File

@ -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<RequestArgs> => {
// 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<RequestArgs> => {
// 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<any>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getRemoteSubtitles(id, options);
async getRemoteSubtitles(subtitleId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
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<any> {
return localVarFp.getRemoteSubtitles(id, options).then((request) => request(axios, basePath));
getRemoteSubtitles(subtitleId: string, options?: any): AxiosPromise<any> {
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));
}
/**

View File

@ -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<string>} [mediaType] The media types.
* @param {string} [userId] The user id.
* @param {Array<MediaType>} [mediaType] The media types.
* @param {Array<BaseItemKind>} [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<string>, type?: Array<BaseItemKind>, startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<MediaType>, type?: Array<BaseItemKind>, startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
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<string>} [mediaType] The media types.
* @param {string} [userId] The user id.
* @param {Array<MediaType>} [mediaType] The media types.
* @param {Array<BaseItemKind>} [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<string>, type?: Array<BaseItemKind>, startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
async getSuggestions(userId?: string, mediaType?: Array<MediaType>, type?: Array<BaseItemKind>, startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
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<string>} [mediaType] The media types.
* @param {string} [userId] The user id.
* @param {Array<MediaType>} [mediaType] The media types.
* @param {Array<BaseItemKind>} [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<string>, type?: Array<BaseItemKind>, startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
getSuggestions(userId?: string, mediaType?: Array<MediaType>, type?: Array<BaseItemKind>, startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
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<string>}
* @type {Array<MediaType>}
* @memberof SuggestionsApiGetSuggestions
*/
readonly mediaType?: Array<string>
readonly mediaType?: Array<MediaType>
/**
* 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));
}
}

View File

@ -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';

View File

@ -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 &#x3D; ISO.
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format &#x3D; 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>} [sortOrder] Sort Order - Ascending,Descending.
* @param {Array<SortOrder>} [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<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
* @param {Array<ItemFilter>} [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<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
* @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
* @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
* @param {boolean} [isPlayed] Optional filter by items that are played, or not.
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
* @param {Array<string>} [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<LocationType>, excludeLocationTypes?: Array<LocationType>, isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, excludeItemIds?: Array<string>, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<string>, imageTypes?: Array<ImageType>, sortBy?: Array<string>, isPlayed?: boolean, genres?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, artists?: Array<string>, excludeArtistIds?: Array<string>, artistIds?: Array<string>, albumArtistIds?: Array<string>, contributingArtistIds?: Array<string>, albums?: Array<string>, albumIds?: Array<string>, ids?: Array<string>, videoTypes?: Array<VideoType>, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array<SeriesStatus>, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array<string>, genreIds?: Array<string>, enableTotalRecordCount?: boolean, enableImages?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
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<LocationType>, excludeLocationTypes?: Array<LocationType>, isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, excludeItemIds?: Array<string>, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, imageTypes?: Array<ImageType>, sortBy?: Array<ItemSortBy>, isPlayed?: boolean, genres?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, artists?: Array<string>, excludeArtistIds?: Array<string>, artistIds?: Array<string>, albumArtistIds?: Array<string>, contributingArtistIds?: Array<string>, albums?: Array<string>, albumIds?: Array<string>, ids?: Array<string>, videoTypes?: Array<VideoType>, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array<SeriesStatus>, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array<string>, genreIds?: Array<string>, enableTotalRecordCount?: boolean, enableImages?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
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 &#x3D; ISO.
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format &#x3D; 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>} [sortOrder] Sort Order - Ascending,Descending.
* @param {Array<SortOrder>} [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<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
* @param {Array<ItemFilter>} [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<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
* @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
* @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
* @param {boolean} [isPlayed] Optional filter by items that are played, or not.
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
* @param {Array<string>} [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<LocationType>, excludeLocationTypes?: Array<LocationType>, isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, excludeItemIds?: Array<string>, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<string>, imageTypes?: Array<ImageType>, sortBy?: Array<string>, isPlayed?: boolean, genres?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, artists?: Array<string>, excludeArtistIds?: Array<string>, artistIds?: Array<string>, albumArtistIds?: Array<string>, contributingArtistIds?: Array<string>, albums?: Array<string>, albumIds?: Array<string>, ids?: Array<string>, videoTypes?: Array<VideoType>, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array<SeriesStatus>, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array<string>, genreIds?: Array<string>, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
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<LocationType>, excludeLocationTypes?: Array<LocationType>, isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, excludeItemIds?: Array<string>, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, imageTypes?: Array<ImageType>, sortBy?: Array<ItemSortBy>, isPlayed?: boolean, genres?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, artists?: Array<string>, excludeArtistIds?: Array<string>, artistIds?: Array<string>, albumArtistIds?: Array<string>, contributingArtistIds?: Array<string>, albums?: Array<string>, albumIds?: Array<string>, ids?: Array<string>, videoTypes?: Array<VideoType>, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array<SeriesStatus>, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array<string>, genreIds?: Array<string>, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
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 &#x3D; ISO.
* @param {string} [maxPremiereDate] Optional. The maximum premiere date. Format &#x3D; 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>} [sortOrder] Sort Order - Ascending,Descending.
* @param {Array<SortOrder>} [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<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
* @param {Array<ItemFilter>} [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<string>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
* @param {Array<MediaType>} [mediaTypes] Optional filter by MediaType. Allows multiple, comma delimited.
* @param {Array<ImageType>} [imageTypes] Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.
* @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
* @param {boolean} [isPlayed] Optional filter by items that are played, or not.
* @param {Array<string>} [genres] Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.
* @param {Array<string>} [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<LocationType>, excludeLocationTypes?: Array<LocationType>, isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, excludeItemIds?: Array<string>, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<string>, imageTypes?: Array<ImageType>, sortBy?: Array<string>, isPlayed?: boolean, genres?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, artists?: Array<string>, excludeArtistIds?: Array<string>, artistIds?: Array<string>, albumArtistIds?: Array<string>, contributingArtistIds?: Array<string>, albums?: Array<string>, albumIds?: Array<string>, ids?: Array<string>, videoTypes?: Array<VideoType>, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array<SeriesStatus>, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array<string>, genreIds?: Array<string>, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
getTrailers(userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: Array<LocationType>, excludeLocationTypes?: Array<LocationType>, isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, excludeItemIds?: Array<string>, startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, filters?: Array<ItemFilter>, isFavorite?: boolean, mediaTypes?: Array<MediaType>, imageTypes?: Array<ImageType>, sortBy?: Array<ItemSortBy>, isPlayed?: boolean, genres?: Array<string>, officialRatings?: Array<string>, tags?: Array<string>, years?: Array<number>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, person?: string, personIds?: Array<string>, personTypes?: Array<string>, studios?: Array<string>, artists?: Array<string>, excludeArtistIds?: Array<string>, artistIds?: Array<string>, albumArtistIds?: Array<string>, contributingArtistIds?: Array<string>, albums?: Array<string>, albumIds?: Array<string>, ids?: Array<string>, videoTypes?: Array<VideoType>, minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: Array<SeriesStatus>, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: Array<string>, genreIds?: Array<string>, enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
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<SortOrder>}
* @memberof TrailersApiGetTrailers
*/
@ -1016,10 +1020,10 @@ export interface TrailersApiGetTrailersRequest {
/**
* Optional filter by MediaType. Allows multiple, comma delimited.
* @type {Array<string>}
* @type {Array<MediaType>}
* @memberof TrailersApiGetTrailers
*/
readonly mediaTypes?: Array<string>
readonly mediaTypes?: Array<MediaType>
/**
* 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<string>}
* @type {Array<ItemSortBy>}
* @memberof TrailersApiGetTrailers
*/
readonly sortBy?: Array<string>
readonly sortBy?: Array<ItemSortBy>
/**
* Optional filter by items that are played, or not.

View File

@ -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<RequestArgs> => {
// 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<RequestArgs> => {
// 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<any>> {
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<any>> {
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<any> {
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<any> {
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));
}
}

View File

@ -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<ImageType>} [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<ItemFields>, season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, sortBy?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
getEpisodes: async (seriesId: string, userId?: string, fields?: Array<ItemFields>, season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, sortBy?: ItemSortBy, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<ItemFields>, seriesId?: string, parentId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, nextUpDateCutoff?: string, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, enableRewatching?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
getNextUp: async (userId?: string, startIndex?: number, limit?: number, fields?: Array<ItemFields>, seriesId?: string, parentId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, nextUpDateCutoff?: string, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, enableResumable?: boolean, enableRewatching?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
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<ImageType>} [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<ItemFields>, season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, sortBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
async getEpisodes(seriesId: string, userId?: string, fields?: Array<ItemFields>, season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, sortBy?: ItemSortBy, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
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<ItemFields>, seriesId?: string, parentId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, nextUpDateCutoff?: string, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, enableRewatching?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
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<ItemFields>, seriesId?: string, parentId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, nextUpDateCutoff?: string, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, enableResumable?: boolean, enableRewatching?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
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<ImageType>} [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<ItemFields>, season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, sortBy?: string, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
getEpisodes(seriesId: string, userId?: string, fields?: Array<ItemFields>, season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, sortBy?: ItemSortBy, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
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<ItemFields>, seriesId?: string, parentId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, nextUpDateCutoff?: string, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, enableRewatching?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
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<ItemFields>, seriesId?: string, parentId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, nextUpDateCutoff?: string, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, enableResumable?: boolean, enableRewatching?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
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));
}
/**

View File

@ -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 &#x3D; 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<string>, 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<RequestArgs> => {
getUniversalAudioStream: async (itemId: string, container?: Array<string>, 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<RequestArgs> => {
// 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 &#x3D; 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<string>, 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<RequestArgs> => {
headUniversalAudioStream: async (itemId: string, container?: Array<string>, 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<RequestArgs> => {
// 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 &#x3D; 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<string>, 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<any>> {
async getUniversalAudioStream(itemId: string, container?: Array<string>, 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<any>> {
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 &#x3D; 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<string>, 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<any>> {
async headUniversalAudioStream(itemId: string, container?: Array<string>, 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<any>> {
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 &#x3D; 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<string>, 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<any> {
getUniversalAudioStream(itemId: string, container?: Array<string>, 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<any> {
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 &#x3D; 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<string>, 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<any> {
headUniversalAudioStream(itemId: string, container?: Array<string>, 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<any> {
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.

View File

@ -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<RequestArgs> => {
// 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<RequestArgs> => {
// verify required parameter 'userId' is not null or undefined
assertParamExists('updateUser', 'userId', userId)
updateUser: async (userDto: UserDto, userId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<RequestArgs> => {
// verify required parameter 'userId' is not null or undefined
assertParamExists('updateUserConfiguration', 'userId', userId)
updateUserConfiguration: async (userConfiguration: UserConfiguration, userId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<RequestArgs> => {
// 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<RequestArgs> => {
// verify required parameter 'userId' is not null or undefined
assertParamExists('updateUserPassword', 'userId', userId)
updateUserPassword: async (updateUserPassword: UpdateUserPassword, userId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<AuthenticationResult>> {
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<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.updateUser(userId, userDto, options);
async updateUser(userDto: UserDto, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
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<void>> {
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<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.updateUserEasyPassword(userId, updateUserEasyPassword, options);
async updateUserConfiguration(userConfiguration: UserConfiguration, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
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<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.updateUserPassword(userId, updateUserPassword, options);
async updateUserPassword(updateUserPassword: UpdateUserPassword, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
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<AuthenticationResult> {
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<void> {
return localVarFp.updateUser(userId, userDto, options).then((request) => request(axios, basePath));
updateUser(userDto: UserDto, userId?: string, options?: any): AxiosPromise<void> {
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<void> {
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<void> {
return localVarFp.updateUserEasyPassword(userId, updateUserEasyPassword, options).then((request) => request(axios, basePath));
updateUserConfiguration(userConfiguration: UserConfiguration, userId?: string, options?: any): AxiosPromise<void> {
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<void> {
return localVarFp.updateUserPassword(userId, updateUserPassword, options).then((request) => request(axios, basePath));
updateUserPassword(updateUserPassword: UpdateUserPassword, userId?: string, options?: any): AxiosPromise<void> {
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));
}
/**

View File

@ -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<RequestArgs> => {
// verify required parameter 'userId' is not null or undefined
assertParamExists('deleteUserItemRating', 'userId', userId)
deleteUserItemRating: async (itemId: string, userId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<RequestArgs> => {
// verify required parameter 'userId' is not null or undefined
assertParamExists('getIntros', 'userId', userId)
getIntros: async (itemId: string, userId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<RequestArgs> => {
// verify required parameter 'userId' is not null or undefined
assertParamExists('getItem', 'userId', userId)
getItem: async (itemId: string, userId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output.
* @param {Array<BaseItemKind>} [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<ItemFields>, includeItemTypes?: Array<BaseItemKind>, isPlayed?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, limit?: number, groupItems?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<ItemFields>, includeItemTypes?: Array<BaseItemKind>, isPlayed?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, limit?: number, groupItems?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
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<RequestArgs> => {
// verify required parameter 'userId' is not null or undefined
assertParamExists('getLocalTrailers', 'userId', userId)
getLocalTrailers: async (itemId: string, userId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<RequestArgs> => {
// 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<RequestArgs> => {
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<RequestArgs> => {
// verify required parameter 'userId' is not null or undefined
assertParamExists('getSpecialFeatures', 'userId', userId)
getSpecialFeatures: async (itemId: string, userId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<RequestArgs> => {
// verify required parameter 'userId' is not null or undefined
assertParamExists('markFavoriteItem', 'userId', userId)
markFavoriteItem: async (itemId: string, userId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<RequestArgs> => {
// verify required parameter 'userId' is not null or undefined
assertParamExists('unmarkFavoriteItem', 'userId', userId)
unmarkFavoriteItem: async (itemId: string, userId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<RequestArgs> => {
// verify required parameter 'userId' is not null or undefined
assertParamExists('updateUserItemRating', 'userId', userId)
updateUserItemRating: async (itemId: string, userId?: string, likes?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<UserItemDataDto>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteUserItemRating(userId, itemId, options);
async deleteUserItemRating(itemId: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>> {
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<BaseItemDtoQueryResult>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getIntros(userId, itemId, options);
async getIntros(itemId: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
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<BaseItemDto>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getItem(userId, itemId, options);
async getItem(itemId: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>> {
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<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output.
* @param {Array<BaseItemKind>} [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<ItemFields>, includeItemTypes?: Array<BaseItemKind>, isPlayed?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, limit?: number, groupItems?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BaseItemDto>>> {
async getLatestMedia(userId?: string, parentId?: string, fields?: Array<ItemFields>, includeItemTypes?: Array<BaseItemKind>, isPlayed?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, limit?: number, groupItems?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BaseItemDto>>> {
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<Array<BaseItemDto>>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getLocalTrailers(userId, itemId, options);
async getLocalTrailers(itemId: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BaseItemDto>>> {
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<BaseItemDto>> {
async getRootFolder(userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>> {
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<Array<BaseItemDto>>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getSpecialFeatures(userId, itemId, options);
async getSpecialFeatures(itemId: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BaseItemDto>>> {
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<UserItemDataDto>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.markFavoriteItem(userId, itemId, options);
async markFavoriteItem(itemId: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>> {
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<UserItemDataDto>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.unmarkFavoriteItem(userId, itemId, options);
async unmarkFavoriteItem(itemId: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>> {
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<UserItemDataDto>> {
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<UserItemDataDto>> {
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<UserItemDataDto> {
return localVarFp.deleteUserItemRating(userId, itemId, options).then((request) => request(axios, basePath));
deleteUserItemRating(itemId: string, userId?: string, options?: any): AxiosPromise<UserItemDataDto> {
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<BaseItemDtoQueryResult> {
return localVarFp.getIntros(userId, itemId, options).then((request) => request(axios, basePath));
getIntros(itemId: string, userId?: string, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
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<BaseItemDto> {
return localVarFp.getItem(userId, itemId, options).then((request) => request(axios, basePath));
getItem(itemId: string, userId?: string, options?: any): AxiosPromise<BaseItemDto> {
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<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output.
* @param {Array<BaseItemKind>} [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<ItemFields>, includeItemTypes?: Array<BaseItemKind>, isPlayed?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, limit?: number, groupItems?: boolean, options?: any): AxiosPromise<Array<BaseItemDto>> {
getLatestMedia(userId?: string, parentId?: string, fields?: Array<ItemFields>, includeItemTypes?: Array<BaseItemKind>, isPlayed?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, limit?: number, groupItems?: boolean, options?: any): AxiosPromise<Array<BaseItemDto>> {
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<Array<BaseItemDto>> {
return localVarFp.getLocalTrailers(userId, itemId, options).then((request) => request(axios, basePath));
getLocalTrailers(itemId: string, userId?: string, options?: any): AxiosPromise<Array<BaseItemDto>> {
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<BaseItemDto> {
getRootFolder(userId?: string, options?: any): AxiosPromise<BaseItemDto> {
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<Array<BaseItemDto>> {
return localVarFp.getSpecialFeatures(userId, itemId, options).then((request) => request(axios, basePath));
getSpecialFeatures(itemId: string, userId?: string, options?: any): AxiosPromise<Array<BaseItemDto>> {
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<UserItemDataDto> {
return localVarFp.markFavoriteItem(userId, itemId, options).then((request) => request(axios, basePath));
markFavoriteItem(itemId: string, userId?: string, options?: any): AxiosPromise<UserItemDataDto> {
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<UserItemDataDto> {
return localVarFp.unmarkFavoriteItem(userId, itemId, options).then((request) => request(axios, basePath));
unmarkFavoriteItem(itemId: string, userId?: string, options?: any): AxiosPromise<UserItemDataDto> {
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<UserItemDataDto> {
return localVarFp.updateUserItemRating(userId, itemId, likes, options).then((request) => request(axios, basePath));
updateUserItemRating(itemId: string, userId?: string, likes?: boolean, options?: any): AxiosPromise<UserItemDataDto> {
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));
}
}

View File

@ -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<RequestArgs> => {
// 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<RequestArgs> => {
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<string>} [presetViews] Preset views.
* @param {Array<CollectionType>} [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<string>, includeHidden?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// 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<CollectionType>, includeHidden?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
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<Array<SpecialViewOptionDto>>> {
async getGroupingOptions(userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SpecialViewOptionDto>>> {
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<string>} [presetViews] Preset views.
* @param {Array<CollectionType>} [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<string>, includeHidden?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
async getUserViews(userId?: string, includeExternalContent?: boolean, presetViews?: Array<CollectionType>, includeHidden?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
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<Array<SpecialViewOptionDto>> {
getGroupingOptions(userId?: string, options?: any): AxiosPromise<Array<SpecialViewOptionDto>> {
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<string>} [presetViews] Preset views.
* @param {Array<CollectionType>} [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<string>, includeHidden?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
getUserViews(userId?: string, includeExternalContent?: boolean, presetViews?: Array<CollectionType>, includeHidden?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
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<string>}
* @type {Array<CollectionType>}
* @memberof UserViewsApiGetUserViews
*/
readonly presetViews?: Array<string>
readonly presetViews?: Array<CollectionType>
/**
* 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));
}
}

View File

@ -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<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output.
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be excluded based on item type. This allows multiple, comma delimited.
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be included based on item type. This allows multiple, comma delimited.
* @param {Array<string>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
* @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
* @param {Array<MediaType>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
* @param {boolean} [enableUserData] Optional. Include user data.
* @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type.
* @param {Array<ImageType>} [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<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, mediaTypes?: Array<string>, sortBy?: Array<string>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, userId?: string, recursive?: boolean, enableImages?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
getYears: async (startIndex?: number, limit?: number, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, mediaTypes?: Array<MediaType>, sortBy?: Array<ItemSortBy>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, userId?: string, recursive?: boolean, enableImages?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
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<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output.
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be excluded based on item type. This allows multiple, comma delimited.
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be included based on item type. This allows multiple, comma delimited.
* @param {Array<string>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
* @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
* @param {Array<MediaType>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
* @param {boolean} [enableUserData] Optional. Include user data.
* @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type.
* @param {Array<ImageType>} [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<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, mediaTypes?: Array<string>, sortBy?: Array<string>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, userId?: string, recursive?: boolean, enableImages?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
async getYears(startIndex?: number, limit?: number, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, mediaTypes?: Array<MediaType>, sortBy?: Array<ItemSortBy>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, userId?: string, recursive?: boolean, enableImages?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>> {
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<ItemFields>} [fields] Optional. Specify additional fields of information to return in the output.
* @param {Array<BaseItemKind>} [excludeItemTypes] Optional. If specified, results will be excluded based on item type. This allows multiple, comma delimited.
* @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be included based on item type. This allows multiple, comma delimited.
* @param {Array<string>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
* @param {Array<string>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
* @param {Array<MediaType>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
* @param {Array<ItemSortBy>} [sortBy] Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.
* @param {boolean} [enableUserData] Optional. Include user data.
* @param {number} [imageTypeLimit] Optional. The max number of images to return, per image type.
* @param {Array<ImageType>} [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<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, mediaTypes?: Array<string>, sortBy?: Array<string>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, userId?: string, recursive?: boolean, enableImages?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
getYears(startIndex?: number, limit?: number, sortOrder?: Array<SortOrder>, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, mediaTypes?: Array<MediaType>, sortBy?: Array<ItemSortBy>, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, userId?: string, recursive?: boolean, enableImages?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult> {
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<string>}
* @type {Array<MediaType>}
* @memberof YearsApiGetYears
*/
readonly mediaTypes?: Array<string>
readonly mediaTypes?: Array<MediaType>
/**
* 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<string>}
* @type {Array<ItemSortBy>}
* @memberof YearsApiGetYears
*/
readonly sortBy?: Array<string>
readonly sortBy?: Array<ItemSortBy>
/**
* Optional. Include user data.

View File

@ -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<ActivityLogEntry>}
* @memberof ActivityLogEntryMessage
*/
'Data'?: Array<ActivityLogEntry> | null;
/**
* Gets or sets the message id.
* @type {string}
* @memberof ActivityLogEntryMessage
*/
'MessageId'?: string;
/**
*
* @type {SessionMessageType}
* @memberof ActivityLogEntryMessage
*/
'MessageType'?: SessionMessageType;
}

View File

@ -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;
}

View File

@ -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;
}

View File

@ -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];

View File

@ -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;
}

View File

@ -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<NameGuidPair> | 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<ChapterInfo> | 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}

View File

@ -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}

View File

@ -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;
}

View File

@ -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<string>}
* @type {Array<MediaType>}
* @memberof ClientCapabilitiesDto
*/
'PlayableMediaTypes'?: Array<string>;
'PlayableMediaTypes'?: Array<MediaType>;
/**
* Gets or sets the list of supported commands.
* @type {Array<GeneralCommandType>}
@ -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;
}

View File

@ -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<string>}
* @type {Array<MediaType>}
* @memberof ClientCapabilities
*/
'PlayableMediaTypes'?: Array<string> | null;
'PlayableMediaTypes'?: Array<MediaType> | null;
/**
*
* @type {Array<GeneralCommandType>}
@ -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;
}

View File

@ -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];

View File

@ -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];

View File

@ -32,7 +32,7 @@ export interface ContainerProfile {
* @type {Array<ProfileCondition>}
* @memberof ContainerProfile
*/
'Conditions'?: Array<ProfileCondition> | null;
'Conditions'?: Array<ProfileCondition>;
/**
*
* @type {string}

View File

@ -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<string>}
@ -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<PlaylistUserPermissions>}
* @memberof CreatePlaylistDto
*/
'Users'?: Array<PlaylistUserPermissions>;
/**
* Gets or sets a value indicating whether the playlist is public.
* @type {boolean}
* @memberof CreatePlaylistDto
*/
'IsPublic'?: boolean;
}

View File

@ -24,7 +24,7 @@ export interface CreateUserByName {
* @type {string}
* @memberof CreateUserByName
*/
'Name'?: string | null;
'Name': string;
/**
* Gets or sets the password.
* @type {string}

View File

@ -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}

View File

@ -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. <br /> Specifically, it defines the supported <see cref=\"P:MediaBrowser.Model.Dlna.DeviceProfile.ContainerProfiles\">containers</see> and <see cref=\"P:MediaBrowser.Model.Dlna.DeviceProfile.CodecProfiles\">codecs</see> (video and/or audio, including codec profiles and levels) the device is able to direct play (without transcoding or remuxing), as well as which <see cref=\"P:MediaBrowser.Model.Dlna.DeviceProfile.TranscodingProfiles\">containers/codecs to transcode to</see> 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<XmlAttribute>}
* @memberof DeviceProfile
*/
'XmlRootAttributes'?: Array<XmlAttribute>;
/**
* Gets or sets the direct play profiles.
* @type {Array<DirectPlayProfile>}
@ -249,12 +84,6 @@ export interface DeviceProfile {
* @memberof DeviceProfile
*/
'CodecProfiles'?: Array<CodecProfile>;
/**
* Gets or sets the ResponseProfiles.
* @type {Array<ResponseProfile>}
* @memberof DeviceProfile
*/
'ResponseProfiles'?: Array<ResponseProfile>;
/**
* Gets or sets the subtitle profiles.
* @type {Array<SubtitleProfile>}

View File

@ -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];

View File

@ -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];

View File

@ -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<string>}
* @memberof EncodingOptions
*/
'HardwareDecodingCodecs'?: Array<string> | null;
/**
*
* Gets or sets the file extensions on-demand metadata based keyframe extraction is enabled for.
* @type {Array<string>}
* @memberof EncodingOptions
*/

View File

@ -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];

View File

@ -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];

View File

@ -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;
}

View File

@ -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;
}

View File

@ -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];

View File

@ -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<string>}
* @type {Array<ItemSortBy>}
* @memberof GetProgramsDto
*/
'SortBy'?: Array<string>;
'SortBy'?: Array<ItemSortBy>;
/**
* Gets or sets sort Order - Ascending,Descending.
* @type {Array<SortOrder>}

View File

@ -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;
}

View File

@ -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;
}

View File

@ -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;
}

View File

@ -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;

View File

@ -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];

View File

@ -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];

View File

@ -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];

View File

@ -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;
}

View File

@ -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;

View File

@ -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';

View File

@ -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',

View File

@ -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];

View File

@ -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;
}

View File

@ -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<MediaPathInfo>}
@ -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}

View File

@ -99,5 +99,17 @@ export interface LiveTvOptions {
* @memberof LiveTvOptions
*/
'RecordingPostProcessorArguments'?: string | null;
/**
*
* @type {boolean}
* @memberof LiveTvOptions
*/
'SaveRecordingNFO'?: boolean;
/**
*
* @type {boolean}
* @memberof LiveTvOptions
*/
'SaveRecordingImages'?: boolean;
}

View File

@ -42,6 +42,6 @@ export interface LogFile {
* @type {string}
* @memberof LogFile
*/
'Name'?: string | null;
'Name'?: string;
}

View File

@ -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<LyricLine>}
* @memberof LyricDto
*/
'Lyrics'?: Array<LyricLine>;
}

View File

@ -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;
}

View File

@ -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;
}

View File

@ -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}

View File

@ -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];

View File

@ -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];

View File

@ -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}

View File

@ -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];

View File

@ -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<ExternalIdInfo>;
/**
*
* @type {string}
* @type {CollectionType}
* @memberof MetadataEditorInfo
*/
'ContentType'?: string | null;
'ContentType'?: CollectionType;
/**
*
* @type {Array<NameValuePair>}

View File

@ -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. <seealso cref=\"P:Jellyfin.Networking.Configuration.NetworkConfiguration.IgnoreVirtualInterfaces\" />.
* @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<string>}
* @memberof NetworkConfiguration
*/
'PublishedServerUriBySubnet'?: Array<string>;
/**
* 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 <seealso cref=\"P:Jellyfin.Networking.Configuration.NetworkConfiguration.IsRemoteIPFilterBlacklist\" />.
* @type {Array<string>}
* @memberof NetworkConfiguration
*/
'RemoteIPFilter'?: Array<string>;
/**
* Gets or sets a value indicating whether <seealso cref=\"P:Jellyfin.Networking.Configuration.NetworkConfiguration.RemoteIPFilter\" /> 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<string>;
/**
* 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<string>}
* @memberof NetworkConfiguration
*/
'KnownProxies'?: Array<string>;
/**
* 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. <seealso cref=\"P:MediaBrowser.Common.Net.NetworkConfiguration.IgnoreVirtualInterfaces\" />.
* @type {Array<string>}
* @memberof NetworkConfiguration
*/
'VirtualInterfaceNames'?: Array<string>;
/**
* 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<string>}
* @memberof NetworkConfiguration
*/
'PublishedServerUriBySubnet'?: Array<string>;
/**
* Gets or sets the filter for remote IP connectivity. Used in conjunction with <seealso cref=\"P:MediaBrowser.Common.Net.NetworkConfiguration.IsRemoteIPFilterBlacklist\" />.
* @type {Array<string>}
* @memberof NetworkConfiguration
*/
'RemoteIPFilter'?: Array<string>;
/**
* Gets or sets a value indicating whether <seealso cref=\"P:MediaBrowser.Common.Net.NetworkConfiguration.RemoteIPFilter\" /> contains a blacklist or a whitelist. Default is a whitelist.
* @type {boolean}
* @memberof NetworkConfiguration
*/
'IsRemoteIPFilterBlacklist'?: boolean;
}

View File

@ -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;
}

View File

@ -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;

View File

@ -30,6 +30,6 @@ export interface ParentalRating {
* @type {number}
* @memberof ParentalRating
*/
'Value'?: number;
'Value'?: number | null;
}

View File

@ -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];

View File

@ -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;
}

View File

@ -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;
}

View File

@ -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];

View File

@ -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<SyncPlayQueueItem>}
* @memberof PlayQueueUpdate
*/
'Playlist'?: Array<SyncPlayQueueItem>;
/**
* 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;
}

View File

@ -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];

View File

@ -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<QueueItem>}

View File

@ -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];

View File

@ -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<QueueItem>}

Some files were not shown because too many files have changed in this diff Show More