@jellyfin/sdk/lib/generated-client/api/filter-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 { BaseItemKind } from '../models';
import type { MediaType } from '../models';
import type { QueryFilters } from '../models';
import type { QueryFiltersLegacy } from '../models';
/**
 * FilterApi - axios parameter creator
 * @export
 */
export declare const FilterApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Gets query filters.
     * @param {string} [userId] Optional. User id.
     * @param {string} [parentId] Optional. Specify this to localize the search to a specific item or folder. Omit to use the root.
     * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
     * @param {boolean} [isAiring] Optional. Is item airing.
     * @param {boolean} [isMovie] Optional. Is item movie.
     * @param {boolean} [isSports] Optional. Is item sports.
     * @param {boolean} [isKids] Optional. Is item kids.
     * @param {boolean} [isNews] Optional. Is item news.
     * @param {boolean} [isSeries] Optional. Is item series.
     * @param {boolean} [recursive] Optional. Search recursive.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getQueryFilters: (userId?: string, parentId?: string, includeItemTypes?: Array<BaseItemKind>, isAiring?: boolean, isMovie?: boolean, isSports?: boolean, isKids?: boolean, isNews?: boolean, isSeries?: boolean, recursive?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets legacy query filters.
     * @param {string} [userId] Optional. User id.
     * @param {string} [parentId] Optional. Parent id.
     * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
     * @param {Array<MediaType>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getQueryFiltersLegacy: (userId?: string, parentId?: string, includeItemTypes?: Array<BaseItemKind>, mediaTypes?: Array<MediaType>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * FilterApi - functional programming interface
 * @export
 */
export declare const FilterApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Gets query filters.
     * @param {string} [userId] Optional. User id.
     * @param {string} [parentId] Optional. Specify this to localize the search to a specific item or folder. Omit to use the root.
     * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
     * @param {boolean} [isAiring] Optional. Is item airing.
     * @param {boolean} [isMovie] Optional. Is item movie.
     * @param {boolean} [isSports] Optional. Is item sports.
     * @param {boolean} [isKids] Optional. Is item kids.
     * @param {boolean} [isNews] Optional. Is item news.
     * @param {boolean} [isSeries] Optional. Is item series.
     * @param {boolean} [recursive] Optional. Search recursive.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getQueryFilters(userId?: string, parentId?: string, includeItemTypes?: Array<BaseItemKind>, isAiring?: boolean, isMovie?: boolean, isSports?: boolean, isKids?: boolean, isNews?: boolean, isSeries?: boolean, recursive?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryFilters>>;
    /**
     *
     * @summary Gets legacy query filters.
     * @param {string} [userId] Optional. User id.
     * @param {string} [parentId] Optional. Parent id.
     * @param {Array<BaseItemKind>} [includeItemTypes] Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
     * @param {Array<MediaType>} [mediaTypes] Optional. Filter by MediaType. Allows multiple, comma delimited.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getQueryFiltersLegacy(userId?: string, parentId?: string, includeItemTypes?: Array<BaseItemKind>, mediaTypes?: Array<MediaType>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryFiltersLegacy>>;
};
/**
 * FilterApi - factory interface
 * @export
 */
export declare const FilterApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Gets query filters.
     * @param {FilterApiGetQueryFiltersRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getQueryFilters(requestParameters?: FilterApiGetQueryFiltersRequest, options?: RawAxiosRequestConfig): AxiosPromise<QueryFilters>;
    /**
     *
     * @summary Gets legacy query filters.
     * @param {FilterApiGetQueryFiltersLegacyRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getQueryFiltersLegacy(requestParameters?: FilterApiGetQueryFiltersLegacyRequest, options?: RawAxiosRequestConfig): AxiosPromise<QueryFiltersLegacy>;
};
/**
 * Request parameters for getQueryFilters operation in FilterApi.
 * @export
 * @interface FilterApiGetQueryFiltersRequest
 */
export interface FilterApiGetQueryFiltersRequest {
    /**
     * Optional. User id.
     * @type {string}
     * @memberof FilterApiGetQueryFilters
     */
    readonly userId?: string;
    /**
     * Optional. Specify this to localize the search to a specific item or folder. Omit to use the root.
     * @type {string}
     * @memberof FilterApiGetQueryFilters
     */
    readonly parentId?: string;
    /**
     * Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
     * @type {Array<BaseItemKind>}
     * @memberof FilterApiGetQueryFilters
     */
    readonly includeItemTypes?: Array<BaseItemKind>;
    /**
     * Optional. Is item airing.
     * @type {boolean}
     * @memberof FilterApiGetQueryFilters
     */
    readonly isAiring?: boolean;
    /**
     * Optional. Is item movie.
     * @type {boolean}
     * @memberof FilterApiGetQueryFilters
     */
    readonly isMovie?: boolean;
    /**
     * Optional. Is item sports.
     * @type {boolean}
     * @memberof FilterApiGetQueryFilters
     */
    readonly isSports?: boolean;
    /**
     * Optional. Is item kids.
     * @type {boolean}
     * @memberof FilterApiGetQueryFilters
     */
    readonly isKids?: boolean;
    /**
     * Optional. Is item news.
     * @type {boolean}
     * @memberof FilterApiGetQueryFilters
     */
    readonly isNews?: boolean;
    /**
     * Optional. Is item series.
     * @type {boolean}
     * @memberof FilterApiGetQueryFilters
     */
    readonly isSeries?: boolean;
    /**
     * Optional. Search recursive.
     * @type {boolean}
     * @memberof FilterApiGetQueryFilters
     */
    readonly recursive?: boolean;
}
/**
 * Request parameters for getQueryFiltersLegacy operation in FilterApi.
 * @export
 * @interface FilterApiGetQueryFiltersLegacyRequest
 */
export interface FilterApiGetQueryFiltersLegacyRequest {
    /**
     * Optional. User id.
     * @type {string}
     * @memberof FilterApiGetQueryFiltersLegacy
     */
    readonly userId?: string;
    /**
     * Optional. Parent id.
     * @type {string}
     * @memberof FilterApiGetQueryFiltersLegacy
     */
    readonly parentId?: string;
    /**
     * Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.
     * @type {Array<BaseItemKind>}
     * @memberof FilterApiGetQueryFiltersLegacy
     */
    readonly includeItemTypes?: Array<BaseItemKind>;
    /**
     * Optional. Filter by MediaType. Allows multiple, comma delimited.
     * @type {Array<MediaType>}
     * @memberof FilterApiGetQueryFiltersLegacy
     */
    readonly mediaTypes?: Array<MediaType>;
}
/**
 * FilterApi - object-oriented interface
 * @export
 * @class FilterApi
 * @extends {BaseAPI}
 */
export declare class FilterApi extends BaseAPI {
    /**
     *
     * @summary Gets query filters.
     * @param {FilterApiGetQueryFiltersRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FilterApi
     */
    getQueryFilters(requestParameters?: FilterApiGetQueryFiltersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QueryFilters, any>>;
    /**
     *
     * @summary Gets legacy query filters.
     * @param {FilterApiGetQueryFiltersLegacyRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FilterApi
     */
    getQueryFiltersLegacy(requestParameters?: FilterApiGetQueryFiltersLegacyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QueryFiltersLegacy, any>>;
}