@jellyfin/sdk 0.13.0 → 1.0.0

package/lib/generated-client/api/{tv-shows-api.d.ts → show-api.d.ts}

@@ -16,10 +16,9 @@ import type { ImageType } from '../models';
 import type { ItemFields } from '../models';
 import type { ItemSortBy } from '../models';
 /**
- * TvShowsApi - axios parameter creator
- * @export
+ * ShowApi - axios parameter creator
  */
-export declare const TvShowsApiAxiosParamCreator: (configuration?: Configuration) => {
+export declare const ShowApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
      *
      * @summary Gets episodes for a tv season.
@@ -57,13 +56,12 @@ export declare const TvShowsApiAxiosParamCreator: (configuration?: Configuration
      * @param {boolean} [enableUserData] Optional. Include user data.
      * @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} [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, enableResumable?: boolean, enableRewatching?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    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, enableResumable?: boolean, enableRewatching?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Gets seasons for a tv series.
@@ -99,10 +97,9 @@ export declare const TvShowsApiAxiosParamCreator: (configuration?: Configuration
     getUpcomingEpisodes: (userId?: string, startIndex?: number, limit?: number, fields?: Array<ItemFields>, parentId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
- * TvShowsApi - functional programming interface
- * @export
+ * ShowApi - functional programming interface
  */
-export declare const TvShowsApiFp: (configuration?: Configuration) => {
+export declare const ShowApiFp: (configuration?: Configuration) => {
     /**
      *
      * @summary Gets episodes for a tv season.
@@ -140,13 +137,12 @@ export declare const TvShowsApiFp: (configuration?: Configuration) => {
      * @param {boolean} [enableUserData] Optional. Include user data.
      * @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} [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, enableResumable?: boolean, enableRewatching?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
+    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, enableResumable?: boolean, enableRewatching?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
     /**
      *
      * @summary Gets seasons for a tv series.
@@ -182,406 +178,288 @@ export declare const TvShowsApiFp: (configuration?: Configuration) => {
     getUpcomingEpisodes(userId?: string, startIndex?: number, limit?: number, fields?: Array<ItemFields>, parentId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, enableUserData?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
 };
 /**
- * TvShowsApi - factory interface
- * @export
+ * ShowApi - factory interface
  */
-export declare const TvShowsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+export declare const ShowApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
      *
      * @summary Gets episodes for a tv season.
-     * @param {TvShowsApiGetEpisodesRequest} requestParameters Request parameters.
+     * @param {ShowApiGetEpisodesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getEpisodes(requestParameters: TvShowsApiGetEpisodesRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
+    getEpisodes(requestParameters: ShowApiGetEpisodesRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
     /**
      *
      * @summary Gets a list of next up episodes.
-     * @param {TvShowsApiGetNextUpRequest} requestParameters Request parameters.
+     * @param {ShowApiGetNextUpRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getNextUp(requestParameters?: TvShowsApiGetNextUpRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
+    getNextUp(requestParameters?: ShowApiGetNextUpRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
     /**
      *
      * @summary Gets seasons for a tv series.
-     * @param {TvShowsApiGetSeasonsRequest} requestParameters Request parameters.
+     * @param {ShowApiGetSeasonsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSeasons(requestParameters: TvShowsApiGetSeasonsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
+    getSeasons(requestParameters: ShowApiGetSeasonsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
     /**
      *
      * @summary Gets a list of upcoming episodes.
-     * @param {TvShowsApiGetUpcomingEpisodesRequest} requestParameters Request parameters.
+     * @param {ShowApiGetUpcomingEpisodesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getUpcomingEpisodes(requestParameters?: TvShowsApiGetUpcomingEpisodesRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
+    getUpcomingEpisodes(requestParameters?: ShowApiGetUpcomingEpisodesRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
 };
 /**
- * Request parameters for getEpisodes operation in TvShowsApi.
- * @export
- * @interface TvShowsApiGetEpisodesRequest
+ * Request parameters for getEpisodes operation in ShowApi.
  */
-export interface TvShowsApiGetEpisodesRequest {
+export interface ShowApiGetEpisodesRequest {
     /**
      * The series id.
-     * @type {string}
-     * @memberof TvShowsApiGetEpisodes
      */
     readonly seriesId: string;
     /**
      * The user id.
-     * @type {string}
-     * @memberof TvShowsApiGetEpisodes
      */
     readonly userId?: string;
     /**
      * Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.
-     * @type {Array<ItemFields>}
-     * @memberof TvShowsApiGetEpisodes
      */
     readonly fields?: Array<ItemFields>;
     /**
      * Optional filter by season number.
-     * @type {number}
-     * @memberof TvShowsApiGetEpisodes
      */
     readonly season?: number;
     /**
      * Optional. Filter by season id.
-     * @type {string}
-     * @memberof TvShowsApiGetEpisodes
      */
     readonly seasonId?: string;
     /**
      * Optional. Filter by items that are missing episodes or not.
-     * @type {boolean}
-     * @memberof TvShowsApiGetEpisodes
      */
     readonly isMissing?: boolean;
     /**
      * Optional. Return items that are siblings of a supplied item.
-     * @type {string}
-     * @memberof TvShowsApiGetEpisodes
      */
     readonly adjacentTo?: string;
     /**
      * Optional. Skip through the list until a given item is found.
-     * @type {string}
-     * @memberof TvShowsApiGetEpisodes
      */
     readonly startItemId?: string;
     /**
      * Optional. The record index to start at. All items with a lower index will be dropped from the results.
-     * @type {number}
-     * @memberof TvShowsApiGetEpisodes
      */
     readonly startIndex?: number;
     /**
      * Optional. The maximum number of records to return.
-     * @type {number}
-     * @memberof TvShowsApiGetEpisodes
      */
     readonly limit?: number;
     /**
      * Optional, include image information in output.
-     * @type {boolean}
-     * @memberof TvShowsApiGetEpisodes
      */
     readonly enableImages?: boolean;
     /**
      * Optional, the max number of images to return, per image type.
-     * @type {number}
-     * @memberof TvShowsApiGetEpisodes
      */
     readonly imageTypeLimit?: number;
     /**
      * Optional. The image types to include in the output.
-     * @type {Array<ImageType>}
-     * @memberof TvShowsApiGetEpisodes
      */
     readonly enableImageTypes?: Array<ImageType>;
     /**
      * Optional. Include user data.
-     * @type {boolean}
-     * @memberof TvShowsApiGetEpisodes
      */
     readonly enableUserData?: boolean;
     /**
      * 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 {ItemSortBy}
-     * @memberof TvShowsApiGetEpisodes
      */
     readonly sortBy?: ItemSortBy;
 }
 /**
- * Request parameters for getNextUp operation in TvShowsApi.
- * @export
- * @interface TvShowsApiGetNextUpRequest
+ * Request parameters for getNextUp operation in ShowApi.
  */
-export interface TvShowsApiGetNextUpRequest {
+export interface ShowApiGetNextUpRequest {
     /**
      * The user id of the user to get the next up episodes for.
-     * @type {string}
-     * @memberof TvShowsApiGetNextUp
      */
     readonly userId?: string;
     /**
      * Optional. The record index to start at. All items with a lower index will be dropped from the results.
-     * @type {number}
-     * @memberof TvShowsApiGetNextUp
      */
     readonly startIndex?: number;
     /**
      * Optional. The maximum number of records to return.
-     * @type {number}
-     * @memberof TvShowsApiGetNextUp
      */
     readonly limit?: number;
     /**
      * Optional. Specify additional fields of information to return in the output.
-     * @type {Array<ItemFields>}
-     * @memberof TvShowsApiGetNextUp
      */
     readonly fields?: Array<ItemFields>;
     /**
      * Optional. Filter by series id.
-     * @type {string}
-     * @memberof TvShowsApiGetNextUp
      */
     readonly seriesId?: string;
     /**
      * Optional. Specify this to localize the search to a specific item or folder. Omit to use the root.
-     * @type {string}
-     * @memberof TvShowsApiGetNextUp
      */
     readonly parentId?: string;
     /**
      * Optional. Include image information in output.
-     * @type {boolean}
-     * @memberof TvShowsApiGetNextUp
      */
     readonly enableImages?: boolean;
     /**
      * Optional. The max number of images to return, per image type.
-     * @type {number}
-     * @memberof TvShowsApiGetNextUp
      */
     readonly imageTypeLimit?: number;
     /**
      * Optional. The image types to include in the output.
-     * @type {Array<ImageType>}
-     * @memberof TvShowsApiGetNextUp
      */
     readonly enableImageTypes?: Array<ImageType>;
     /**
      * Optional. Include user data.
-     * @type {boolean}
-     * @memberof TvShowsApiGetNextUp
      */
     readonly enableUserData?: boolean;
     /**
      * Optional. Starting date of shows to show in Next Up section.
-     * @type {string}
-     * @memberof TvShowsApiGetNextUp
      */
     readonly nextUpDateCutoff?: string;
     /**
      * Whether to enable the total records count. Defaults to true.
-     * @type {boolean}
-     * @memberof TvShowsApiGetNextUp
      */
     readonly enableTotalRecordCount?: boolean;
-    /**
-     * Whether to disable sending the first episode in a series as next up.
-     * @type {boolean}
-     * @memberof TvShowsApiGetNextUp
-     */
-    readonly disableFirstEpisode?: boolean;
     /**
      * 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
      */
     readonly enableRewatching?: boolean;
 }
 /**
- * Request parameters for getSeasons operation in TvShowsApi.
- * @export
- * @interface TvShowsApiGetSeasonsRequest
+ * Request parameters for getSeasons operation in ShowApi.
  */
-export interface TvShowsApiGetSeasonsRequest {
+export interface ShowApiGetSeasonsRequest {
     /**
      * The series id.
-     * @type {string}
-     * @memberof TvShowsApiGetSeasons
      */
     readonly seriesId: string;
     /**
      * The user id.
-     * @type {string}
-     * @memberof TvShowsApiGetSeasons
      */
     readonly userId?: string;
     /**
      * Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.
-     * @type {Array<ItemFields>}
-     * @memberof TvShowsApiGetSeasons
      */
     readonly fields?: Array<ItemFields>;
     /**
      * Optional. Filter by special season.
-     * @type {boolean}
-     * @memberof TvShowsApiGetSeasons
      */
     readonly isSpecialSeason?: boolean;
     /**
      * Optional. Filter by items that are missing episodes or not.
-     * @type {boolean}
-     * @memberof TvShowsApiGetSeasons
      */
     readonly isMissing?: boolean;
     /**
      * Optional. Return items that are siblings of a supplied item.
-     * @type {string}
-     * @memberof TvShowsApiGetSeasons
      */
     readonly adjacentTo?: string;
     /**
      * Optional. Include image information in output.
-     * @type {boolean}
-     * @memberof TvShowsApiGetSeasons
      */
     readonly enableImages?: boolean;
     /**
      * Optional. The max number of images to return, per image type.
-     * @type {number}
-     * @memberof TvShowsApiGetSeasons
      */
     readonly imageTypeLimit?: number;
     /**
      * Optional. The image types to include in the output.
-     * @type {Array<ImageType>}
-     * @memberof TvShowsApiGetSeasons
      */
     readonly enableImageTypes?: Array<ImageType>;
     /**
      * Optional. Include user data.
-     * @type {boolean}
-     * @memberof TvShowsApiGetSeasons
      */
     readonly enableUserData?: boolean;
 }
 /**
- * Request parameters for getUpcomingEpisodes operation in TvShowsApi.
- * @export
- * @interface TvShowsApiGetUpcomingEpisodesRequest
+ * Request parameters for getUpcomingEpisodes operation in ShowApi.
  */
-export interface TvShowsApiGetUpcomingEpisodesRequest {
+export interface ShowApiGetUpcomingEpisodesRequest {
     /**
      * The user id of the user to get the upcoming episodes for.
-     * @type {string}
-     * @memberof TvShowsApiGetUpcomingEpisodes
      */
     readonly userId?: string;
     /**
      * Optional. The record index to start at. All items with a lower index will be dropped from the results.
-     * @type {number}
-     * @memberof TvShowsApiGetUpcomingEpisodes
      */
     readonly startIndex?: number;
     /**
      * Optional. The maximum number of records to return.
-     * @type {number}
-     * @memberof TvShowsApiGetUpcomingEpisodes
      */
     readonly limit?: number;
     /**
      * Optional. Specify additional fields of information to return in the output.
-     * @type {Array<ItemFields>}
-     * @memberof TvShowsApiGetUpcomingEpisodes
      */
     readonly fields?: Array<ItemFields>;
     /**
      * Optional. Specify this to localize the search to a specific item or folder. Omit to use the root.
-     * @type {string}
-     * @memberof TvShowsApiGetUpcomingEpisodes
      */
     readonly parentId?: string;
     /**
      * Optional. Include image information in output.
-     * @type {boolean}
-     * @memberof TvShowsApiGetUpcomingEpisodes
      */
     readonly enableImages?: boolean;
     /**
      * Optional. The max number of images to return, per image type.
-     * @type {number}
-     * @memberof TvShowsApiGetUpcomingEpisodes
      */
     readonly imageTypeLimit?: number;
     /**
      * Optional. The image types to include in the output.
-     * @type {Array<ImageType>}
-     * @memberof TvShowsApiGetUpcomingEpisodes
      */
     readonly enableImageTypes?: Array<ImageType>;
     /**
      * Optional. Include user data.
-     * @type {boolean}
-     * @memberof TvShowsApiGetUpcomingEpisodes
      */
     readonly enableUserData?: boolean;
 }
 /**
- * TvShowsApi - object-oriented interface
- * @export
- * @class TvShowsApi
- * @extends {BaseAPI}
+ * ShowApi - object-oriented interface
  */
-export declare class TvShowsApi extends BaseAPI {
+export declare class ShowApi extends BaseAPI {
     /**
      *
      * @summary Gets episodes for a tv season.
-     * @param {TvShowsApiGetEpisodesRequest} requestParameters Request parameters.
+     * @param {ShowApiGetEpisodesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof TvShowsApi
      */
-    getEpisodes(requestParameters: TvShowsApiGetEpisodesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
+    getEpisodes(requestParameters: ShowApiGetEpisodesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
     /**
      *
      * @summary Gets a list of next up episodes.
-     * @param {TvShowsApiGetNextUpRequest} requestParameters Request parameters.
+     * @param {ShowApiGetNextUpRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof TvShowsApi
      */
-    getNextUp(requestParameters?: TvShowsApiGetNextUpRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
+    getNextUp(requestParameters?: ShowApiGetNextUpRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
     /**
      *
      * @summary Gets seasons for a tv series.
-     * @param {TvShowsApiGetSeasonsRequest} requestParameters Request parameters.
+     * @param {ShowApiGetSeasonsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof TvShowsApi
      */
-    getSeasons(requestParameters: TvShowsApiGetSeasonsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
+    getSeasons(requestParameters: ShowApiGetSeasonsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
     /**
      *
      * @summary Gets a list of upcoming episodes.
-     * @param {TvShowsApiGetUpcomingEpisodesRequest} requestParameters Request parameters.
+     * @param {ShowApiGetUpcomingEpisodesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof TvShowsApi
      */
-    getUpcomingEpisodes(requestParameters?: TvShowsApiGetUpcomingEpisodesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
+    getUpcomingEpisodes(requestParameters?: ShowApiGetUpcomingEpisodesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
 }