@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
44 lines (43 loc) • 2.18 kB
TypeScript
import { BaseAPI } from '../../../../../common/BaseAPI';
import Configuration from '../../../../../common/Configuration';
import BitmovinResponse from '../../../../../models/BitmovinResponse';
import LiveEncodingHeartbeatWebhook from '../../../../../models/LiveEncodingHeartbeatWebhook';
import PaginationResponse from '../../../../../models/PaginationResponse';
import { LiveEncodingHeartbeatWebhookListQueryParams, LiveEncodingHeartbeatWebhookListQueryParamsBuilder } from './LiveEncodingHeartbeatWebhookListQueryParams';
/**
* LiveEncodingHeartbeatApi - object-oriented interface
* @export
* @class LiveEncodingHeartbeatApi
* @extends {BaseAPI}
*/
export default class LiveEncodingHeartbeatApi extends BaseAPI {
constructor(configuration: Configuration);
/**
* @summary Add 'Live Encoding Heartbeat' Webhook
* @param {LiveEncodingHeartbeatWebhook} liveEncodingHeartbeatWebhook The 'Live Encoding Heartbeat' Webhook to be added.
* @throws {BitmovinError}
* @memberof LiveEncodingHeartbeatApi
*/
create(liveEncodingHeartbeatWebhook?: LiveEncodingHeartbeatWebhook): Promise<LiveEncodingHeartbeatWebhook>;
/**
* @summary Delete 'Live Encoding Heartbeat' Webhook
* @param {string} webhookId Id of the webhook
* @throws {BitmovinError}
* @memberof LiveEncodingHeartbeatApi
*/
deleteByWebhookId(webhookId: string): Promise<BitmovinResponse>;
/**
* @summary 'Live Encoding Heartbeat' Webhook Details
* @param {string} webhookId Id of the webhook
* @throws {BitmovinError}
* @memberof LiveEncodingHeartbeatApi
*/
getByWebhookId(webhookId: string): Promise<LiveEncodingHeartbeatWebhook>;
/**
* @summary List 'Live Encoding Heartbeat' Webhooks
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof LiveEncodingHeartbeatApi
*/
list(queryParameters?: LiveEncodingHeartbeatWebhookListQueryParams | ((q: LiveEncodingHeartbeatWebhookListQueryParamsBuilder) => LiveEncodingHeartbeatWebhookListQueryParamsBuilder)): Promise<PaginationResponse<LiveEncodingHeartbeatWebhook>>;
}