@jellyfin/sdk
Version:
A TypeScript SDK for Jellyfin.
159 lines (158 loc) • 6.24 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 { BaseItemDtoQueryResult } from '../models';
import type { CollectionType } from '../models';
import type { SpecialViewOptionDto } from '../models';
/**
* UserViewsApi - axios parameter creator
* @export
*/
export declare const UserViewsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Get user view grouping options.
* @param {string} [userId] User id.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getGroupingOptions: (userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get user views.
* @param {string} [userId] User id.
* @param {boolean} [includeExternalContent] Whether or not to include external views such as channels or live tv.
* @param {Array<CollectionType>} [presetViews] Preset views.
* @param {boolean} [includeHidden] Whether or not to include hidden content.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getUserViews: (userId?: string, includeExternalContent?: boolean, presetViews?: Array<CollectionType>, includeHidden?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* UserViewsApi - functional programming interface
* @export
*/
export declare const UserViewsApiFp: (configuration?: Configuration) => {
/**
*
* @summary Get user view grouping options.
* @param {string} [userId] User id.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getGroupingOptions(userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SpecialViewOptionDto>>>;
/**
*
* @summary Get user views.
* @param {string} [userId] User id.
* @param {boolean} [includeExternalContent] Whether or not to include external views such as channels or live tv.
* @param {Array<CollectionType>} [presetViews] Preset views.
* @param {boolean} [includeHidden] Whether or not to include hidden content.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getUserViews(userId?: string, includeExternalContent?: boolean, presetViews?: Array<CollectionType>, includeHidden?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
};
/**
* UserViewsApi - factory interface
* @export
*/
export declare const UserViewsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Get user view grouping options.
* @param {UserViewsApiGetGroupingOptionsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getGroupingOptions(requestParameters?: UserViewsApiGetGroupingOptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<SpecialViewOptionDto>>;
/**
*
* @summary Get user views.
* @param {UserViewsApiGetUserViewsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getUserViews(requestParameters?: UserViewsApiGetUserViewsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
};
/**
* Request parameters for getGroupingOptions operation in UserViewsApi.
* @export
* @interface UserViewsApiGetGroupingOptionsRequest
*/
export interface UserViewsApiGetGroupingOptionsRequest {
/**
* User id.
* @type {string}
* @memberof UserViewsApiGetGroupingOptions
*/
readonly userId?: string;
}
/**
* Request parameters for getUserViews operation in UserViewsApi.
* @export
* @interface UserViewsApiGetUserViewsRequest
*/
export interface UserViewsApiGetUserViewsRequest {
/**
* User id.
* @type {string}
* @memberof UserViewsApiGetUserViews
*/
readonly userId?: string;
/**
* Whether or not to include external views such as channels or live tv.
* @type {boolean}
* @memberof UserViewsApiGetUserViews
*/
readonly includeExternalContent?: boolean;
/**
* Preset views.
* @type {Array<CollectionType>}
* @memberof UserViewsApiGetUserViews
*/
readonly presetViews?: Array<CollectionType>;
/**
* Whether or not to include hidden content.
* @type {boolean}
* @memberof UserViewsApiGetUserViews
*/
readonly includeHidden?: boolean;
}
/**
* UserViewsApi - object-oriented interface
* @export
* @class UserViewsApi
* @extends {BaseAPI}
*/
export declare class UserViewsApi extends BaseAPI {
/**
*
* @summary Get user view grouping options.
* @param {UserViewsApiGetGroupingOptionsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof UserViewsApi
*/
getGroupingOptions(requestParameters?: UserViewsApiGetGroupingOptionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SpecialViewOptionDto[], any>>;
/**
*
* @summary Get user views.
* @param {UserViewsApiGetUserViewsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof UserViewsApi
*/
getUserViews(requestParameters?: UserViewsApiGetUserViewsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any>>;
}