@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
79 lines (78 loc) • 3.62 kB
TypeScript
import { BaseAPI } from '../../../../../common/BaseAPI';
import Configuration from '../../../../../common/Configuration';
import CustomdataApi from './customdata/CustomdataApi';
import BitmovinResponse from '../../../../../models/BitmovinResponse';
import Webhook from '../../../../../models/Webhook';
import PaginationResponse from '../../../../../models/PaginationResponse';
import { WebhookListQueryParams, WebhookListQueryParamsBuilder } from './WebhookListQueryParams';
import { WebhookListByEncodingIdQueryParams, WebhookListByEncodingIdQueryParamsBuilder } from './WebhookListByEncodingIdQueryParams';
/**
* FinishedApi - object-oriented interface
* @export
* @class FinishedApi
* @extends {BaseAPI}
*/
export default class FinishedApi extends BaseAPI {
customdata: CustomdataApi;
constructor(configuration: Configuration);
/**
* @summary Add 'Encoding Finished' Webhook
* @param {Webhook} webhook The 'Encoding Finished' Webhook to be added.
* @throws {BitmovinError}
* @memberof FinishedApi
*/
create(webhook?: Webhook): Promise<Webhook>;
/**
* @summary Add 'Encoding Finished' Webhook for a specific Encoding
* @param {string} encodingId Id of the encoding
* @param {Webhook} webhook The 'Encoding Finished' Webhook to be added. A maximum number of 5 webhooks per Encoding is allowed
* @throws {BitmovinError}
* @memberof FinishedApi
*/
createByEncodingId(encodingId: string, webhook?: Webhook): Promise<Webhook>;
/**
* @summary Delete 'Encoding Finished' Webhook for a specific Encoding
* @param {string} encodingId Id of the encoding
* @param {string} webhookId Id of the webhook
* @throws {BitmovinError}
* @memberof FinishedApi
*/
deleteByEncodingIdAndWebhookId(encodingId: string, webhookId: string): Promise<BitmovinResponse>;
/**
* @summary Delete 'Encoding Finished' Webhook
* @param {string} webhookId Id of the webhook
* @throws {BitmovinError}
* @memberof FinishedApi
*/
deleteByWebhookId(webhookId: string): Promise<BitmovinResponse>;
/**
* @summary 'Encoding Finished' Webhook Details for a specific Encoding
* @param {string} encodingId Id of the encoding
* @param {string} webhookId Id of the webhook
* @throws {BitmovinError}
* @memberof FinishedApi
*/
getByEncodingIdAndWebhookId(encodingId: string, webhookId: string): Promise<Webhook>;
/**
* @summary 'Encoding Finished' Webhook Details
* @param {string} webhookId Id of the webhook
* @throws {BitmovinError}
* @memberof FinishedApi
*/
getByWebhookId(webhookId: string): Promise<Webhook>;
/**
* @summary List 'Encoding Finished' Webhooks
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof FinishedApi
*/
list(queryParameters?: WebhookListQueryParams | ((q: WebhookListQueryParamsBuilder) => WebhookListQueryParamsBuilder)): Promise<PaginationResponse<Webhook>>;
/**
* @summary List 'Encoding Finished' Webhooks for a specific Encoding
* @param {string} encodingId Id of the encoding
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof FinishedApi
*/
listByEncodingId(encodingId: string, queryParameters?: WebhookListByEncodingIdQueryParams | ((q: WebhookListByEncodingIdQueryParamsBuilder) => WebhookListByEncodingIdQueryParamsBuilder)): Promise<PaginationResponse<Webhook>>;
}