@jellyfin/sdk 0.7.0

package/lib/generated-client/api/studios-api.d.ts

@@ -0,0 +1,289 @@
+/**
+ * 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 { AxiosPromise, AxiosInstance } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { BaseItemDto } from '../models';
+import { BaseItemDtoQueryResult } from '../models';
+import { BaseItemKind } from '../models';
+import { ImageType } from '../models';
+import { ItemFields } from '../models';
+/**
+ * StudiosApi - axios parameter creator
+ * @export
+ */
+export declare const StudiosApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Gets a studio by name.
+     * @param {string} name Studio name.
+     * @param {string} [userId] Optional. Filter by user id, and attach user data.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStudio: (name: string, userId?: string, options?: any) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Gets all studios from a given item, folder, or the entire library.
+     * @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} [searchTerm] Optional. Search term.
+     * @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>} [excludeItemTypes] Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.
+     * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
+     * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
+     * @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.
+     * @param {string} [userId] User id.
+     * @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 {boolean} [enableImages] Optional, include image information in output.
+     * @param {boolean} [enableTotalRecordCount] Total record count.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStudios: (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>;
+};
+/**
+ * StudiosApi - functional programming interface
+ * @export
+ */
+export declare const StudiosApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Gets a studio by name.
+     * @param {string} name Studio name.
+     * @param {string} [userId] Optional. Filter by user id, and attach user data.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStudio(name: string, userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>;
+    /**
+     *
+     * @summary Gets all studios from a given item, folder, or the entire library.
+     * @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} [searchTerm] Optional. Search term.
+     * @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>} [excludeItemTypes] Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.
+     * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
+     * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
+     * @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.
+     * @param {string} [userId] User id.
+     * @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 {boolean} [enableImages] Optional, include image information in output.
+     * @param {boolean} [enableTotalRecordCount] Total record count.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStudios(startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
+};
+/**
+ * StudiosApi - factory interface
+ * @export
+ */
+export declare const StudiosApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Gets a studio by name.
+     * @param {string} name Studio name.
+     * @param {string} [userId] Optional. Filter by user id, and attach user data.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStudio(name: string, userId?: string, options?: any): AxiosPromise<BaseItemDto>;
+    /**
+     *
+     * @summary Gets all studios from a given item, folder, or the entire library.
+     * @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} [searchTerm] Optional. Search term.
+     * @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>} [excludeItemTypes] Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.
+     * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
+     * @param {boolean} [isFavorite] Optional filter by items that are marked as favorite, or not.
+     * @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.
+     * @param {string} [userId] User id.
+     * @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 {boolean} [enableImages] Optional, include image information in output.
+     * @param {boolean} [enableTotalRecordCount] Total record count.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStudios(startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: Array<ItemFields>, excludeItemTypes?: Array<BaseItemKind>, includeItemTypes?: Array<BaseItemKind>, isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: Array<ImageType>, userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>;
+};
+/**
+ * Request parameters for getStudio operation in StudiosApi.
+ * @export
+ * @interface StudiosApiGetStudioRequest
+ */
+export interface StudiosApiGetStudioRequest {
+    /**
+     * Studio name.
+     * @type {string}
+     * @memberof StudiosApiGetStudio
+     */
+    readonly name: string;
+    /**
+     * Optional. Filter by user id, and attach user data.
+     * @type {string}
+     * @memberof StudiosApiGetStudio
+     */
+    readonly userId?: string;
+}
+/**
+ * Request parameters for getStudios operation in StudiosApi.
+ * @export
+ * @interface StudiosApiGetStudiosRequest
+ */
+export interface StudiosApiGetStudiosRequest {
+    /**
+     * Optional. The record index to start at. All items with a lower index will be dropped from the results.
+     * @type {number}
+     * @memberof StudiosApiGetStudios
+     */
+    readonly startIndex?: number;
+    /**
+     * Optional. The maximum number of records to return.
+     * @type {number}
+     * @memberof StudiosApiGetStudios
+     */
+    readonly limit?: number;
+    /**
+     * Optional. Search term.
+     * @type {string}
+     * @memberof StudiosApiGetStudios
+     */
+    readonly searchTerm?: string;
+    /**
+     * Specify this to localize the search to a specific item or folder. Omit to use the root.
+     * @type {string}
+     * @memberof StudiosApiGetStudios
+     */
+    readonly parentId?: string;
+    /**
+     * Optional. Specify additional fields of information to return in the output.
+     * @type {Array<ItemFields>}
+     * @memberof StudiosApiGetStudios
+     */
+    readonly fields?: Array<ItemFields>;
+    /**
+     * Optional. If specified, results will be filtered out based on item type. This allows multiple, comma delimited.
+     * @type {Array<BaseItemKind>}
+     * @memberof StudiosApiGetStudios
+     */
+    readonly excludeItemTypes?: Array<BaseItemKind>;
+    /**
+     * Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
+     * @type {Array<BaseItemKind>}
+     * @memberof StudiosApiGetStudios
+     */
+    readonly includeItemTypes?: Array<BaseItemKind>;
+    /**
+     * Optional filter by items that are marked as favorite, or not.
+     * @type {boolean}
+     * @memberof StudiosApiGetStudios
+     */
+    readonly isFavorite?: boolean;
+    /**
+     * Optional, include user data.
+     * @type {boolean}
+     * @memberof StudiosApiGetStudios
+     */
+    readonly enableUserData?: boolean;
+    /**
+     * Optional, the max number of images to return, per image type.
+     * @type {number}
+     * @memberof StudiosApiGetStudios
+     */
+    readonly imageTypeLimit?: number;
+    /**
+     * Optional. The image types to include in the output.
+     * @type {Array<ImageType>}
+     * @memberof StudiosApiGetStudios
+     */
+    readonly enableImageTypes?: Array<ImageType>;
+    /**
+     * User id.
+     * @type {string}
+     * @memberof StudiosApiGetStudios
+     */
+    readonly userId?: string;
+    /**
+     * Optional filter by items whose name is sorted equally or greater than a given input string.
+     * @type {string}
+     * @memberof StudiosApiGetStudios
+     */
+    readonly nameStartsWithOrGreater?: string;
+    /**
+     * Optional filter by items whose name is sorted equally than a given input string.
+     * @type {string}
+     * @memberof StudiosApiGetStudios
+     */
+    readonly nameStartsWith?: string;
+    /**
+     * Optional filter by items whose name is equally or lesser than a given input string.
+     * @type {string}
+     * @memberof StudiosApiGetStudios
+     */
+    readonly nameLessThan?: string;
+    /**
+     * Optional, include image information in output.
+     * @type {boolean}
+     * @memberof StudiosApiGetStudios
+     */
+    readonly enableImages?: boolean;
+    /**
+     * Total record count.
+     * @type {boolean}
+     * @memberof StudiosApiGetStudios
+     */
+    readonly enableTotalRecordCount?: boolean;
+}
+/**
+ * StudiosApi - object-oriented interface
+ * @export
+ * @class StudiosApi
+ * @extends {BaseAPI}
+ */
+export declare class StudiosApi extends BaseAPI {
+    /**
+     *
+     * @summary Gets a studio by name.
+     * @param {StudiosApiGetStudioRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StudiosApi
+     */
+    getStudio(requestParameters: StudiosApiGetStudioRequest, options?: any): Promise<import("axios").AxiosResponse<BaseItemDto, any>>;
+    /**
+     *
+     * @summary Gets all studios from a given item, folder, or the entire library.
+     * @param {StudiosApiGetStudiosRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StudiosApi
+     */
+    getStudios(requestParameters?: StudiosApiGetStudiosRequest, options?: any): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any>>;
+}