@jellyfin/sdk/lib/generated-client/api/movies-api.d.ts

A TypeScript SDK for Jellyfin.

/**
 * 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 type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import { type RequestArgs, BaseAPI } from '../base';
import type { ItemFields } from '../models';
import type { RecommendationDto } from '../models';
/**
 * MoviesApi - axios parameter creator
 * @export
 */
export declare const MoviesApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Gets movie recommendations.
     * @param {string} [userId] Optional. Filter by user id, and attach user data.
     * @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. The fields to return.
     * @param {number} [categoryLimit] The max number of categories to return.
     * @param {number} [itemLimit] The max number of items to return per category.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getMovieRecommendations: (userId?: string, parentId?: string, fields?: Array<ItemFields>, categoryLimit?: number, itemLimit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * MoviesApi - functional programming interface
 * @export
 */
export declare const MoviesApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Gets movie recommendations.
     * @param {string} [userId] Optional. Filter by user id, and attach user data.
     * @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. The fields to return.
     * @param {number} [categoryLimit] The max number of categories to return.
     * @param {number} [itemLimit] The max number of items to return per category.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getMovieRecommendations(userId?: string, parentId?: string, fields?: Array<ItemFields>, categoryLimit?: number, itemLimit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RecommendationDto>>>;
};
/**
 * MoviesApi - factory interface
 * @export
 */
export declare const MoviesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Gets movie recommendations.
     * @param {MoviesApiGetMovieRecommendationsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getMovieRecommendations(requestParameters?: MoviesApiGetMovieRecommendationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<RecommendationDto>>;
};
/**
 * Request parameters for getMovieRecommendations operation in MoviesApi.
 * @export
 * @interface MoviesApiGetMovieRecommendationsRequest
 */
export interface MoviesApiGetMovieRecommendationsRequest {
    /**
     * Optional. Filter by user id, and attach user data.
     * @type {string}
     * @memberof MoviesApiGetMovieRecommendations
     */
    readonly userId?: string;
    /**
     * Specify this to localize the search to a specific item or folder. Omit to use the root.
     * @type {string}
     * @memberof MoviesApiGetMovieRecommendations
     */
    readonly parentId?: string;
    /**
     * Optional. The fields to return.
     * @type {Array<ItemFields>}
     * @memberof MoviesApiGetMovieRecommendations
     */
    readonly fields?: Array<ItemFields>;
    /**
     * The max number of categories to return.
     * @type {number}
     * @memberof MoviesApiGetMovieRecommendations
     */
    readonly categoryLimit?: number;
    /**
     * The max number of items to return per category.
     * @type {number}
     * @memberof MoviesApiGetMovieRecommendations
     */
    readonly itemLimit?: number;
}
/**
 * MoviesApi - object-oriented interface
 * @export
 * @class MoviesApi
 * @extends {BaseAPI}
 */
export declare class MoviesApi extends BaseAPI {
    /**
     *
     * @summary Gets movie recommendations.
     * @param {MoviesApiGetMovieRecommendationsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof MoviesApi
     */
    getMovieRecommendations(requestParameters?: MoviesApiGetMovieRecommendationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RecommendationDto[], any>>;
}