@jellyfin/sdk/lib/generated-client/api/suggestions-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 { BaseItemDtoQueryResult } from '../models';
import type { BaseItemKind } from '../models';
import type { MediaType } from '../models';
/**
 * SuggestionsApi - axios parameter creator
 * @export
 */
export declare const SuggestionsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Gets suggestions.
     * @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.
     * @param {boolean} [enableTotalRecordCount] Whether to enable the total record count.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getSuggestions: (userId?: string, mediaType?: Array<MediaType>, type?: Array<BaseItemKind>, startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * SuggestionsApi - functional programming interface
 * @export
 */
export declare const SuggestionsApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Gets suggestions.
     * @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.
     * @param {boolean} [enableTotalRecordCount] Whether to enable the total record count.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getSuggestions(userId?: string, mediaType?: Array<MediaType>, type?: Array<BaseItemKind>, startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
};
/**
 * SuggestionsApi - factory interface
 * @export
 */
export declare const SuggestionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Gets suggestions.
     * @param {SuggestionsApiGetSuggestionsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getSuggestions(requestParameters?: SuggestionsApiGetSuggestionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
};
/**
 * Request parameters for getSuggestions operation in SuggestionsApi.
 * @export
 * @interface SuggestionsApiGetSuggestionsRequest
 */
export interface SuggestionsApiGetSuggestionsRequest {
    /**
     * The user id.
     * @type {string}
     * @memberof SuggestionsApiGetSuggestions
     */
    readonly userId?: string;
    /**
     * The media types.
     * @type {Array<MediaType>}
     * @memberof SuggestionsApiGetSuggestions
     */
    readonly mediaType?: Array<MediaType>;
    /**
     * The type.
     * @type {Array<BaseItemKind>}
     * @memberof SuggestionsApiGetSuggestions
     */
    readonly type?: Array<BaseItemKind>;
    /**
     * Optional. The start index.
     * @type {number}
     * @memberof SuggestionsApiGetSuggestions
     */
    readonly startIndex?: number;
    /**
     * Optional. The limit.
     * @type {number}
     * @memberof SuggestionsApiGetSuggestions
     */
    readonly limit?: number;
    /**
     * Whether to enable the total record count.
     * @type {boolean}
     * @memberof SuggestionsApiGetSuggestions
     */
    readonly enableTotalRecordCount?: boolean;
}
/**
 * SuggestionsApi - object-oriented interface
 * @export
 * @class SuggestionsApi
 * @extends {BaseAPI}
 */
export declare class SuggestionsApi extends BaseAPI {
    /**
     *
     * @summary Gets suggestions.
     * @param {SuggestionsApiGetSuggestionsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SuggestionsApi
     */
    getSuggestions(requestParameters?: SuggestionsApiGetSuggestionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any>>;
}