@bitmovin/api-sdk/dist/encoding/filters/text/TextApi.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 TextFilter from '../../../models/TextFilter';
import PaginationResponse from '../../../models/PaginationResponse';
import { TextFilterListQueryParams, TextFilterListQueryParamsBuilder } from './TextFilterListQueryParams';
/**
 * TextApi - object-oriented interface
 * @export
 * @class TextApi
 * @extends {BaseAPI}
 */
export default class TextApi extends BaseAPI {
    customdata: CustomdataApi;
    constructor(configuration: Configuration);
    /**
     * @summary Create Text Filter
     * @param {TextFilter} textFilter The Text Filter to be created
     * @throws {BitmovinError}
     * @memberof TextApi
     */
    create(textFilter?: TextFilter): Promise<TextFilter>;
    /**
     * @summary Delete Text Filter
     * @param {string} filterId Id of the Text Filter
     * @throws {BitmovinError}
     * @memberof TextApi
     */
    delete(filterId: string): Promise<BitmovinResponse>;
    /**
     * @summary Text Filter Details
     * @param {string} filterId Id of the Text Filter
     * @throws {BitmovinError}
     * @memberof TextApi
     */
    get(filterId: string): Promise<TextFilter>;
    /**
     * @summary List Text Filters
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof TextApi
     */
    list(queryParameters?: TextFilterListQueryParams | ((q: TextFilterListQueryParamsBuilder) => TextFilterListQueryParamsBuilder)): Promise<PaginationResponse<TextFilter>>;
}