@jellyfin/sdk
Version:
A TypeScript SDK for Jellyfin.
96 lines (95 loc) • 3.79 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 { MediaSegmentDtoQueryResult } from '../models';
import type { MediaSegmentType } from '../models';
/**
* MediaSegmentsApi - axios parameter creator
* @export
*/
export declare const MediaSegmentsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Gets all media segments based on an itemId.
* @param {string} itemId The ItemId.
* @param {Array<MediaSegmentType>} [includeSegmentTypes] Optional filter of requested segment types.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getItemSegments: (itemId: string, includeSegmentTypes?: Array<MediaSegmentType>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* MediaSegmentsApi - functional programming interface
* @export
*/
export declare const MediaSegmentsApiFp: (configuration?: Configuration) => {
/**
*
* @summary Gets all media segments based on an itemId.
* @param {string} itemId The ItemId.
* @param {Array<MediaSegmentType>} [includeSegmentTypes] Optional filter of requested segment types.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getItemSegments(itemId: string, includeSegmentTypes?: Array<MediaSegmentType>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MediaSegmentDtoQueryResult>>;
};
/**
* MediaSegmentsApi - factory interface
* @export
*/
export declare const MediaSegmentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Gets all media segments based on an itemId.
* @param {MediaSegmentsApiGetItemSegmentsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getItemSegments(requestParameters: MediaSegmentsApiGetItemSegmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<MediaSegmentDtoQueryResult>;
};
/**
* Request parameters for getItemSegments operation in MediaSegmentsApi.
* @export
* @interface MediaSegmentsApiGetItemSegmentsRequest
*/
export interface MediaSegmentsApiGetItemSegmentsRequest {
/**
* The ItemId.
* @type {string}
* @memberof MediaSegmentsApiGetItemSegments
*/
readonly itemId: string;
/**
* Optional filter of requested segment types.
* @type {Array<MediaSegmentType>}
* @memberof MediaSegmentsApiGetItemSegments
*/
readonly includeSegmentTypes?: Array<MediaSegmentType>;
}
/**
* MediaSegmentsApi - object-oriented interface
* @export
* @class MediaSegmentsApi
* @extends {BaseAPI}
*/
export declare class MediaSegmentsApi extends BaseAPI {
/**
*
* @summary Gets all media segments based on an itemId.
* @param {MediaSegmentsApiGetItemSegmentsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof MediaSegmentsApi
*/
getItemSegments(requestParameters: MediaSegmentsApiGetItemSegmentsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MediaSegmentDtoQueryResult, any>>;
}