@jellyfin/sdk
Version:
A TypeScript SDK for Jellyfin.
102 lines (101 loc) • 3.6 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';
/**
* VideoAttachmentsApi - axios parameter creator
* @export
*/
export declare const VideoAttachmentsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Get video attachment.
* @param {string} videoId Video ID.
* @param {string} mediaSourceId Media Source ID.
* @param {number} index Attachment Index.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAttachment: (videoId: string, mediaSourceId: string, index: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* VideoAttachmentsApi - functional programming interface
* @export
*/
export declare const VideoAttachmentsApiFp: (configuration?: Configuration) => {
/**
*
* @summary Get video attachment.
* @param {string} videoId Video ID.
* @param {string} mediaSourceId Media Source ID.
* @param {number} index Attachment Index.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAttachment(videoId: string, mediaSourceId: string, index: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
};
/**
* VideoAttachmentsApi - factory interface
* @export
*/
export declare const VideoAttachmentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Get video attachment.
* @param {VideoAttachmentsApiGetAttachmentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAttachment(requestParameters: VideoAttachmentsApiGetAttachmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
};
/**
* Request parameters for getAttachment operation in VideoAttachmentsApi.
* @export
* @interface VideoAttachmentsApiGetAttachmentRequest
*/
export interface VideoAttachmentsApiGetAttachmentRequest {
/**
* Video ID.
* @type {string}
* @memberof VideoAttachmentsApiGetAttachment
*/
readonly videoId: string;
/**
* Media Source ID.
* @type {string}
* @memberof VideoAttachmentsApiGetAttachment
*/
readonly mediaSourceId: string;
/**
* Attachment Index.
* @type {number}
* @memberof VideoAttachmentsApiGetAttachment
*/
readonly index: number;
}
/**
* VideoAttachmentsApi - object-oriented interface
* @export
* @class VideoAttachmentsApi
* @extends {BaseAPI}
*/
export declare class VideoAttachmentsApi extends BaseAPI {
/**
*
* @summary Get video attachment.
* @param {VideoAttachmentsApiGetAttachmentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof VideoAttachmentsApi
*/
getAttachment(requestParameters: VideoAttachmentsApiGetAttachmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
}