@bitmovin/api-sdk/dist/notifications/webhooks/encoding/encodings/error/ErrorApi.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 Webhook from '../../../../../models/Webhook';
import PaginationResponse from '../../../../../models/PaginationResponse';
import { WebhookListQueryParams, WebhookListQueryParamsBuilder } from './WebhookListQueryParams';
import { WebhookListByEncodingIdQueryParams, WebhookListByEncodingIdQueryParamsBuilder } from './WebhookListByEncodingIdQueryParams';
/**
 * ErrorApi - object-oriented interface
 * @export
 * @class ErrorApi
 * @extends {BaseAPI}
 */
export default class ErrorApi extends BaseAPI {
    customdata: CustomdataApi;
    constructor(configuration: Configuration);
    /**
     * @summary Add 'Encoding Error' Webhook
     * @param {Webhook} webhook The 'Encoding Error' Webhook to be added.
     * @throws {BitmovinError}
     * @memberof ErrorApi
     */
    create(webhook?: Webhook): Promise<Webhook>;
    /**
     * @summary Add Error Webhook for a specific Encoding
     * @param {string} encodingId Id of the encoding
     * @param {Webhook} webhook The &#39;Encoding Error&#39; Webhook to be added. A maximum number of 5 webhooks per Encoding is allowed
     * @throws {BitmovinError}
     * @memberof ErrorApi
     */
    createByEncodingId(encodingId: string, webhook?: Webhook): Promise<Webhook>;
    /**
     * @summary Delete 'Encoding Error' Webhook for a specific Encoding
     * @param {string} encodingId Id of the encoding
     * @param {string} webhookId Id of the webhook
     * @throws {BitmovinError}
     * @memberof ErrorApi
     */
    deleteByEncodingIdAndWebhookId(encodingId: string, webhookId: string): Promise<BitmovinResponse>;
    /**
     * @summary Delete 'Encoding Error' Webhook
     * @param {string} webhookId Id of the webhook
     * @throws {BitmovinError}
     * @memberof ErrorApi
     */
    deleteByWebhookId(webhookId: string): Promise<BitmovinResponse>;
    /**
     * @summary 'Encoding Error' Webhook Details for a specific Encoding
     * @param {string} encodingId Id of the encoding
     * @param {string} webhookId Id of the webhook
     * @throws {BitmovinError}
     * @memberof ErrorApi
     */
    getByEncodingIdAndWebhookId(encodingId: string, webhookId: string): Promise<Webhook>;
    /**
     * @summary 'Encoding Error' Webhook Details
     * @param {string} webhookId Id of the webhook
     * @throws {BitmovinError}
     * @memberof ErrorApi
     */
    getByWebhookId(webhookId: string): Promise<Webhook>;
    /**
     * @summary List 'Encoding Error' Webhooks
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof ErrorApi
     */
    list(queryParameters?: WebhookListQueryParams | ((q: WebhookListQueryParamsBuilder) => WebhookListQueryParamsBuilder)): Promise<PaginationResponse<Webhook>>;
    /**
     * @summary List 'Encoding Error' Webhooks for a specific Encoding
     * @param {string} encodingId Id of the encoding
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof ErrorApi
     */
    listByEncodingId(encodingId: string, queryParameters?: WebhookListByEncodingIdQueryParams | ((q: WebhookListByEncodingIdQueryParamsBuilder) => WebhookListByEncodingIdQueryParamsBuilder)): Promise<PaginationResponse<Webhook>>;
}