@bitmovin/api-sdk 1.162.0 → 1.164.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.162.0
+npm install @bitmovin/api-sdk@1.164.0
 ```
 
 ## Initialization

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

@@ -5821,7 +5821,7 @@ function queryParams(params) {
     var addSeperator = false;
     for (var _i = 0, _a = Object.keys(params); _i < _a.length; _i++) {
         var key = _a[_i];
-        if (params[key] && typeof params[key] !== 'function') {
+        if (params[key] != null && typeof params[key] !== 'function') {
             queryParameterString += (addSeperator ? '&' : '') + encodeURIComponent(key) + '=' + encodeURIComponent(prepareUrlParameterValue(params[key]));
             addSeperator = true;
         }
@@ -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.162.0',
+            'X-Api-Client-Version': '1.164.0',
             'Content-Type': 'application/json'
         };
         if (tenantOrgId) {
@@ -34446,6 +34446,14 @@ var EncodingListQueryParamsBuilder = /** @class */ (function () {
         this.internalParams.limit = limit;
         return this;
     };
+    /**
+     *
+     * @param includeTotalCount A boolean indicating whether the total count should be returned as well. Default is false
+     */
+    EncodingListQueryParamsBuilder.prototype.includeTotalCount = function (includeTotalCount) {
+        this.internalParams.includeTotalCount = includeTotalCount;
+        return this;
+    };
     /**
      *
      * @param sort Order list result according an encoding resource attribute.  The fields that can be used for sorting are: + `id` + `startedAt` + `createdAt` + `modifiedAt` + `finishedAt` + `type` + `name` + `status` + `cloudRegion` + `encoderVersion`
@@ -40203,6 +40211,7 @@ var CustomdataApi_1 = __webpack_require__(/*! ./customdata/CustomdataApi */ "./e
 var PeriodsApi_1 = __webpack_require__(/*! ./periods/PeriodsApi */ "./encoding/manifests/dash/periods/PeriodsApi.ts");
 var BitmovinResponse_1 = __webpack_require__(/*! ../../../models/BitmovinResponse */ "./models/BitmovinResponse.ts");
 var DashManifest_1 = __webpack_require__(/*! ../../../models/DashManifest */ "./models/DashManifest.ts");
+var StartManifestRequest_1 = __webpack_require__(/*! ../../../models/StartManifestRequest */ "./models/StartManifestRequest.ts");
 var Task_1 = __webpack_require__(/*! ../../../models/Task */ "./models/Task.ts");
 var PaginationResponse_1 = __webpack_require__(/*! ../../../models/PaginationResponse */ "./models/PaginationResponse.ts");
 var DashManifestListQueryParams_1 = __webpack_require__(/*! ./DashManifestListQueryParams */ "./encoding/manifests/dash/DashManifestListQueryParams.ts");
@@ -40222,8 +40231,8 @@ var DashApi = /** @class */ (function (_super) {
         return _this;
     }
     /**
-     * @summary Create DASH Manifest
-     * @param {DashManifest} dashManifest The DASH manifest to be created
+     * @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
      * @throws {BitmovinError}
      * @memberof DashApi
      */
@@ -40234,7 +40243,7 @@ var DashApi = /** @class */ (function (_super) {
     };
     /**
      * @summary Delete DASH Manifest
-     * @param {string} manifestId UUID of the DASH manifest to be deleted
+     * @param {string} manifestId UUID of the DASH Manifest to be deleted
      * @throws {BitmovinError}
      * @memberof DashApi
      */
@@ -40248,7 +40257,7 @@ var DashApi = /** @class */ (function (_super) {
     };
     /**
      * @summary DASH Manifest Details
-     * @param {string} manifestId UUID of the dash manifest
+     * @param {string} manifestId UUID of the DASH Manifest
      * @throws {BitmovinError}
      * @memberof DashApi
      */
@@ -40260,6 +40269,20 @@ var DashApi = /** @class */ (function (_super) {
             return (0, Mapper_1.map)(response, DashManifest_1.default);
         });
     };
+    /**
+     * @summary Manifest Start Details
+     * @param {string} manifestId Id of the manifest
+     * @throws {BitmovinError}
+     * @memberof DashApi
+     */
+    DashApi.prototype.getStartRequest = function (manifestId) {
+        var pathParamMap = {
+            manifest_id: manifestId
+        };
+        return this.restClient.get('/encoding/manifests/dash/{manifest_id}/start', pathParamMap).then(function (response) {
+            return (0, Mapper_1.map)(response, StartManifestRequest_1.default);
+        });
+    };
     /**
      * @summary List DASH Manifests
      * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
@@ -40280,7 +40303,7 @@ var DashApi = /** @class */ (function (_super) {
     };
     /**
      * @summary Start DASH Manifest Creation
-     * @param {string} manifestId Id of the DASH manifest.
+     * @param {string} manifestId Id of the DASH Manifest.
      * @param {StartManifestRequest} [startManifestRequest] Manifest Startup Options
      * @throws {BitmovinError}
      * @memberof DashApi
@@ -40295,7 +40318,7 @@ var DashApi = /** @class */ (function (_super) {
     };
     /**
      * @summary DASH Manifest Creation Status
-     * @param {string} manifestId Id of the DASH manifest.
+     * @param {string} manifestId Id of the DASH Manifest.
      * @throws {BitmovinError}
      * @memberof DashApi
      */
@@ -40309,7 +40332,7 @@ var DashApi = /** @class */ (function (_super) {
     };
     /**
      * @summary Stop DASH Manifest Creation
-     * @param {string} manifestId Id of the DASH manifest.
+     * @param {string} manifestId Id of the DASH Manifest.
      * @throws {BitmovinError}
      * @memberof DashApi
      */
@@ -40474,8 +40497,8 @@ var DefaultApi = /** @class */ (function (_super) {
         return _super.call(this, configuration) || this;
     }
     /**
-     * @summary Create DASH Manifest Default
-     * @param {DashManifestDefault} dashManifestDefault The DASH Manifest Default to be created
+     * @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
      * @throws {BitmovinError}
      * @memberof DefaultApi
      */
@@ -44762,6 +44785,7 @@ var StreamsApi_1 = __webpack_require__(/*! ./streams/StreamsApi */ "./encoding/m
 var MediaApi_1 = __webpack_require__(/*! ./media/MediaApi */ "./encoding/manifests/hls/media/MediaApi.ts");
 var BitmovinResponse_1 = __webpack_require__(/*! ../../../models/BitmovinResponse */ "./models/BitmovinResponse.ts");
 var HlsManifest_1 = __webpack_require__(/*! ../../../models/HlsManifest */ "./models/HlsManifest.ts");
+var StartManifestRequest_1 = __webpack_require__(/*! ../../../models/StartManifestRequest */ "./models/StartManifestRequest.ts");
 var Task_1 = __webpack_require__(/*! ../../../models/Task */ "./models/Task.ts");
 var PaginationResponse_1 = __webpack_require__(/*! ../../../models/PaginationResponse */ "./models/PaginationResponse.ts");
 var HlsManifestListQueryParams_1 = __webpack_require__(/*! ./HlsManifestListQueryParams */ "./encoding/manifests/hls/HlsManifestListQueryParams.ts");
@@ -44782,8 +44806,8 @@ var HlsApi = /** @class */ (function (_super) {
         return _this;
     }
     /**
-     * @summary Create HLS Manifest
-     * @param {HlsManifest} hlsManifest The HLS Manifest to be created
+     * @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
      * @throws {BitmovinError}
      * @memberof HlsApi
      */
@@ -44794,7 +44818,7 @@ var HlsApi = /** @class */ (function (_super) {
     };
     /**
      * @summary Delete HLS Manifest
-     * @param {string} manifestId Id of the hls manifest.
+     * @param {string} manifestId Id of the HLS Manifest.
      * @throws {BitmovinError}
      * @memberof HlsApi
      */
@@ -44808,7 +44832,7 @@ var HlsApi = /** @class */ (function (_super) {
     };
     /**
      * @summary HLS Manifest Details
-     * @param {string} manifestId Id of the hls manifest.
+     * @param {string} manifestId Id of the HLS Manifest.
      * @throws {BitmovinError}
      * @memberof HlsApi
      */
@@ -44820,6 +44844,20 @@ var HlsApi = /** @class */ (function (_super) {
             return (0, Mapper_1.map)(response, HlsManifest_1.default);
         });
     };
+    /**
+     * @summary Manifest Start Details
+     * @param {string} manifestId ID of the manifest
+     * @throws {BitmovinError}
+     * @memberof HlsApi
+     */
+    HlsApi.prototype.getStartRequest = function (manifestId) {
+        var pathParamMap = {
+            manifest_id: manifestId
+        };
+        return this.restClient.get('/encoding/manifests/hls/{manifest_id}/start', pathParamMap).then(function (response) {
+            return (0, Mapper_1.map)(response, StartManifestRequest_1.default);
+        });
+    };
     /**
      * @summary List HLS Manifests
      * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
@@ -44840,7 +44878,7 @@ var HlsApi = /** @class */ (function (_super) {
     };
     /**
      * @summary Start HLS Manifest Creation
-     * @param {string} manifestId Id of the HLS manifest.
+     * @param {string} manifestId Id of the HLS Manifest.
      * @param {StartManifestRequest} [startManifestRequest] Manifest Startup Options
      * @throws {BitmovinError}
      * @memberof HlsApi
@@ -44855,7 +44893,7 @@ var HlsApi = /** @class */ (function (_super) {
     };
     /**
      * @summary HLS Manifest Creation Status
-     * @param {string} manifestId Id of the HLS manifest.
+     * @param {string} manifestId Id of the HLS Manifest.
      * @throws {BitmovinError}
      * @memberof HlsApi
      */
@@ -44869,7 +44907,7 @@ var HlsApi = /** @class */ (function (_super) {
     };
     /**
      * @summary Stop HLS Manifest Creation
-     * @param {string} manifestId Id of the HLS manifest.
+     * @param {string} manifestId Id of the HLS Manifest.
      * @throws {BitmovinError}
      * @memberof HlsApi
      */
@@ -45034,8 +45072,8 @@ var DefaultApi = /** @class */ (function (_super) {
         return _super.call(this, configuration) || this;
     }
     /**
-     * @summary Create HLS Manifest Default
-     * @param {HlsManifestDefault} hlsManifestDefault The HLS Manifest to be created
+     * @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
      * @throws {BitmovinError}
      * @memberof DefaultApi
      */
@@ -46644,6 +46682,7 @@ var RepresentationsApi_1 = __webpack_require__(/*! ./representations/Representat
 var ContentprotectionApi_1 = __webpack_require__(/*! ./contentprotection/ContentprotectionApi */ "./encoding/manifests/smooth/contentprotection/ContentprotectionApi.ts");
 var BitmovinResponse_1 = __webpack_require__(/*! ../../../models/BitmovinResponse */ "./models/BitmovinResponse.ts");
 var SmoothStreamingManifest_1 = __webpack_require__(/*! ../../../models/SmoothStreamingManifest */ "./models/SmoothStreamingManifest.ts");
+var StartManifestRequest_1 = __webpack_require__(/*! ../../../models/StartManifestRequest */ "./models/StartManifestRequest.ts");
 var Task_1 = __webpack_require__(/*! ../../../models/Task */ "./models/Task.ts");
 var PaginationResponse_1 = __webpack_require__(/*! ../../../models/PaginationResponse */ "./models/PaginationResponse.ts");
 var SmoothStreamingManifestListQueryParams_1 = __webpack_require__(/*! ./SmoothStreamingManifestListQueryParams */ "./encoding/manifests/smooth/SmoothStreamingManifestListQueryParams.ts");
@@ -46665,7 +46704,7 @@ var SmoothApi = /** @class */ (function (_super) {
     }
     /**
      * @summary Create Smooth Streaming Manifest
-     * @param {SmoothStreamingManifest} smoothStreamingManifest The Smooth Streaming Manifest to be created
+     * @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
      * @throws {BitmovinError}
      * @memberof SmoothApi
      */
@@ -46676,7 +46715,7 @@ var SmoothApi = /** @class */ (function (_super) {
     };
     /**
      * @summary Delete Smooth Streaming Manifest
-     * @param {string} manifestId Id of the Smooth Streaming manifest.
+     * @param {string} manifestId Id of the Smooth Streaming Manifest.
      * @throws {BitmovinError}
      * @memberof SmoothApi
      */
@@ -46690,7 +46729,7 @@ var SmoothApi = /** @class */ (function (_super) {
     };
     /**
      * @summary Smooth Streaming Manifest Details
-     * @param {string} manifestId Id of the Smooth Streaming manifest.
+     * @param {string} manifestId Id of the Smooth Streaming Manifest.
      * @throws {BitmovinError}
      * @memberof SmoothApi
      */
@@ -46702,6 +46741,20 @@ var SmoothApi = /** @class */ (function (_super) {
             return (0, Mapper_1.map)(response, SmoothStreamingManifest_1.default);
         });
     };
+    /**
+     * @summary Manifest Start Details
+     * @param {string} manifestId Id of the manifest
+     * @throws {BitmovinError}
+     * @memberof SmoothApi
+     */
+    SmoothApi.prototype.getStartRequest = function (manifestId) {
+        var pathParamMap = {
+            manifest_id: manifestId
+        };
+        return this.restClient.get('/encoding/manifests/smooth/{manifest_id}/start', pathParamMap).then(function (response) {
+            return (0, Mapper_1.map)(response, StartManifestRequest_1.default);
+        });
+    };
     /**
      * @summary List Smooth Streaming Manifests
      * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
@@ -46722,7 +46775,7 @@ var SmoothApi = /** @class */ (function (_super) {
     };
     /**
      * @summary Start Smooth Streaming Manifest Creation
-     * @param {string} manifestId Id of the Smooth Streaming manifest.
+     * @param {string} manifestId Id of the Smooth Streaming Manifest.
      * @param {StartManifestRequest} [startManifestRequest] Manifest Startup Options
      * @throws {BitmovinError}
      * @memberof SmoothApi
@@ -46737,7 +46790,7 @@ var SmoothApi = /** @class */ (function (_super) {
     };
     /**
      * @summary Smooth Streaming Manifest Creation Status
-     * @param {string} manifestId Id of the Smooth Streaming manifest.
+     * @param {string} manifestId Id of the Smooth Streaming Manifest.
      * @throws {BitmovinError}
      * @memberof SmoothApi
      */
@@ -46751,7 +46804,7 @@ var SmoothApi = /** @class */ (function (_super) {
     };
     /**
      * @summary Stop Smooth Streaming Manifest Creation
-     * @param {string} manifestId Id of the Smooth Streaming manifest.
+     * @param {string} manifestId Id of the Smooth Streaming Manifest.
      * @throws {BitmovinError}
      * @memberof SmoothApi
      */
@@ -47073,8 +47126,8 @@ var DefaultApi = /** @class */ (function (_super) {
         return _super.call(this, configuration) || this;
     }
     /**
-     * @summary Create Smooth Streaming Manifest Default
-     * @param {SmoothManifestDefault} smoothManifestDefault The Smooth Streaming Default Manifest to be created
+     * @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
      * @throws {BitmovinError}
      * @memberof DefaultApi
      */
@@ -63471,7 +63524,6 @@ var Mapper_1 = __webpack_require__(/*! ../common/Mapper */ "./common/Mapper.ts")
 var DashManifest_1 = __webpack_require__(/*! ./DashManifest */ "./models/DashManifest.ts");
 var DefaultDashManifestPeriod_1 = __webpack_require__(/*! ./DefaultDashManifestPeriod */ "./models/DefaultDashManifestPeriod.ts");
 /**
- * V2 of the default dash manifest is an experimental feature and might be subject to change in the future.
  * @export
  * @class DashManifestDefault
  */
@@ -79419,6 +79471,36 @@ var SimpleEncodingVodJobInputType;
 exports["default"] = SimpleEncodingVodJobInputType;
 
 
+/***/ }),
+
+/***/ "./models/SimpleEncodingVodJobOptions.ts":
+/*!***********************************************!*\
+  !*** ./models/SimpleEncodingVodJobOptions.ts ***!
+  \***********************************************/
+/***/ ((__unused_webpack_module, exports, __webpack_require__) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.SimpleEncodingVodJobOptions = void 0;
+var Mapper_1 = __webpack_require__(/*! ../common/Mapper */ "./common/Mapper.ts");
+/**
+ * @export
+ * @class SimpleEncodingVodJobOptions
+ */
+var SimpleEncodingVodJobOptions = /** @class */ (function () {
+    function SimpleEncodingVodJobOptions(obj) {
+        if (!obj) {
+            return;
+        }
+        this.singleFileOutput = (0, Mapper_1.map)(obj.singleFileOutput);
+    }
+    return SimpleEncodingVodJobOptions;
+}());
+exports.SimpleEncodingVodJobOptions = SimpleEncodingVodJobOptions;
+exports["default"] = SimpleEncodingVodJobOptions;
+
+
 /***/ }),
 
 /***/ "./models/SimpleEncodingVodJobOutput.ts":
@@ -79525,6 +79607,7 @@ Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.SimpleEncodingVodJobRequest = void 0;
 var Mapper_1 = __webpack_require__(/*! ../common/Mapper */ "./common/Mapper.ts");
 var SimpleEncodingVodJobInput_1 = __webpack_require__(/*! ./SimpleEncodingVodJobInput */ "./models/SimpleEncodingVodJobInput.ts");
+var SimpleEncodingVodJobOptions_1 = __webpack_require__(/*! ./SimpleEncodingVodJobOptions */ "./models/SimpleEncodingVodJobOptions.ts");
 var SimpleEncodingVodJobOutput_1 = __webpack_require__(/*! ./SimpleEncodingVodJobOutput */ "./models/SimpleEncodingVodJobOutput.ts");
 /**
  * @export
@@ -79538,6 +79621,7 @@ var SimpleEncodingVodJobRequest = /** @class */ (function () {
         this.encodingTemplate = (0, Mapper_1.map)(obj.encodingTemplate);
         this.inputs = (0, Mapper_1.mapArray)(obj.inputs, SimpleEncodingVodJobInput_1.default);
         this.outputs = (0, Mapper_1.mapArray)(obj.outputs, SimpleEncodingVodJobOutput_1.default);
+        this.options = (0, Mapper_1.map)(obj.options, SimpleEncodingVodJobOptions_1.default);
         this.name = (0, Mapper_1.map)(obj.name);
     }
     return SimpleEncodingVodJobRequest;
@@ -79561,6 +79645,7 @@ exports.SimpleEncodingVodJobResponse = void 0;
 var Mapper_1 = __webpack_require__(/*! ../common/Mapper */ "./common/Mapper.ts");
 var SimpleEncodingVodJobErrors_1 = __webpack_require__(/*! ./SimpleEncodingVodJobErrors */ "./models/SimpleEncodingVodJobErrors.ts");
 var SimpleEncodingVodJobInput_1 = __webpack_require__(/*! ./SimpleEncodingVodJobInput */ "./models/SimpleEncodingVodJobInput.ts");
+var SimpleEncodingVodJobOptions_1 = __webpack_require__(/*! ./SimpleEncodingVodJobOptions */ "./models/SimpleEncodingVodJobOptions.ts");
 var SimpleEncodingVodJobOutput_1 = __webpack_require__(/*! ./SimpleEncodingVodJobOutput */ "./models/SimpleEncodingVodJobOutput.ts");
 /**
  * @export
@@ -79577,6 +79662,7 @@ var SimpleEncodingVodJobResponse = /** @class */ (function () {
         this.encodingId = (0, Mapper_1.map)(obj.encodingId);
         this.inputs = (0, Mapper_1.mapArray)(obj.inputs, SimpleEncodingVodJobInput_1.default);
         this.outputs = (0, Mapper_1.mapArray)(obj.outputs, SimpleEncodingVodJobOutput_1.default);
+        this.options = (0, Mapper_1.map)(obj.options, SimpleEncodingVodJobOptions_1.default);
         this.errors = (0, Mapper_1.mapArray)(obj.errors, SimpleEncodingVodJobErrors_1.default);
         this.createdAt = (0, Mapper_1.map)(obj.createdAt, Date);
         this.modifiedAt = (0, Mapper_1.map)(obj.modifiedAt, Date);
@@ -86057,6 +86143,7 @@ __exportStar(__webpack_require__(/*! ./SimpleEncodingVodJobGcsServiceAccountCred
 __exportStar(__webpack_require__(/*! ./SimpleEncodingVodJobInput */ "./models/SimpleEncodingVodJobInput.ts"), exports);
 __exportStar(__webpack_require__(/*! ./SimpleEncodingVodJobInputSourceType */ "./models/SimpleEncodingVodJobInputSourceType.ts"), exports);
 __exportStar(__webpack_require__(/*! ./SimpleEncodingVodJobInputType */ "./models/SimpleEncodingVodJobInputType.ts"), exports);
+__exportStar(__webpack_require__(/*! ./SimpleEncodingVodJobOptions */ "./models/SimpleEncodingVodJobOptions.ts"), exports);
 __exportStar(__webpack_require__(/*! ./SimpleEncodingVodJobOutput */ "./models/SimpleEncodingVodJobOutput.ts"), exports);
 __exportStar(__webpack_require__(/*! ./SimpleEncodingVodJobOutputArtifact */ "./models/SimpleEncodingVodJobOutputArtifact.ts"), exports);
 __exportStar(__webpack_require__(/*! ./SimpleEncodingVodJobOutputType */ "./models/SimpleEncodingVodJobOutputType.ts"), exports);