@jellyfin/sdk 0.8.2 → 0.9.0

package/lib/generated-client/api/instant-mix-api.d.ts

@@ -22,7 +22,7 @@ export declare const InstantMixApiAxiosParamCreator: (configuration?: Configurat
     /**
      *
      * @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.
@@ -33,11 +33,11 @@ export declare const InstantMixApiAxiosParamCreator: (configuration?: Configurat
      * @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?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getInstantMixFromAlbum: (itemId: string, userId?: string, limit?: number, fields?: Array<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @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.
@@ -48,7 +48,7 @@ export declare const InstantMixApiAxiosParamCreator: (configuration?: Configurat
      * @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?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getInstantMixFromArtists: (itemId: string, userId?: string, limit?: number, fields?: Array<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Creates an instant playlist based on a given artist.
@@ -68,7 +68,7 @@ export declare const InstantMixApiAxiosParamCreator: (configuration?: Configurat
     /**
      *
      * @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.
@@ -79,7 +79,7 @@ export declare const InstantMixApiAxiosParamCreator: (configuration?: Configurat
      * @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?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getInstantMixFromItem: (itemId: string, userId?: string, limit?: number, fields?: Array<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Creates an instant playlist based on a given genre.
@@ -113,7 +113,7 @@ export declare const InstantMixApiAxiosParamCreator: (configuration?: Configurat
     /**
      *
      * @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.
@@ -124,11 +124,11 @@ export declare const InstantMixApiAxiosParamCreator: (configuration?: Configurat
      * @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?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getInstantMixFromPlaylist: (itemId: string, userId?: string, limit?: number, fields?: Array<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @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.
@@ -139,7 +139,7 @@ export declare const InstantMixApiAxiosParamCreator: (configuration?: Configurat
      * @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?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getInstantMixFromSong: (itemId: string, userId?: string, limit?: number, fields?: Array<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * InstantMixApi - functional programming interface
@@ -149,7 +149,7 @@ export declare const InstantMixApiFp: (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.
@@ -160,11 +160,11 @@ export declare const InstantMixApiFp: (configuration?: Configuration) => {
      * @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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
+    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>>;
     /**
      *
      * @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.
@@ -175,7 +175,7 @@ export declare const InstantMixApiFp: (configuration?: Configuration) => {
      * @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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
+    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>>;
     /**
      *
      * @summary Creates an instant playlist based on a given artist.
@@ -195,7 +195,7 @@ export declare const InstantMixApiFp: (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.
@@ -206,7 +206,7 @@ export declare const InstantMixApiFp: (configuration?: Configuration) => {
      * @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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
+    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>>;
     /**
      *
      * @summary Creates an instant playlist based on a given genre.
@@ -240,7 +240,7 @@ export declare const InstantMixApiFp: (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.
@@ -251,11 +251,11 @@ export declare const InstantMixApiFp: (configuration?: Configuration) => {
      * @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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
+    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>>;
     /**
      *
      * @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.
@@ -266,7 +266,7 @@ export declare const InstantMixApiFp: (configuration?: Configuration) => {
      * @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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
+    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>>;
 };
 /**
  * InstantMixApi - factory interface
@@ -276,7 +276,7 @@ export declare const InstantMixApiFactory: (configuration?: Configuration, baseP
     /**
      *
      * @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.
@@ -287,11 +287,11 @@ export declare const InstantMixApiFactory: (configuration?: Configuration, baseP
      * @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>;
+    getInstantMixFromAlbum(itemId: string, userId?: string, limit?: number, fields?: Array<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: any): AxiosPromise<BaseItemDtoQueryResult>;
     /**
      *
      * @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.
@@ -302,7 +302,7 @@ export declare const InstantMixApiFactory: (configuration?: Configuration, baseP
      * @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>;
+    getInstantMixFromArtists(itemId: string, userId?: string, limit?: number, fields?: Array<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: any): AxiosPromise<BaseItemDtoQueryResult>;
     /**
      *
      * @summary Creates an instant playlist based on a given artist.
@@ -322,7 +322,7 @@ export declare const InstantMixApiFactory: (configuration?: Configuration, baseP
     /**
      *
      * @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.
@@ -333,7 +333,7 @@ export declare const InstantMixApiFactory: (configuration?: Configuration, baseP
      * @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>;
+    getInstantMixFromItem(itemId: string, userId?: string, limit?: number, fields?: Array<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: any): AxiosPromise<BaseItemDtoQueryResult>;
     /**
      *
      * @summary Creates an instant playlist based on a given genre.
@@ -367,7 +367,7 @@ export declare const InstantMixApiFactory: (configuration?: Configuration, baseP
     /**
      *
      * @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.
@@ -378,11 +378,11 @@ export declare const InstantMixApiFactory: (configuration?: Configuration, baseP
      * @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>;
+    getInstantMixFromPlaylist(itemId: string, userId?: string, limit?: number, fields?: Array<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: any): AxiosPromise<BaseItemDtoQueryResult>;
     /**
      *
      * @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.
@@ -393,7 +393,7 @@ export declare const InstantMixApiFactory: (configuration?: Configuration, baseP
      * @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>;
+    getInstantMixFromSong(itemId: string, userId?: string, limit?: number, fields?: Array<ItemFields>, enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, options?: any): AxiosPromise<BaseItemDtoQueryResult>;
 };
 /**
  * Request parameters for getInstantMixFromAlbum operation in InstantMixApi.
@@ -406,7 +406,7 @@ export interface InstantMixApiGetInstantMixFromAlbumRequest {
      * @type {string}
      * @memberof InstantMixApiGetInstantMixFromAlbum
      */
-    readonly id: string;
+    readonly itemId: string;
     /**
      * Optional. Filter by user id, and attach user data.
      * @type {string}
@@ -461,7 +461,7 @@ export interface InstantMixApiGetInstantMixFromArtistsRequest {
      * @type {string}
      * @memberof InstantMixApiGetInstantMixFromArtists
      */
-    readonly id: string;
+    readonly itemId: string;
     /**
      * Optional. Filter by user id, and attach user data.
      * @type {string}
@@ -571,7 +571,7 @@ export interface InstantMixApiGetInstantMixFromItemRequest {
      * @type {string}
      * @memberof InstantMixApiGetInstantMixFromItem
      */
-    readonly id: string;
+    readonly itemId: string;
     /**
      * Optional. Filter by user id, and attach user data.
      * @type {string}
@@ -736,7 +736,7 @@ export interface InstantMixApiGetInstantMixFromPlaylistRequest {
      * @type {string}
      * @memberof InstantMixApiGetInstantMixFromPlaylist
      */
-    readonly id: string;
+    readonly itemId: string;
     /**
      * Optional. Filter by user id, and attach user data.
      * @type {string}
@@ -791,7 +791,7 @@ export interface InstantMixApiGetInstantMixFromSongRequest {
      * @type {string}
      * @memberof InstantMixApiGetInstantMixFromSong
      */
-    readonly id: string;
+    readonly itemId: string;
     /**
      * Optional. Filter by user id, and attach user data.
      * @type {string}