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