@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
46 lines (45 loc) • 1.8 kB
TypeScript
import { BaseAPI } from '../../../common/BaseAPI';
import Configuration from '../../../common/Configuration';
import CustomdataApi from './customdata/CustomdataApi';
import BitmovinResponse from '../../../models/BitmovinResponse';
import UnsharpFilter from '../../../models/UnsharpFilter';
import PaginationResponse from '../../../models/PaginationResponse';
import { UnsharpFilterListQueryParams, UnsharpFilterListQueryParamsBuilder } from './UnsharpFilterListQueryParams';
/**
* UnsharpApi - object-oriented interface
* @export
* @class UnsharpApi
* @extends {BaseAPI}
*/
export default class UnsharpApi extends BaseAPI {
customdata: CustomdataApi;
constructor(configuration: Configuration);
/**
* @summary Create Unsharp Filter
* @param {UnsharpFilter} unsharpFilter The Unsharp Filter to be created
* @throws {BitmovinError}
* @memberof UnsharpApi
*/
create(unsharpFilter?: UnsharpFilter): Promise<UnsharpFilter>;
/**
* @summary Delete Unsharp Filter
* @param {string} filterId Id of the unsharp filter
* @throws {BitmovinError}
* @memberof UnsharpApi
*/
delete(filterId: string): Promise<BitmovinResponse>;
/**
* @summary Unsharp Filter Details
* @param {string} filterId Id of the unsharp filter
* @throws {BitmovinError}
* @memberof UnsharpApi
*/
get(filterId: string): Promise<UnsharpFilter>;
/**
* @summary List Unsharp Filters
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof UnsharpApi
*/
list(queryParameters?: UnsharpFilterListQueryParams | ((q: UnsharpFilterListQueryParamsBuilder) => UnsharpFilterListQueryParamsBuilder)): Promise<PaginationResponse<UnsharpFilter>>;
}