UNPKG

@bitmovin/api-sdk

Version:

Bitmovin JS/TS API SDK

91 lines (90 loc) 6.5 kB
"use strict"; var __extends = (this && this.__extends) || (function () { var extendStatics = function (d, b) { extendStatics = Object.setPrototypeOf || ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) || function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; }; return extendStatics(d, b); }; return function (d, b) { if (typeof b !== "function" && b !== null) throw new TypeError("Class extends value " + String(b) + " is not a constructor or null"); extendStatics(d, b); function __() { this.constructor = d; } d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __()); }; })(); Object.defineProperty(exports, "__esModule", { value: true }); var BaseAPI_1 = require("../../../../../common/BaseAPI"); var Mapper_1 = require("../../../../../common/Mapper"); var BitmovinResponse_1 = require("../../../../../models/BitmovinResponse"); var WebhookNotificationWithStreamConditions_1 = require("../../../../../models/WebhookNotificationWithStreamConditions"); /** * EncodingStatusChangedApi - object-oriented interface * @export * @class EncodingStatusChangedApi * @extends {BaseAPI} */ var EncodingStatusChangedApi = /** @class */ (function (_super) { __extends(EncodingStatusChangedApi, _super); function EncodingStatusChangedApi(configuration) { return _super.call(this, configuration) || this; } /** * @summary Add Encoding Changed Webhook Notification (All Encodings) * @param {WebhookNotificationWithStreamConditionsRequest} webhookNotificationWithStreamConditionsRequest The webhook notifications object. For conditions, following attributes are possible: 'type': 'Input file download', 'Input file analysis', 'Per-Title analysis', 'Encoding', 'Progressive Muxing' 'progress': number in range of 0-100 'status': 'RUNNING', 'FINISHED', 'ERROR' Examples: To only get notified about the encoding process, create a Condition object and set attribute='type', value='Encoding', operator=EQUAL To only get notified if a workflow step is finished, create a Condition object and set attribute='status', value='FINISHED', operator=EQUAL To only get notified if a workflow step is over 50%, create a Condition object and set attribute='progress', value='50', operator=GREATER_THAN * @throws {BitmovinError} * @memberof EncodingStatusChangedApi */ EncodingStatusChangedApi.prototype.create = function (webhookNotificationWithStreamConditionsRequest) { return this.restClient.post('/notifications/webhooks/encoding/encodings/encoding-status-changed', {}, webhookNotificationWithStreamConditionsRequest).then(function (response) { return (0, Mapper_1.map)(response, WebhookNotificationWithStreamConditions_1.default); }); }; /** * @summary Add Encoding Changed Webhook Notification (Specific Encoding) * @param {string} encodingId Id of the encoding resource * @param {WebhookNotificationWithStreamConditionsRequest} webhookNotificationWithStreamConditionsRequest The webhook notifications object. For conditions, following attributes are possible: 'type': 'Input file download', 'Input file analysis', 'Per-Title analysis', 'Encoding', 'Progressive Muxing' 'progress': number in range of 0-100 'status': 'RUNNING', 'FINISHED', 'ERROR' Examples: To only get notified about the encoding process, create a Condition object and set attribute='type', value='Encoding', operator=EQUAL To only get notified if a workflow step is finished, create a Condition object and set attribute='status', value='FINISHED', operator=EQUAL To only get notified if a workflow step is over 50%, create a Condition object and set attribute='progress', value='50', operator=GREATER_THAN * @throws {BitmovinError} * @memberof EncodingStatusChangedApi */ EncodingStatusChangedApi.prototype.createByEncodingId = function (encodingId, webhookNotificationWithStreamConditionsRequest) { var pathParamMap = { encoding_id: encodingId }; return this.restClient.post('/notifications/webhooks/encoding/encodings/{encoding_id}/encoding-status-changed', pathParamMap, webhookNotificationWithStreamConditionsRequest).then(function (response) { return (0, Mapper_1.map)(response, WebhookNotificationWithStreamConditions_1.default); }); }; /** * @summary Delete Encoding Status Changed Webhook * @param {string} notificationId Id of the webhook * @throws {BitmovinError} * @memberof EncodingStatusChangedApi */ EncodingStatusChangedApi.prototype.deleteByWebhookId = function (notificationId) { var pathParamMap = { notification_id: notificationId }; return this.restClient.delete('/notifications/webhooks/encoding/encodings/encoding-status-changed/{notification_id}', pathParamMap).then(function (response) { return (0, Mapper_1.map)(response, BitmovinResponse_1.default); }); }; /** * @summary Replace Encoding Status Changed Webhook Notification * @param {string} notificationId Id of the webhook notification * @param {WebhookNotificationWithStreamConditionsRequest} webhookNotificationWithStreamConditionsRequest The webhook notification with the updated values * @throws {BitmovinError} * @memberof EncodingStatusChangedApi */ EncodingStatusChangedApi.prototype.update = function (notificationId, webhookNotificationWithStreamConditionsRequest) { var pathParamMap = { notification_id: notificationId }; return this.restClient.put('/notifications/webhooks/encoding/encodings/encoding-status-changed/{notification_id}', pathParamMap, webhookNotificationWithStreamConditionsRequest).then(function (response) { return (0, Mapper_1.map)(response, WebhookNotificationWithStreamConditions_1.default); }); }; return EncodingStatusChangedApi; }(BaseAPI_1.BaseAPI)); exports.default = EncodingStatusChangedApi;