@bitmovin/api-sdk/dist/encoding/encodings/inputStreams/file/FileApi.d.ts

Bitmovin JS/TS API SDK

import { BaseAPI } from '../../../../common/BaseAPI';
import Configuration from '../../../../common/Configuration';
import BitmovinResponse from '../../../../models/BitmovinResponse';
import FileInputStream from '../../../../models/FileInputStream';
import PaginationResponse from '../../../../models/PaginationResponse';
import { FileInputStreamListQueryParams, FileInputStreamListQueryParamsBuilder } from './FileInputStreamListQueryParams';
/**
 * FileApi - object-oriented interface
 * @export
 * @class FileApi
 * @extends {BaseAPI}
 */
export default class FileApi extends BaseAPI {
    constructor(configuration: Configuration);
    /**
     * @summary Add File input stream
     * @param {string} encodingId Id of the encoding.
     * @param {FileInputStream} fileInputStream The File input stream to be created
     * @throws {BitmovinError}
     * @memberof FileApi
     */
    create(encodingId: string, fileInputStream?: FileInputStream): Promise<FileInputStream>;
    /**
     * @summary Delete File stream
     * @param {string} encodingId Id of the encoding.
     * @param {string} inputStreamId Id of the File input stream.
     * @throws {BitmovinError}
     * @memberof FileApi
     */
    delete(encodingId: string, inputStreamId: string): Promise<BitmovinResponse>;
    /**
     * @summary File input stream details
     * @param {string} encodingId Id of the encoding.
     * @param {string} inputStreamId Id of the File input stream.
     * @throws {BitmovinError}
     * @memberof FileApi
     */
    get(encodingId: string, inputStreamId: string): Promise<FileInputStream>;
    /**
     * @summary List File input stream
     * @param {string} encodingId Id of the encoding.
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof FileApi
     */
    list(encodingId: string, queryParameters?: FileInputStreamListQueryParams | ((q: FileInputStreamListQueryParamsBuilder) => FileInputStreamListQueryParamsBuilder)): Promise<PaginationResponse<FileInputStream>>;
}