@bitmovin/api-sdk/dist/encoding/templates/TemplatesApi.d.ts

Bitmovin JS/TS API SDK

import { BaseAPI } from '../../common/BaseAPI';
import Configuration from '../../common/Configuration';
import BitmovinResponse from '../../models/BitmovinResponse';
import EncodingTemplateDetails from '../../models/EncodingTemplateDetails';
import EncodingTemplateResponse from '../../models/EncodingTemplateResponse';
import EncodingTemplateStartResponse from '../../models/EncodingTemplateStartResponse';
import PaginationResponse from '../../models/PaginationResponse';
import { EncodingTemplateResponseListQueryParams, EncodingTemplateResponseListQueryParamsBuilder } from './EncodingTemplateResponseListQueryParams';
/**
 * TemplatesApi - object-oriented interface
 * @export
 * @class TemplatesApi
 * @extends {BaseAPI}
 */
export default class TemplatesApi extends BaseAPI {
    constructor(configuration: Configuration);
    /**
     * @summary Store an Encoding Template
     * @param {any} encodingTemplateRequest The Encoding Template to be stored
     * @throws {BitmovinError}
     * @memberof TemplatesApi
     */
    create(encodingTemplateRequest?: any): Promise<EncodingTemplateDetails>;
    /**
     * @summary Delete Encoding Template
     * @param {string} encodingTemplateId Id of the encoding template to delete
     * @throws {BitmovinError}
     * @memberof TemplatesApi
     */
    delete(encodingTemplateId: string): Promise<BitmovinResponse>;
    /**
     * @summary Encoding Template details
     * @param {string} encodingTemplateId Id of the Encoding Template
     * @throws {BitmovinError}
     * @memberof TemplatesApi
     */
    get(encodingTemplateId: string): Promise<EncodingTemplateDetails>;
    /**
     * @summary List stored Encoding Templates
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof TemplatesApi
     */
    list(queryParameters?: EncodingTemplateResponseListQueryParams | ((q: EncodingTemplateResponseListQueryParamsBuilder) => EncodingTemplateResponseListQueryParamsBuilder)): Promise<PaginationResponse<EncodingTemplateResponse>>;
    /**
     * @summary Start an Encoding defined with an Encoding Template
     * @param {any} encodingTemplateRequest The Encoding Template to start an Encoding from
     * @throws {BitmovinError}
     * @memberof TemplatesApi
     */
    start(encodingTemplateRequest?: any): Promise<EncodingTemplateStartResponse>;
}