@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
51 lines (50 loc) • 1.99 kB
TypeScript
import { BaseAPI } from '../../../../../common/BaseAPI';
import Configuration from '../../../../../common/Configuration';
import BitmovinResponse from '../../../../../models/BitmovinResponse';
import Webhook from '../../../../../models/Webhook';
import PaginationResponse from '../../../../../models/PaginationResponse';
/**
* ErrorApi - object-oriented interface
* @export
* @class ErrorApi
* @extends {BaseAPI}
*/
export default class ErrorApi extends BaseAPI {
constructor(configuration: Configuration);
/**
* @summary Add 'Manifest Error' Webhook (All Manifests)
* @param {Webhook} webhook The 'Manifest Error' Webhook to be added.
* @throws {BitmovinError}
* @memberof ErrorApi
*/
create(webhook?: Webhook): Promise<Webhook>;
/**
* @summary Add 'Manifest Error' Webhook Notification (Specific Manifest)
* @param {string} manifestId Id of the manifest resource
* @param {Webhook} webhook The webhook notifications object. A maximum number of 5 webhooks per Manifest is allowed
* @throws {BitmovinError}
* @memberof ErrorApi
*/
createByManifestId(manifestId: string, webhook?: Webhook): Promise<Webhook>;
/**
* @summary Delete 'Manifest Error' Webhook
* @param {string} notificationId Id of the webhook notification
* @throws {BitmovinError}
* @memberof ErrorApi
*/
delete(notificationId: string): Promise<BitmovinResponse>;
/**
* @summary Get 'Manifest Error' Webhooks (All Manifests)
* @throws {BitmovinError}
* @memberof ErrorApi
*/
list(): Promise<PaginationResponse<Webhook>>;
/**
* @summary Replace 'Manifest Error' Webhook Notification
* @param {string} notificationId Id of the webhook notification
* @param {Webhook} webhook The webhook notification with the updated values
* @throws {BitmovinError}
* @memberof ErrorApi
*/
update(notificationId: string, webhook?: Webhook): Promise<Webhook>;
}