@bitmovin/api-sdk/dist/encoding/filters/scale/ScaleApi.d.ts

Bitmovin JS/TS API SDK

import { BaseAPI } from '../../../common/BaseAPI';
import Configuration from '../../../common/Configuration';
import CustomdataApi from './customdata/CustomdataApi';
import BitmovinResponse from '../../../models/BitmovinResponse';
import ScaleFilter from '../../../models/ScaleFilter';
import PaginationResponse from '../../../models/PaginationResponse';
import { ScaleFilterListQueryParams, ScaleFilterListQueryParamsBuilder } from './ScaleFilterListQueryParams';
/**
 * ScaleApi - object-oriented interface
 * @export
 * @class ScaleApi
 * @extends {BaseAPI}
 */
export default class ScaleApi extends BaseAPI {
    customdata: CustomdataApi;
    constructor(configuration: Configuration);
    /**
     * @summary Create Scale Filter
     * @param {ScaleFilter} scaleFilter The Scale Filter to be created
     * @throws {BitmovinError}
     * @memberof ScaleApi
     */
    create(scaleFilter?: ScaleFilter): Promise<ScaleFilter>;
    /**
     * @summary Delete Scale Filter
     * @param {string} filterId Id of the scale filter
     * @throws {BitmovinError}
     * @memberof ScaleApi
     */
    delete(filterId: string): Promise<BitmovinResponse>;
    /**
     * @summary Scale Filter Details
     * @param {string} filterId Id of the scale filter
     * @throws {BitmovinError}
     * @memberof ScaleApi
     */
    get(filterId: string): Promise<ScaleFilter>;
    /**
     * @summary List Scale Filters
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof ScaleApi
     */
    list(queryParameters?: ScaleFilterListQueryParams | ((q: ScaleFilterListQueryParamsBuilder) => ScaleFilterListQueryParamsBuilder)): Promise<PaginationResponse<ScaleFilter>>;
}