@jellyfin/sdk
Version:
A TypeScript SDK for Jellyfin.
225 lines (224 loc) • 10.3 kB
TypeScript
/**
* 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 { SearchHintResult } from '../models';
/**
* SearchApi - axios parameter creator
* @export
*/
export declare const SearchApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Gets the search hint result.
* @param {string} searchTerm The search term to filter on.
* @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} [userId] Optional. Supply a user id to search within a user\'s library or omit to search all.
* @param {Array<BaseItemKind>} [includeItemTypes] If specified, only results with the specified item types are returned. This allows multiple, comma delimited.
* @param {Array<BaseItemKind>} [excludeItemTypes] If specified, results with these item types are filtered out. This allows multiple, comma delimited.
* @param {Array<MediaType>} [mediaTypes] If specified, only results with the specified media types are returned. This allows multiple, comma delimited.
* @param {string} [parentId] If specified, only children of the parent are returned.
* @param {boolean} [isMovie] Optional filter for movies.
* @param {boolean} [isSeries] Optional filter for series.
* @param {boolean} [isNews] Optional filter for news.
* @param {boolean} [isKids] Optional filter for kids.
* @param {boolean} [isSports] Optional filter for sports.
* @param {boolean} [includePeople] Optional filter whether to include people.
* @param {boolean} [includeMedia] Optional filter whether to include media.
* @param {boolean} [includeGenres] Optional filter whether to include genres.
* @param {boolean} [includeStudios] Optional filter whether to include studios.
* @param {boolean} [includeArtists] Optional filter whether to include artists.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSearchHints: (searchTerm: string, startIndex?: number, limit?: number, userId?: string, includeItemTypes?: Array<BaseItemKind>, excludeItemTypes?: Array<BaseItemKind>, mediaTypes?: Array<MediaType>, parentId?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, includePeople?: boolean, includeMedia?: boolean, includeGenres?: boolean, includeStudios?: boolean, includeArtists?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* SearchApi - functional programming interface
* @export
*/
export declare const SearchApiFp: (configuration?: Configuration) => {
/**
*
* @summary Gets the search hint result.
* @param {string} searchTerm The search term to filter on.
* @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} [userId] Optional. Supply a user id to search within a user\'s library or omit to search all.
* @param {Array<BaseItemKind>} [includeItemTypes] If specified, only results with the specified item types are returned. This allows multiple, comma delimited.
* @param {Array<BaseItemKind>} [excludeItemTypes] If specified, results with these item types are filtered out. This allows multiple, comma delimited.
* @param {Array<MediaType>} [mediaTypes] If specified, only results with the specified media types are returned. This allows multiple, comma delimited.
* @param {string} [parentId] If specified, only children of the parent are returned.
* @param {boolean} [isMovie] Optional filter for movies.
* @param {boolean} [isSeries] Optional filter for series.
* @param {boolean} [isNews] Optional filter for news.
* @param {boolean} [isKids] Optional filter for kids.
* @param {boolean} [isSports] Optional filter for sports.
* @param {boolean} [includePeople] Optional filter whether to include people.
* @param {boolean} [includeMedia] Optional filter whether to include media.
* @param {boolean} [includeGenres] Optional filter whether to include genres.
* @param {boolean} [includeStudios] Optional filter whether to include studios.
* @param {boolean} [includeArtists] Optional filter whether to include artists.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSearchHints(searchTerm: string, startIndex?: number, limit?: number, userId?: string, includeItemTypes?: Array<BaseItemKind>, excludeItemTypes?: Array<BaseItemKind>, mediaTypes?: Array<MediaType>, parentId?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, includePeople?: boolean, includeMedia?: boolean, includeGenres?: boolean, includeStudios?: boolean, includeArtists?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchHintResult>>;
};
/**
* SearchApi - factory interface
* @export
*/
export declare const SearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Gets the search hint result.
* @param {SearchApiGetSearchHintsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSearchHints(requestParameters: SearchApiGetSearchHintsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchHintResult>;
};
/**
* Request parameters for getSearchHints operation in SearchApi.
* @export
* @interface SearchApiGetSearchHintsRequest
*/
export interface SearchApiGetSearchHintsRequest {
/**
* The search term to filter on.
* @type {string}
* @memberof SearchApiGetSearchHints
*/
readonly searchTerm: string;
/**
* Optional. The record index to start at. All items with a lower index will be dropped from the results.
* @type {number}
* @memberof SearchApiGetSearchHints
*/
readonly startIndex?: number;
/**
* Optional. The maximum number of records to return.
* @type {number}
* @memberof SearchApiGetSearchHints
*/
readonly limit?: number;
/**
* Optional. Supply a user id to search within a user\'s library or omit to search all.
* @type {string}
* @memberof SearchApiGetSearchHints
*/
readonly userId?: string;
/**
* If specified, only results with the specified item types are returned. This allows multiple, comma delimited.
* @type {Array<BaseItemKind>}
* @memberof SearchApiGetSearchHints
*/
readonly includeItemTypes?: Array<BaseItemKind>;
/**
* If specified, results with these item types are filtered out. This allows multiple, comma delimited.
* @type {Array<BaseItemKind>}
* @memberof SearchApiGetSearchHints
*/
readonly excludeItemTypes?: Array<BaseItemKind>;
/**
* If specified, only results with the specified media types are returned. This allows multiple, comma delimited.
* @type {Array<MediaType>}
* @memberof SearchApiGetSearchHints
*/
readonly mediaTypes?: Array<MediaType>;
/**
* If specified, only children of the parent are returned.
* @type {string}
* @memberof SearchApiGetSearchHints
*/
readonly parentId?: string;
/**
* Optional filter for movies.
* @type {boolean}
* @memberof SearchApiGetSearchHints
*/
readonly isMovie?: boolean;
/**
* Optional filter for series.
* @type {boolean}
* @memberof SearchApiGetSearchHints
*/
readonly isSeries?: boolean;
/**
* Optional filter for news.
* @type {boolean}
* @memberof SearchApiGetSearchHints
*/
readonly isNews?: boolean;
/**
* Optional filter for kids.
* @type {boolean}
* @memberof SearchApiGetSearchHints
*/
readonly isKids?: boolean;
/**
* Optional filter for sports.
* @type {boolean}
* @memberof SearchApiGetSearchHints
*/
readonly isSports?: boolean;
/**
* Optional filter whether to include people.
* @type {boolean}
* @memberof SearchApiGetSearchHints
*/
readonly includePeople?: boolean;
/**
* Optional filter whether to include media.
* @type {boolean}
* @memberof SearchApiGetSearchHints
*/
readonly includeMedia?: boolean;
/**
* Optional filter whether to include genres.
* @type {boolean}
* @memberof SearchApiGetSearchHints
*/
readonly includeGenres?: boolean;
/**
* Optional filter whether to include studios.
* @type {boolean}
* @memberof SearchApiGetSearchHints
*/
readonly includeStudios?: boolean;
/**
* Optional filter whether to include artists.
* @type {boolean}
* @memberof SearchApiGetSearchHints
*/
readonly includeArtists?: boolean;
}
/**
* SearchApi - object-oriented interface
* @export
* @class SearchApi
* @extends {BaseAPI}
*/
export declare class SearchApi extends BaseAPI {
/**
*
* @summary Gets the search hint result.
* @param {SearchApiGetSearchHintsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SearchApi
*/
getSearchHints(requestParameters: SearchApiGetSearchHintsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchHintResult, any>>;
}