@bitmovin/api-sdk 1.145.0 → 1.147.0

package/dist/common/RestClient.js

@@ -240,7 +240,7 @@ var HeaderHandler = /** @class */ (function (_super) {
         var headers = {
             'X-Api-Key': apiKey,
             'X-Api-Client': 'bitmovin-api-sdk-javascript',
-            'X-Api-Client-Version': '1.145.0',
+            'X-Api-Client-Version': '1.147.0',
             'Content-Type': 'application/json'
         };
         if (tenantOrgId) {

package/dist/encoding/encodings/live/LiveApi.d.ts

@@ -31,7 +31,7 @@ export default class LiveApi extends BaseAPI {
     getStartRequest(encodingId: string): Promise<StartLiveEncodingRequest>;
     /**
      * @summary Re-Start Live Encoding
-     * @param {string} encodingId Id of the encoding
+     * @param {string} encodingId Id of the encoding.  **Important:** Only live encodings with the status &#x60;RUNNING&#x60;, &#x60;FINISHED&#x60;, &#x60;CANCELED&#x60; or &#x60;ERROR&#x60; can be restarted.
      * @throws {BitmovinError}
      * @memberof LiveApi
      */

package/dist/encoding/encodings/live/LiveApi.js

@@ -66,7 +66,7 @@ var LiveApi = /** @class */ (function (_super) {
     };
     /**
      * @summary Re-Start Live Encoding
-     * @param {string} encodingId Id of the encoding
+     * @param {string} encodingId Id of the encoding.  **Important:** Only live encodings with the status `RUNNING`, `FINISHED`, `CANCELED` or `ERROR` can be restarted.
      * @throws {BitmovinError}
      * @memberof LiveApi
      */

package/dist/encoding/outputs/OutputsApi.d.ts

@@ -14,6 +14,8 @@ import AkamaiMslApi from './akamaiMsl/AkamaiMslApi';
 import AkamaiNetstorageApi from './akamaiNetstorage/AkamaiNetstorageApi';
 import LiveMediaIngestApi from './liveMediaIngest/LiveMediaIngestApi';
 import CdnApi from './cdn/CdnApi';
+import CheckOutputPermissionsRequest from '../../models/CheckOutputPermissionsRequest';
+import CheckOutputPermissionsResponse from '../../models/CheckOutputPermissionsResponse';
 import Output from '../../models/Output';
 import PaginationResponse from '../../models/PaginationResponse';
 import { OutputListQueryParams, OutputListQueryParamsBuilder } from './OutputListQueryParams';
@@ -39,6 +41,14 @@ export default class OutputsApi extends BaseAPI {
     liveMediaIngest: LiveMediaIngestApi;
     cdn: CdnApi;
     constructor(configuration: Configuration);
+    /**
+     * @summary Check output permissions (S3 only)
+     * @param {string} outputId Id of the output to be checked. Currently limited to S3 outputs. The access credentials that have been provided for this Output still need to be valid, otherwise the request will fail. If they are not valid any more, create a new Output with new credentials (resources are immutable).
+     * @param {CheckOutputPermissionsRequest} [checkOutputPermissionsRequest] Additional parameters for the permissions check
+     * @throws {BitmovinError}
+     * @memberof OutputsApi
+     */
+    checkPermissions(outputId: string, checkOutputPermissionsRequest?: CheckOutputPermissionsRequest): Promise<CheckOutputPermissionsResponse>;
     /**
      * @summary Get Output Details
      * @param {string} outputId Id of the wanted output

package/dist/encoding/outputs/OutputsApi.js

@@ -31,6 +31,7 @@ var AkamaiMslApi_1 = require("./akamaiMsl/AkamaiMslApi");
 var AkamaiNetstorageApi_1 = require("./akamaiNetstorage/AkamaiNetstorageApi");
 var LiveMediaIngestApi_1 = require("./liveMediaIngest/LiveMediaIngestApi");
 var CdnApi_1 = require("./cdn/CdnApi");
+var CheckOutputPermissionsResponse_1 = require("../../models/CheckOutputPermissionsResponse");
 var Output_1 = require("../../models/Output");
 var PaginationResponse_1 = require("../../models/PaginationResponse");
 var OutputListQueryParams_1 = require("./OutputListQueryParams");
@@ -60,6 +61,21 @@ var OutputsApi = /** @class */ (function (_super) {
         _this.cdn = new CdnApi_1.default(configuration);
         return _this;
     }
+    /**
+     * @summary Check output permissions (S3 only)
+     * @param {string} outputId Id of the output to be checked. Currently limited to S3 outputs. The access credentials that have been provided for this Output still need to be valid, otherwise the request will fail. If they are not valid any more, create a new Output with new credentials (resources are immutable).
+     * @param {CheckOutputPermissionsRequest} [checkOutputPermissionsRequest] Additional parameters for the permissions check
+     * @throws {BitmovinError}
+     * @memberof OutputsApi
+     */
+    OutputsApi.prototype.checkPermissions = function (outputId, checkOutputPermissionsRequest) {
+        var pathParamMap = {
+            output_id: outputId
+        };
+        return this.restClient.post('/encoding/outputs/{output_id}/check-permissions', pathParamMap, checkOutputPermissionsRequest).then(function (response) {
+            return (0, Mapper_1.map)(response, CheckOutputPermissionsResponse_1.default);
+        });
+    };
     /**
      * @summary Get Output Details
      * @param {string} outputId Id of the wanted output

package/dist/models/BroadcastTsMuxing.d.ts

@@ -19,7 +19,7 @@ export declare class BroadcastTsMuxing extends Muxing {
      */
     segmentLength?: number;
     /**
-     * Name of the new Video
+     * Name of the output file
      * @type {string}
      * @memberof BroadcastTsMuxing
      */

package/dist/models/CheckOutputPermissionsRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @export
+ * @class CheckOutputPermissionsRequest
+ */
+export declare class CheckOutputPermissionsRequest {
+    /**
+     * The path on the storage for which permissions should be checked. In AWS S3 terminology, this corresponds to a \"prefix\". To perform the check, an empty test file (WritePermissionTestFile.txt) will be created in this location. Defaults to an empty string, which corresponds to the root directory.
+     * @type {string}
+     * @memberof CheckOutputPermissionsRequest
+     */
+    path?: string;
+    constructor(obj?: Partial<CheckOutputPermissionsRequest>);
+}
+export default CheckOutputPermissionsRequest;

package/dist/models/CheckOutputPermissionsRequest.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CheckOutputPermissionsRequest = void 0;
+var Mapper_1 = require("../common/Mapper");
+/**
+ * @export
+ * @class CheckOutputPermissionsRequest
+ */
+var CheckOutputPermissionsRequest = /** @class */ (function () {
+    function CheckOutputPermissionsRequest(obj) {
+        if (!obj) {
+            return;
+        }
+        this.path = (0, Mapper_1.map)(obj.path);
+    }
+    return CheckOutputPermissionsRequest;
+}());
+exports.CheckOutputPermissionsRequest = CheckOutputPermissionsRequest;
+exports.default = CheckOutputPermissionsRequest;

package/dist/models/CheckOutputPermissionsResponse.d.ts

@@ -0,0 +1,39 @@
+import OutputType from './OutputType';
+/**
+ * @export
+ * @class CheckOutputPermissionsResponse
+ */
+export declare class CheckOutputPermissionsResponse {
+    /**
+     * Id of the output for which permissions were checked
+     * @type {string}
+     * @memberof CheckOutputPermissionsResponse
+     */
+    outputId?: string;
+    /**
+     * The type of the output for which permissions were checked
+     * @type {OutputType}
+     * @memberof CheckOutputPermissionsResponse
+     */
+    outputType?: OutputType;
+    /**
+     * The path on the storage for which permissions were checked. In AWS S3 terminology, this corresponds to a \"prefix\". An empty string corresponds to the root directory.
+     * @type {string}
+     * @memberof CheckOutputPermissionsResponse
+     */
+    path?: string;
+    /**
+     * Indicates if permissions on the storage are configured correctly to be used as output target by the Bitmovin encoder. If \"false\", *failureReason* will provide additional information.
+     * @type {boolean}
+     * @memberof CheckOutputPermissionsResponse
+     */
+    passed?: boolean;
+    /**
+     * Contains nothing if the check succeeded. Otherwise, contains a message explaining why it failed.
+     * @type {string}
+     * @memberof CheckOutputPermissionsResponse
+     */
+    failureReason?: string;
+    constructor(obj?: Partial<CheckOutputPermissionsResponse>);
+}
+export default CheckOutputPermissionsResponse;

package/dist/models/CheckOutputPermissionsResponse.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CheckOutputPermissionsResponse = void 0;
+var Mapper_1 = require("../common/Mapper");
+/**
+ * @export
+ * @class CheckOutputPermissionsResponse
+ */
+var CheckOutputPermissionsResponse = /** @class */ (function () {
+    function CheckOutputPermissionsResponse(obj) {
+        if (!obj) {
+            return;
+        }
+        this.outputId = (0, Mapper_1.map)(obj.outputId);
+        this.outputType = (0, Mapper_1.map)(obj.outputType);
+        this.path = (0, Mapper_1.map)(obj.path);
+        this.passed = (0, Mapper_1.map)(obj.passed);
+        this.failureReason = (0, Mapper_1.map)(obj.failureReason);
+    }
+    return CheckOutputPermissionsResponse;
+}());
+exports.CheckOutputPermissionsResponse = CheckOutputPermissionsResponse;
+exports.default = CheckOutputPermissionsResponse;

package/dist/models/ChunkedTextMuxing.d.ts

@@ -18,7 +18,7 @@ export declare class ChunkedTextMuxing extends Muxing {
      */
     segmentLength?: number;
     /**
-     * Segment naming template
+     * Segment naming policy
      * @type {string}
      * @memberof ChunkedTextMuxing
      */

package/dist/models/Message.d.ts

@@ -37,7 +37,7 @@ export declare class Message extends BitmovinResponse {
      */
     more?: any;
     /**
-     * Timestamp when the message occured
+     * Timestamp when the message occurred
      * @type {Date}
      * @memberof Message
      */

package/dist/models/Mp3Muxing.d.ts

@@ -12,7 +12,7 @@ export declare class Mp3Muxing extends Muxing {
      */
     readonly type: MuxingType;
     /**
-     * Name of the new file (required)
+     * Name of the output file (required)
      * @type {string}
      * @memberof Mp3Muxing
      */

package/dist/models/Mp4Muxing.d.ts

@@ -15,7 +15,7 @@ export declare class Mp4Muxing extends Muxing {
      */
     readonly type: MuxingType;
     /**
-     * Name of the new Video
+     * Name of the output file
      * @type {string}
      * @memberof Mp4Muxing
      */

package/dist/models/MxfMuxing.d.ts

@@ -12,7 +12,7 @@ export declare class MxfMuxing extends Muxing {
      */
     readonly type: MuxingType;
     /**
-     * Name of the new file (required)
+     * Name of the output file (required)
      * @type {string}
      * @memberof MxfMuxing
      */

package/dist/models/PackedAudioMuxing.d.ts

@@ -18,13 +18,13 @@ export declare class PackedAudioMuxing extends Muxing {
      */
     segmentLength?: number;
     /**
-     * Segment naming policy. The required filename extension depends on the codec (e.g. '.aac' for AAC).
+     * Segment naming policy. The required filename extension depends on the codec (e.g. '.aac' for AAC). Either this or *segmentNamingTemplate* must be set.
      * @type {string}
      * @memberof PackedAudioMuxing
      */
     segmentNaming?: string;
     /**
-     * Segment naming policy containing a placeholder of the format '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property. Intended to avoid re-use of segment names after restarting a live encoding. If segmentNamingTemplate is set, segmentNaming must not be set. The required filename extension depends on the codec (e.g. '.aac' for AAC).
+     * Segment naming policy containing a placeholder of the format '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property. Intended to avoid re-use of segment names after restarting a live encoding. Either this or *segmentNaming* must be set. The required filename extension depends on the codec (e.g. '.aac' for AAC).
      * @type {string}
      * @memberof PackedAudioMuxing
      */

package/dist/models/ProgressiveMovMuxing.d.ts

@@ -12,7 +12,7 @@ export declare class ProgressiveMovMuxing extends Muxing {
      */
     readonly type: MuxingType;
     /**
-     * The output file name
+     * Name of the output file
      * @type {string}
      * @memberof ProgressiveMovMuxing
      */

package/dist/models/ProgressiveTsMuxing.d.ts

@@ -18,7 +18,7 @@ export declare class ProgressiveTsMuxing extends Muxing {
      */
     segmentLength?: number;
     /**
-     * Name of the new Video
+     * Name of the output file
      * @type {string}
      * @memberof ProgressiveTsMuxing
      */

package/dist/models/ProgressiveWebmMuxing.d.ts

@@ -13,7 +13,7 @@ export declare class ProgressiveWebmMuxing extends Muxing {
      */
     readonly type: MuxingType;
     /**
-     * Name of the new Video
+     * Name of the output file
      * @type {string}
      * @memberof ProgressiveWebmMuxing
      */

package/dist/models/TextMuxing.d.ts

@@ -12,7 +12,7 @@ export declare class TextMuxing extends Muxing {
      */
     readonly type: MuxingType;
     /**
-     * The output file name (required)
+     * Name of the output file (required)
      * @type {string}
      * @memberof TextMuxing
      */

package/dist/models/TsMuxing.d.ts

@@ -13,7 +13,7 @@ export declare class TsMuxing extends Muxing {
      */
     readonly type: MuxingType;
     /**
-     * Length of the fragments in seconds (required)
+     * Length of the fragments in seconds
      * @type {number}
      * @memberof TsMuxing
      */

package/dist/models/index.d.ts

@@ -186,6 +186,8 @@ export * from './CencPlayReady';
 export * from './CencWidevine';
 export * from './ChannelLayout';
 export * from './ChannelsAttributeForAudio';
+export * from './CheckOutputPermissionsRequest';
+export * from './CheckOutputPermissionsResponse';
 export * from './ChromaLocation';
 export * from './ChunkedTextMuxing';
 export * from './ClearKeyDrm';

package/dist/models/index.js

@@ -202,6 +202,8 @@ __exportStar(require("./CencPlayReady"), exports);
 __exportStar(require("./CencWidevine"), exports);
 __exportStar(require("./ChannelLayout"), exports);
 __exportStar(require("./ChannelsAttributeForAudio"), exports);
+__exportStar(require("./CheckOutputPermissionsRequest"), exports);
+__exportStar(require("./CheckOutputPermissionsResponse"), exports);
 __exportStar(require("./ChromaLocation"), exports);
 __exportStar(require("./ChunkedTextMuxing"), exports);
 __exportStar(require("./ClearKeyDrm"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitmovin/api-sdk",
-  "version": "1.145.0",
+  "version": "1.147.0",
   "description": "Bitmovin JS/TS API SDK",
   "author": "Bitmovin Inc",
   "keywords": [