@bitmovin/api-sdk 1.165.0 → 1.166.0

package/README.md

@@ -31,7 +31,7 @@ If you have any questions regarding the SDK, provided examples or our services,
 ## Installation
 
 ``` bash
-npm install @bitmovin/api-sdk@1.165.0
+npm install @bitmovin/api-sdk@1.166.0
 ```
 
 ## Initialization

package/dist/bitmovin-api-sdk.browser.js

@@ -5987,7 +5987,7 @@ var HeaderHandler = /** @class */ (function (_super) {
         var headers = {
             'X-Api-Key': apiKey,
             'X-Api-Client': 'bitmovin-api-sdk-javascript',
-            'X-Api-Client-Version': '1.165.0',
+            'X-Api-Client-Version': '1.166.0',
             'Content-Type': 'application/json'
         };
         if (tenantOrgId) {
@@ -6680,7 +6680,7 @@ var Ac3Api = /** @class */ (function (_super) {
         return _this;
     }
     /**
-     * @summary Create AC3 Codec Configuration.  Deprecation notice: use Dolby Digital instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
+     * @summary Create AC3 Codec Configuration
      * @param {Ac3AudioConfiguration} ac3AudioConfiguration The AC3 Codec Configuration to be created
      * @throws {BitmovinError}
      * @memberof Ac3Api
@@ -6691,7 +6691,7 @@ var Ac3Api = /** @class */ (function (_super) {
         });
     };
     /**
-     * @summary Delete AC3 Codec Configuration.  Deprecation notice: use Dolby Digital instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
+     * @summary Delete AC3 Codec Configuration
      * @param {string} configurationId Id of the codec configuration
      * @throws {BitmovinError}
      * @memberof Ac3Api
@@ -6705,7 +6705,7 @@ var Ac3Api = /** @class */ (function (_super) {
         });
     };
     /**
-     * @summary AC3 Codec Configuration Details  Deprecation notice: use Dolby Digital instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
+     * @summary AC3 Codec Configuration Details
      * @param {string} configurationId Id of the codec configuration
      * @throws {BitmovinError}
      * @memberof Ac3Api
@@ -6719,7 +6719,7 @@ var Ac3Api = /** @class */ (function (_super) {
         });
     };
     /**
-     * @summary List AC3 Configurations.  Deprecation notice: use Dolby Digital instead. For more information check out our tutorial here:  https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
+     * @summary List AC3 Configurations
      * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
      * @throws {BitmovinError}
      * @memberof Ac3Api
@@ -8185,7 +8185,7 @@ var Eac3Api = /** @class */ (function (_super) {
         return _this;
     }
     /**
-     * @summary Create E-AC3 Codec Configuration.  Deprecation notice: use Dolby Digital Plus instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
+     * @summary Create E-AC3 Codec Configuration
      * @param {Eac3AudioConfiguration} eac3AudioConfiguration The E-AC3 Codec Configuration to be created
      * @throws {BitmovinError}
      * @memberof Eac3Api
@@ -8196,7 +8196,7 @@ var Eac3Api = /** @class */ (function (_super) {
         });
     };
     /**
-     * @summary Delete E-AC3 Codec Configuration.  Deprecation notice: use Dolby Digital Plus instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
+     * @summary Delete E-AC3 Codec Configuration
      * @param {string} configurationId Id of the codec configuration
      * @throws {BitmovinError}
      * @memberof Eac3Api
@@ -8210,7 +8210,7 @@ var Eac3Api = /** @class */ (function (_super) {
         });
     };
     /**
-     * @summary E-AC3 Codec Configuration Details.  Deprecation notice: use Dolby Digital Plus instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
+     * @summary E-AC3 Codec Configuration Details
      * @param {string} configurationId Id of the codec configuration
      * @throws {BitmovinError}
      * @memberof Eac3Api
@@ -8224,7 +8224,7 @@ var Eac3Api = /** @class */ (function (_super) {
         });
     };
     /**
-     * @summary List E-AC3 Configurations.  Deprecation notice: use Dolby Digital Plus instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
+     * @summary List E-AC3 Configurations
      * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
      * @throws {BitmovinError}
      * @memberof Eac3Api
@@ -15812,7 +15812,7 @@ var InsertableContentApi = /** @class */ (function (_super) {
         return _this;
     }
     /**
-     * @summary Make Insertable Content Available For A Live Encoding
+     * @summary Create Insertable Content
      * @param {string} encodingId Id of the encoding.
      * @param {InsertableContent} insertableContent The insertable content to be created
      * @throws {BitmovinError}
@@ -15827,7 +15827,7 @@ var InsertableContentApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * @summary List All Insertable Content Available For A Live Encoding
+     * @summary List Insertable Content
      * @param {string} encodingId Id of the encoding.
      * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
      * @throws {BitmovinError}
@@ -15935,7 +15935,7 @@ var ScheduleApi = /** @class */ (function (_super) {
         return _super.call(this, configuration) || this;
     }
     /**
-     * @summary Schedule Insertable Content For a Live Encoding
+     * @summary Schedule Insertable Content
      * @param {string} encodingId Id of the encoding.
      * @param {string} contentId Id of the insertable content.
      * @param {ScheduledInsertableContent} scheduledInsertableContent The scheduled insertable content to be created
@@ -16016,7 +16016,7 @@ var ScheduledApi = /** @class */ (function (_super) {
         return _super.call(this, configuration) || this;
     }
     /**
-     * @summary List All Scheduled Insertable Content For A Live Encoding
+     * @summary List Scheduled Insertable Content
      * @param {string} encodingId Id of the encoding.
      * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
      * @throws {BitmovinError}
@@ -29859,7 +29859,7 @@ var PsnrApi = /** @class */ (function (_super) {
         return _super.call(this, configuration) || this;
     }
     /**
-     * @summary Activate PSNR quality metrics for the selected stream
+     * @summary PSNR quality metrics
      * @param {string} encodingId Id of the encoding.
      * @param {string} streamId Id of the stream.
      * @throws {BitmovinError}
@@ -30725,7 +30725,7 @@ var TransferRetriesApi = /** @class */ (function (_super) {
         return _super.call(this, configuration) || this;
     }
     /**
-     * @summary Starts transfer retry. A transfer retry is only possible within 72 hours.
+     * @summary Transfer retry
      * @param {string} encodingId Id of the encoding.
      * @throws {BitmovinError}
      * @memberof TransferRetriesApi
@@ -31562,7 +31562,7 @@ var ConformApi = /** @class */ (function (_super) {
         return _this;
     }
     /**
-     * @summary Create Conform Filter. Keeps all the frames of the input. The playback time of the output will be slower or faster.
+     * @summary Create Conform Filter
      * @param {ConformFilter} conformFilter The Conform Filter to be created
      * @throws {BitmovinError}
      * @memberof ConformApi
@@ -40232,7 +40232,7 @@ var DashApi = /** @class */ (function (_super) {
     }
     /**
      * @summary Create Custom DASH Manifest
-     * @param {DashManifest} dashManifest A Custom DASH Manifest gives you full control over its contents. Add Periods, Adaptation Sets, Representations, Content Protections or Custom XML Elements via the respective endpoints. If you need a simpler solution, create a Default Manifest resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison
+     * @param {DashManifest} dashManifest The Custom DASH Manifest to be created.
      * @throws {BitmovinError}
      * @memberof DashApi
      */
@@ -40498,7 +40498,7 @@ var DefaultApi = /** @class */ (function (_super) {
     }
     /**
      * @summary Create Default DASH Manifest
-     * @param {DashManifestDefault} dashManifestDefault A Default Manifest is the easiest way to create a manifest file. Its contents will be configured automatically, depending on what output your encoding creates (muxings, thumbnails, sprites, subtitles, DRM information). If you need more control, create a Custom Manifest resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison
+     * @param {DashManifestDefault} dashManifestDefault The Default DASH Manifest to be created.
      * @throws {BitmovinError}
      * @memberof DefaultApi
      */
@@ -44807,7 +44807,7 @@ var HlsApi = /** @class */ (function (_super) {
     }
     /**
      * @summary Create Custom HLS Manifest
-     * @param {HlsManifest} hlsManifest A Custom HLS Manifest gives you full control over its contents. Add Variant Streams and Media elements via the respective endpoints. If you need a simpler solution, create a Default Manifest resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison
+     * @param {HlsManifest} hlsManifest The Custom HLS Manifest to be created.
      * @throws {BitmovinError}
      * @memberof HlsApi
      */
@@ -45073,7 +45073,7 @@ var DefaultApi = /** @class */ (function (_super) {
     }
     /**
      * @summary Create Default HLS Manifest
-     * @param {HlsManifestDefault} hlsManifestDefault A Default Manifest is the easiest way to create a manifest file. Its contents will be configured automatically, depending on what output your encoding creates (muxings, thumbnails, sprites, subtitles, DRM information). If you need more control, create a Custom Manifest resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison
+     * @param {HlsManifestDefault} hlsManifestDefault The Default HLS Manifest to be created.
      * @throws {BitmovinError}
      * @memberof DefaultApi
      */
@@ -46704,7 +46704,7 @@ var SmoothApi = /** @class */ (function (_super) {
     }
     /**
      * @summary Create Smooth Streaming Manifest
-     * @param {SmoothStreamingManifest} smoothStreamingManifest A Custom Smooth Streaming Manifest gives you full control over its contents. Add Representations and Content Protections via the respective endpoints. If you need a simpler solution, create a Default Manifest resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison
+     * @param {SmoothStreamingManifest} smoothStreamingManifest The Custom Smooth Streaming Manifest to be created.
      * @throws {BitmovinError}
      * @memberof SmoothApi
      */
@@ -47127,7 +47127,7 @@ var DefaultApi = /** @class */ (function (_super) {
     }
     /**
      * @summary Create Default Smooth Streaming Manifest
-     * @param {SmoothManifestDefault} smoothManifestDefault A Default Manifest is the easiest way to create a manifest file. Its contents will be configured automatically, depending on what output your encoding creates (muxings, thumbnails, sprites, subtitles, DRM information). If you need more control, create a Custom Manifest resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison
+     * @param {SmoothManifestDefault} smoothManifestDefault The Default Smooth Streaming Manifest to be created.
      * @throws {BitmovinError}
      * @memberof DefaultApi
      */
@@ -50475,7 +50475,7 @@ var LiveApi = /** @class */ (function (_super) {
     }
     /**
      * @summary Create a Simple Encoding Live Job
-     * @param {SimpleEncodingLiveJobRequest} simpleEncodingLiveJobRequest The Simple Encoding Live Job to be created.  Check out our [Simple Encoding API Live Documentation](https://bitmovin.com/docs/encoding/articles/simple-encoding-api-live) for additional information about the Simple Encoding API Live.
+     * @param {SimpleEncodingLiveJobRequest} simpleEncodingLiveJobRequest The Simple Encoding Live Job to be created.
      * @throws {BitmovinError}
      * @memberof LiveApi
      */
@@ -50603,7 +50603,7 @@ var VodApi = /** @class */ (function (_super) {
     }
     /**
      * @summary Create a Simple Encoding VOD Job
-     * @param {SimpleEncodingVodJobRequest} simpleEncodingVodJobRequest The Simple Encoding VOD Job to be created.  Check out our [Simple Encoding API Documentation](https://bitmovin.com/docs/encoding/articles/simple-encoding-api) for additional information about the Simple Encoding API.
+     * @param {SimpleEncodingVodJobRequest} simpleEncodingVodJobRequest The Simple Encoding VOD Job to be created.
      * @throws {BitmovinError}
      * @memberof VodApi
      */
@@ -67323,6 +67323,7 @@ var Encoding = /** @class */ (function (_super) {
         _this.selectedCloudRegion = (0, Mapper_1.map)(obj.selectedCloudRegion);
         _this.status = (0, Mapper_1.map)(obj.status);
         _this.labels = (0, Mapper_1.mapArray)(obj.labels);
+        _this.liveOptionsType = (0, Mapper_1.map)(obj.liveOptionsType);
         return _this;
     }
     return Encoding;
@@ -72726,6 +72727,29 @@ exports.LiveMediaIngestOutput = LiveMediaIngestOutput;
 exports["default"] = LiveMediaIngestOutput;
 
 
+/***/ }),
+
+/***/ "./models/LiveOptionsType.ts":
+/*!***********************************!*\
+  !*** ./models/LiveOptionsType.ts ***!
+  \***********************************/
+/***/ ((__unused_webpack_module, exports) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.LiveOptionsType = void 0;
+/**
+ * @export
+ * @enum {string}
+ */
+var LiveOptionsType;
+(function (LiveOptionsType) {
+    LiveOptionsType["HD"] = "HD";
+})(LiveOptionsType = exports.LiveOptionsType || (exports.LiveOptionsType = {}));
+exports["default"] = LiveOptionsType;
+
+
 /***/ }),
 
 /***/ "./models/LocalInput.ts":
@@ -75978,6 +76002,7 @@ var PresetConfiguration;
     PresetConfiguration["VOD_EXTRAHIGH_SPEED"] = "VOD_EXTRAHIGH_SPEED";
     PresetConfiguration["VOD_SUPERHIGH_SPEED"] = "VOD_SUPERHIGH_SPEED";
     PresetConfiguration["VOD_ULTRAHIGH_SPEED"] = "VOD_ULTRAHIGH_SPEED";
+    PresetConfiguration["VOD_HARDWARE_SHORTFORM"] = "VOD_HARDWARE_SHORTFORM";
 })(PresetConfiguration = exports.PresetConfiguration || (exports.PresetConfiguration = {}));
 exports["default"] = PresetConfiguration;
 
@@ -80325,6 +80350,7 @@ var SpekeDrmProvider = /** @class */ (function () {
         this.url = (0, Mapper_1.map)(obj.url);
         this.username = (0, Mapper_1.map)(obj.username);
         this.password = (0, Mapper_1.map)(obj.password);
+        this.apiKey = (0, Mapper_1.map)(obj.apiKey);
         this.roleArn = (0, Mapper_1.map)(obj.roleArn);
         this.externalId = (0, Mapper_1.map)(obj.externalId);
         this.externalIdMode = (0, Mapper_1.map)(obj.externalIdMode);
@@ -81988,6 +82014,7 @@ var StreamsContentProtectionResponse = /** @class */ (function () {
         this.id = (0, Mapper_1.map)(obj.id);
         this.allowedDomains = (0, Mapper_1.mapArray)(obj.allowedDomains);
         this.allowNoReferer = (0, Mapper_1.map)(obj.allowNoReferer);
+        this.allowShare = (0, Mapper_1.map)(obj.allowShare);
     }
     return StreamsContentProtectionResponse;
 }());
@@ -82123,6 +82150,7 @@ var StreamsLiveUpdateRequest = /** @class */ (function () {
         this.configId = (0, Mapper_1.map)(obj.configId);
         this.posterUrl = (0, Mapper_1.map)(obj.posterUrl);
         this.adConfigId = (0, Mapper_1.map)(obj.adConfigId);
+        this.contentProtectionId = (0, Mapper_1.map)(obj.contentProtectionId);
     }
     return StreamsLiveUpdateRequest;
 }());
@@ -82341,6 +82369,7 @@ var StreamsVideoUpdateRequest = /** @class */ (function () {
         this.configId = (0, Mapper_1.map)(obj.configId);
         this.posterUrl = (0, Mapper_1.map)(obj.posterUrl);
         this.adConfigId = (0, Mapper_1.map)(obj.adConfigId);
+        this.contentProtectionId = (0, Mapper_1.map)(obj.contentProtectionId);
     }
     return StreamsVideoUpdateRequest;
 }());
@@ -86045,6 +86074,7 @@ __exportStar(__webpack_require__(/*! ./LiveEncodingStatsEventDetails */ "./model
 __exportStar(__webpack_require__(/*! ./LiveEncodingStatus */ "./models/LiveEncodingStatus.ts"), exports);
 __exportStar(__webpack_require__(/*! ./LiveHlsManifest */ "./models/LiveHlsManifest.ts"), exports);
 __exportStar(__webpack_require__(/*! ./LiveMediaIngestOutput */ "./models/LiveMediaIngestOutput.ts"), exports);
+__exportStar(__webpack_require__(/*! ./LiveOptionsType */ "./models/LiveOptionsType.ts"), exports);
 __exportStar(__webpack_require__(/*! ./LocalInput */ "./models/LocalInput.ts"), exports);
 __exportStar(__webpack_require__(/*! ./LocalOutput */ "./models/LocalOutput.ts"), exports);
 __exportStar(__webpack_require__(/*! ./Manifest */ "./models/Manifest.ts"), exports);
@@ -87619,7 +87649,7 @@ var ErrorApi = /** @class */ (function (_super) {
     }
     /**
      * @summary Add 'Encoding Error' Webhook
-     * @param {Webhook} webhook The 'Encoding Error' Webhook to be added. A maximum number of 5 webhooks is allowed
+     * @param {Webhook} webhook The 'Encoding Error' Webhook to be added.
      * @throws {BitmovinError}
      * @memberof ErrorApi
      */
@@ -87952,7 +87982,7 @@ var FinishedApi = /** @class */ (function (_super) {
     }
     /**
      * @summary Add 'Encoding Finished' Webhook
-     * @param {Webhook} webhook The 'Encoding Finished' Webhook to be added. A maximum number of 5 webhooks is allowed
+     * @param {Webhook} webhook The 'Encoding Finished' Webhook to be added.
      * @throws {BitmovinError}
      * @memberof FinishedApi
      */
@@ -88371,7 +88401,7 @@ var TransferErrorApi = /** @class */ (function (_super) {
     }
     /**
      * @summary Add 'Encoding Transfer Error' Webhook
-     * @param {Webhook} webhook The 'Encoding Transfer Error' Webhook to be added. A maximum number of 5 webhooks is allowed
+     * @param {Webhook} webhook The 'Encoding Transfer Error' Webhook to be added.
      * @throws {BitmovinError}
      * @memberof TransferErrorApi
      */
@@ -88811,7 +88841,7 @@ var ErrorApi = /** @class */ (function (_super) {
     }
     /**
      * @summary Add 'Manifest Error' Webhook (All Manifests)
-     * @param {Webhook} webhook Add a new webhook notification if a manifest generation failed with an error. A maximum number of 5 webhooks is allowed
+     * @param {Webhook} webhook The 'Manifest Error' Webhook to be added.
      * @throws {BitmovinError}
      * @memberof ErrorApi
      */
@@ -88912,7 +88942,7 @@ var FinishedApi = /** @class */ (function (_super) {
     }
     /**
      * @summary Add 'Manifest Finished Successfully' Webhook (All Manifests)
-     * @param {Webhook} webhook Add a new webhook notification if a manifest generation finished successfully. A maximum number of 5 webhooks is allowed
+     * @param {Webhook} webhook Add a new webhook notification that triggers if a manifest generation finished successfully. A maximum number of 5 webhooks is allowed
      * @throws {BitmovinError}
      * @memberof FinishedApi
      */