@bitmovin/api-sdk 1.234.3 → 1.235.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.234.3',
+            'X-Api-Client-Version': '1.235.0',
             'Content-Type': 'application/json'
         };
         if (tenantOrgId) {

package/dist/encoding/inputs/InputsApi.d.ts

@@ -11,6 +11,7 @@ import GcsApi from './gcs/GcsApi';
 import GcsServiceAccountApi from './gcsServiceAccount/GcsServiceAccountApi';
 import AzureApi from './azure/AzureApi';
 import FtpApi from './ftp/FtpApi';
+import HlsApi from './hls/HlsApi';
 import SftpApi from './sftp/SftpApi';
 import HttpApi from './http/HttpApi';
 import HttpsApi from './https/HttpsApi';
@@ -40,6 +41,7 @@ export default class InputsApi extends BaseAPI {
     gcsServiceAccount: GcsServiceAccountApi;
     azure: AzureApi;
     ftp: FtpApi;
+    hls: HlsApi;
     sftp: SftpApi;
     http: HttpApi;
     https: HttpsApi;

package/dist/encoding/inputs/InputsApi.js

@@ -28,6 +28,7 @@ var GcsApi_1 = require("./gcs/GcsApi");
 var GcsServiceAccountApi_1 = require("./gcsServiceAccount/GcsServiceAccountApi");
 var AzureApi_1 = require("./azure/AzureApi");
 var FtpApi_1 = require("./ftp/FtpApi");
+var HlsApi_1 = require("./hls/HlsApi");
 var SftpApi_1 = require("./sftp/SftpApi");
 var HttpApi_1 = require("./http/HttpApi");
 var HttpsApi_1 = require("./https/HttpsApi");
@@ -60,6 +61,7 @@ var InputsApi = /** @class */ (function (_super) {
         _this.gcsServiceAccount = new GcsServiceAccountApi_1.default(configuration);
         _this.azure = new AzureApi_1.default(configuration);
         _this.ftp = new FtpApi_1.default(configuration);
+        _this.hls = new HlsApi_1.default(configuration);
         _this.sftp = new SftpApi_1.default(configuration);
         _this.http = new HttpApi_1.default(configuration);
         _this.https = new HttpsApi_1.default(configuration);

package/dist/encoding/inputs/hls/HlsApi.d.ts

@@ -0,0 +1,42 @@
+import { BaseAPI } from '../../../common/BaseAPI';
+import Configuration from '../../../common/Configuration';
+import HlsInput from '../../../models/HlsInput';
+import PaginationResponse from '../../../models/PaginationResponse';
+import { HlsInputListQueryParams, HlsInputListQueryParamsBuilder } from './HlsInputListQueryParams';
+/**
+ * HlsApi - object-oriented interface
+ * @export
+ * @class HlsApi
+ * @extends {BaseAPI}
+ */
+export default class HlsApi extends BaseAPI {
+    constructor(configuration: Configuration);
+    /**
+     * @summary Create HLS input
+     * @param {HlsInput} hlsInput The HLSInput to be created
+     * @throws {BitmovinError}
+     * @memberof HlsApi
+     */
+    create(hlsInput?: HlsInput): Promise<HlsInput>;
+    /**
+     * @summary Delete HLS Input
+     * @param {string} inputId Id of the input
+     * @throws {BitmovinError}
+     * @memberof HlsApi
+     */
+    delete(inputId: string): Promise<HlsInput>;
+    /**
+     * @summary HLS Input Details
+     * @param {string} inputId Id of the input
+     * @throws {BitmovinError}
+     * @memberof HlsApi
+     */
+    get(inputId: string): Promise<HlsInput>;
+    /**
+     * @summary List HLS inputs
+     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
+     * @throws {BitmovinError}
+     * @memberof HlsApi
+     */
+    list(queryParameters?: HlsInputListQueryParams | ((q: HlsInputListQueryParamsBuilder) => HlsInputListQueryParamsBuilder)): Promise<PaginationResponse<HlsInput>>;
+}

package/dist/encoding/inputs/hls/HlsApi.js

@@ -0,0 +1,93 @@
+"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 HlsInput_1 = require("../../../models/HlsInput");
+var PaginationResponse_1 = require("../../../models/PaginationResponse");
+var HlsInputListQueryParams_1 = require("./HlsInputListQueryParams");
+/**
+ * HlsApi - object-oriented interface
+ * @export
+ * @class HlsApi
+ * @extends {BaseAPI}
+ */
+var HlsApi = /** @class */ (function (_super) {
+    __extends(HlsApi, _super);
+    function HlsApi(configuration) {
+        return _super.call(this, configuration) || this;
+    }
+    /**
+     * @summary Create HLS input
+     * @param {HlsInput} hlsInput The HLSInput to be created
+     * @throws {BitmovinError}
+     * @memberof HlsApi
+     */
+    HlsApi.prototype.create = function (hlsInput) {
+        return this.restClient.post('/encoding/inputs/hls', {}, hlsInput).then(function (response) {
+            return (0, Mapper_1.map)(response, HlsInput_1.default);
+        });
+    };
+    /**
+     * @summary Delete HLS Input
+     * @param {string} inputId Id of the input
+     * @throws {BitmovinError}
+     * @memberof HlsApi
+     */
+    HlsApi.prototype.delete = function (inputId) {
+        var pathParamMap = {
+            input_id: inputId
+        };
+        return this.restClient.delete('/encoding/inputs/hls/{input_id}', pathParamMap).then(function (response) {
+            return (0, Mapper_1.map)(response, HlsInput_1.default);
+        });
+    };
+    /**
+     * @summary HLS Input Details
+     * @param {string} inputId Id of the input
+     * @throws {BitmovinError}
+     * @memberof HlsApi
+     */
+    HlsApi.prototype.get = function (inputId) {
+        var pathParamMap = {
+            input_id: inputId
+        };
+        return this.restClient.get('/encoding/inputs/hls/{input_id}', pathParamMap).then(function (response) {
+            return (0, Mapper_1.map)(response, HlsInput_1.default);
+        });
+    };
+    /**
+     * @summary List HLS inputs
+     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
+     * @throws {BitmovinError}
+     * @memberof HlsApi
+     */
+    HlsApi.prototype.list = function (queryParameters) {
+        var queryParams = {};
+        if (typeof queryParameters === 'function') {
+            queryParams = queryParameters(new HlsInputListQueryParams_1.HlsInputListQueryParamsBuilder()).buildQueryParams();
+        }
+        else if (queryParameters) {
+            queryParams = queryParameters;
+        }
+        return this.restClient.get('/encoding/inputs/hls', {}, queryParams).then(function (response) {
+            return new PaginationResponse_1.default(response, HlsInput_1.default);
+        });
+    };
+    return HlsApi;
+}(BaseAPI_1.BaseAPI));
+exports.default = HlsApi;

package/dist/encoding/inputs/hls/HlsInputListQueryParams.d.ts

@@ -0,0 +1,39 @@
+export interface HlsInputListQueryParams {
+    /**
+     * Index of the first item to return, starting at 0. Default is 0
+     * @type {number}
+     * @memberof HlsInputListQueryParams
+     */
+    offset?: number | undefined;
+    /**
+     * Maximum number of items to return. Default is 25, maximum is 100
+     * @type {number}
+     * @memberof HlsInputListQueryParams
+     */
+    limit?: number | undefined;
+    /**
+     * Filter inputs by name
+     * @type {string}
+     * @memberof HlsInputListQueryParams
+     */
+    name?: string | undefined;
+}
+export declare class HlsInputListQueryParamsBuilder {
+    private internalParams;
+    /**
+     *
+     * @param offset Index of the first item to return, starting at 0. Default is 0
+     */
+    offset(offset: number): this;
+    /**
+     *
+     * @param limit Maximum number of items to return. Default is 25, maximum is 100
+     */
+    limit(limit: number): this;
+    /**
+     *
+     * @param name Filter inputs by name
+     */
+    name(name: string): this;
+    buildQueryParams(): HlsInputListQueryParams;
+}

package/dist/encoding/inputs/hls/HlsInputListQueryParams.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HlsInputListQueryParamsBuilder = void 0;
+var HlsInputListQueryParamsBuilder = /** @class */ (function () {
+    function HlsInputListQueryParamsBuilder() {
+        this.internalParams = {};
+    }
+    /**
+     *
+     * @param offset Index of the first item to return, starting at 0. Default is 0
+     */
+    HlsInputListQueryParamsBuilder.prototype.offset = function (offset) {
+        this.internalParams.offset = offset;
+        return this;
+    };
+    /**
+     *
+     * @param limit Maximum number of items to return. Default is 25, maximum is 100
+     */
+    HlsInputListQueryParamsBuilder.prototype.limit = function (limit) {
+        this.internalParams.limit = limit;
+        return this;
+    };
+    /**
+     *
+     * @param name Filter inputs by name
+     */
+    HlsInputListQueryParamsBuilder.prototype.name = function (name) {
+        this.internalParams.name = name;
+        return this;
+    };
+    HlsInputListQueryParamsBuilder.prototype.buildQueryParams = function () {
+        return this.internalParams;
+    };
+    return HlsInputListQueryParamsBuilder;
+}());
+exports.HlsInputListQueryParamsBuilder = HlsInputListQueryParamsBuilder;

package/dist/models/AwsAccount.d.ts

@@ -5,13 +5,13 @@ import BitmovinResource from './BitmovinResource';
  */
 export declare class AwsAccount extends BitmovinResource {
     /**
-     * Amazon access key (required)
+     * Deprecated: Amazon access key for legacy support. Use roleName instead
      * @type {string}
      * @memberof AwsAccount
      */
     accessKey?: string;
     /**
-     * Amazon secret key (required)
+     * Deprecated: Amazon secret key for legacy support. Use roleName instead
      * @type {string}
      * @memberof AwsAccount
      */
@@ -22,6 +22,18 @@ export declare class AwsAccount extends BitmovinResource {
      * @memberof AwsAccount
      */
     accountNumber?: string;
+    /**
+     * Role name including path for the AWS IAM role that will be used by Bitmovin to access the AWS account depicted by accountNumber. The role ARN is constructed based on accountNumber and roleName: arn:aws:iam::{accountNumber}:role/{roleName}
+     * @type {string}
+     * @memberof AwsAccount
+     */
+    roleName?: string;
+    /**
+     * External ID that needs to be set in the trust policy of the AWS IAM role (depicted by roleName) that allows Bitmovin access to the AWS account depicted by accountNumber
+     * @type {string}
+     * @memberof AwsAccount
+     */
+    externalId?: string;
     constructor(obj?: Partial<AwsAccount>);
 }
 export default AwsAccount;

package/dist/models/AwsAccount.js

@@ -32,6 +32,8 @@ var AwsAccount = /** @class */ (function (_super) {
         _this.accessKey = (0, Mapper_1.map)(obj.accessKey);
         _this.secretKey = (0, Mapper_1.map)(obj.secretKey);
         _this.accountNumber = (0, Mapper_1.map)(obj.accountNumber);
+        _this.roleName = (0, Mapper_1.map)(obj.roleName);
+        _this.externalId = (0, Mapper_1.map)(obj.externalId);
         return _this;
     }
     return AwsAccount;

package/dist/models/DashManifestAdMarkerSettings.d.ts

@@ -0,0 +1,21 @@
+import DashScte35EventStreamSignalling from './DashScte35EventStreamSignalling';
+import DashScte35PeriodOption from './DashScte35PeriodOption';
+/**
+ * An optional configuration object used to define SCTE-35 signaling for ad insertion or content segmentation.  This field enables precise control over signaling behavior at both the period and event stream levels,  making it suitable for dynamic ad insertion (DAI) and live streaming workflows. This follows the ANSI/SCTE 214-1 (2024) standard.
+ * @export
+ * @class DashManifestAdMarkerSettings
+ */
+export declare class DashManifestAdMarkerSettings {
+    /**
+     * @type {DashScte35PeriodOption}
+     * @memberof DashManifestAdMarkerSettings
+     */
+    periodOption?: DashScte35PeriodOption;
+    /**
+     * @type {DashScte35EventStreamSignalling}
+     * @memberof DashManifestAdMarkerSettings
+     */
+    eventStreamSignalling?: DashScte35EventStreamSignalling;
+    constructor(obj?: Partial<DashManifestAdMarkerSettings>);
+}
+export default DashManifestAdMarkerSettings;

package/dist/models/DashManifestAdMarkerSettings.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DashManifestAdMarkerSettings = void 0;
+var Mapper_1 = require("../common/Mapper");
+/**
+ * An optional configuration object used to define SCTE-35 signaling for ad insertion or content segmentation.  This field enables precise control over signaling behavior at both the period and event stream levels,  making it suitable for dynamic ad insertion (DAI) and live streaming workflows. This follows the ANSI/SCTE 214-1 (2024) standard.
+ * @export
+ * @class DashManifestAdMarkerSettings
+ */
+var DashManifestAdMarkerSettings = /** @class */ (function () {
+    function DashManifestAdMarkerSettings(obj) {
+        if (!obj) {
+            return;
+        }
+        this.periodOption = (0, Mapper_1.map)(obj.periodOption);
+        this.eventStreamSignalling = (0, Mapper_1.map)(obj.eventStreamSignalling);
+    }
+    return DashManifestAdMarkerSettings;
+}());
+exports.DashManifestAdMarkerSettings = DashManifestAdMarkerSettings;
+exports.default = DashManifestAdMarkerSettings;

package/dist/models/DashScte35EventStreamSignalling.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Defines how SCTE-35 events are delivered using DASH EventStream. <ul>   <li>XML: Events will contain an XML representation of a SCTE-35 cue message as a SpliceInfoSection element as defined in SCTE-35. The schemeIdUri will be \"urn:scte:scte35:2013:xml.</li>   <li>XML_BIN: Events will contain an XML representation of a SCTE-35 cue message as a Signal.Binary element as defined in SCTE-35. The schemeIdUri will be \"urn:scte:scte35:2014:xml+bin</li> </ul>
+ * @export
+ * @enum {string}
+ */
+export declare enum DashScte35EventStreamSignalling {
+    XML = "XML",
+    XML_BIN = "XML_BIN"
+}
+export default DashScte35EventStreamSignalling;

package/dist/models/DashScte35EventStreamSignalling.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DashScte35EventStreamSignalling = void 0;
+/**
+ * Defines how SCTE-35 events are delivered using DASH EventStream. <ul>   <li>XML: Events will contain an XML representation of a SCTE-35 cue message as a SpliceInfoSection element as defined in SCTE-35. The schemeIdUri will be \"urn:scte:scte35:2013:xml.</li>   <li>XML_BIN: Events will contain an XML representation of a SCTE-35 cue message as a Signal.Binary element as defined in SCTE-35. The schemeIdUri will be \"urn:scte:scte35:2014:xml+bin</li> </ul>
+ * @export
+ * @enum {string}
+ */
+var DashScte35EventStreamSignalling;
+(function (DashScte35EventStreamSignalling) {
+    DashScte35EventStreamSignalling["XML"] = "XML";
+    DashScte35EventStreamSignalling["XML_BIN"] = "XML_BIN";
+})(DashScte35EventStreamSignalling || (exports.DashScte35EventStreamSignalling = DashScte35EventStreamSignalling = {}));
+exports.default = DashScte35EventStreamSignalling;

package/dist/models/DashScte35PeriodOption.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Controls how SCTE-35 signals are applied at the DASH period level. <ul>   <li>SINGLE_PERIOD: Applies SCTE markers to a single DASH period.</li>   <li>MULTI_PERIOD: Multiple periods are created based on received SCTE-35 messages.</li> </ul>
+ * @export
+ * @enum {string}
+ */
+export declare enum DashScte35PeriodOption {
+    SINGLE_PERIOD = "SINGLE_PERIOD",
+    MULTI_PERIOD = "MULTI_PERIOD"
+}
+export default DashScte35PeriodOption;

package/dist/models/DashScte35PeriodOption.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DashScte35PeriodOption = void 0;
+/**
+ * Controls how SCTE-35 signals are applied at the DASH period level. <ul>   <li>SINGLE_PERIOD: Applies SCTE markers to a single DASH period.</li>   <li>MULTI_PERIOD: Multiple periods are created based on received SCTE-35 messages.</li> </ul>
+ * @export
+ * @enum {string}
+ */
+var DashScte35PeriodOption;
+(function (DashScte35PeriodOption) {
+    DashScte35PeriodOption["SINGLE_PERIOD"] = "SINGLE_PERIOD";
+    DashScte35PeriodOption["MULTI_PERIOD"] = "MULTI_PERIOD";
+})(DashScte35PeriodOption || (exports.DashScte35PeriodOption = DashScte35PeriodOption = {}));
+exports.default = DashScte35PeriodOption;

package/dist/models/LiveDashManifest.d.ts

@@ -1,4 +1,5 @@
 import AvailabilityStartTimeMode from './AvailabilityStartTimeMode';
+import DashManifestAdMarkerSettings from './DashManifestAdMarkerSettings';
 /**
  * @export
  * @class LiveDashManifest
@@ -40,6 +41,11 @@ export declare class LiveDashManifest {
      * @memberof LiveDashManifest
      */
     availabilityStartTimeMode?: AvailabilityStartTimeMode;
+    /**
+     * @type {DashManifestAdMarkerSettings}
+     * @memberof LiveDashManifest
+     */
+    adMarkerSettings?: DashManifestAdMarkerSettings;
     constructor(obj?: Partial<LiveDashManifest>);
 }
 export default LiveDashManifest;

package/dist/models/LiveDashManifest.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LiveDashManifest = void 0;
 var Mapper_1 = require("../common/Mapper");
+var DashManifestAdMarkerSettings_1 = require("./DashManifestAdMarkerSettings");
 /**
  * @export
  * @class LiveDashManifest
@@ -17,6 +18,7 @@ var LiveDashManifest = /** @class */ (function () {
         this.suggestedPresentationDelay = (0, Mapper_1.map)(obj.suggestedPresentationDelay);
         this.minimumUpdatePeriod = (0, Mapper_1.map)(obj.minimumUpdatePeriod);
         this.availabilityStartTimeMode = (0, Mapper_1.map)(obj.availabilityStartTimeMode);
+        this.adMarkerSettings = (0, Mapper_1.map)(obj.adMarkerSettings, DashManifestAdMarkerSettings_1.default);
     }
     return LiveDashManifest;
 }());

package/dist/models/Scene.d.ts

@@ -35,6 +35,11 @@ export declare class Scene {
      * @memberof Scene
      */
     summary?: string;
+    /**
+     * @type {string}
+     * @memberof Scene
+     */
+    verboseSummary?: string;
     /**
      * @type {string[]}
      * @memberof Scene

package/dist/models/Scene.js

@@ -19,6 +19,7 @@ var Scene = /** @class */ (function () {
         this.id = (0, Mapper_1.map)(obj.id);
         this.content = (0, Mapper_1.map)(obj.content, Content_1.default);
         this.summary = (0, Mapper_1.map)(obj.summary);
+        this.verboseSummary = (0, Mapper_1.map)(obj.verboseSummary);
         this.sensitiveTopics = (0, Mapper_1.mapArray)(obj.sensitiveTopics);
         this.keywords = (0, Mapper_1.mapArray)(obj.keywords);
         this.iab = (0, Mapper_1.map)(obj.iab, IABTaxonomy_1.default);

package/dist/models/index.d.ts

@@ -252,6 +252,7 @@ export * from './DashFmp4Representation';
 export * from './DashISO8601TimestampFormat';
 export * from './DashImscRepresentation';
 export * from './DashManifest';
+export * from './DashManifestAdMarkerSettings';
 export * from './DashManifestDefault';
 export * from './DashManifestDefaultVersion';
 export * from './DashMp4DrmRepresentation';
@@ -265,6 +266,8 @@ export * from './DashRepresentationType';
 export * from './DashRepresentationTypeDiscriminator';
 export * from './DashRepresentationTypeMode';
 export * from './DashRepresentationTypeResponse';
+export * from './DashScte35EventStreamSignalling';
+export * from './DashScte35PeriodOption';
 export * from './DashSegmentedRepresentation';
 export * from './DashVttRepresentation';
 export * from './DashWebmRepresentation';

package/dist/models/index.js

@@ -268,6 +268,7 @@ __exportStar(require("./DashFmp4Representation"), exports);
 __exportStar(require("./DashISO8601TimestampFormat"), exports);
 __exportStar(require("./DashImscRepresentation"), exports);
 __exportStar(require("./DashManifest"), exports);
+__exportStar(require("./DashManifestAdMarkerSettings"), exports);
 __exportStar(require("./DashManifestDefault"), exports);
 __exportStar(require("./DashManifestDefaultVersion"), exports);
 __exportStar(require("./DashMp4DrmRepresentation"), exports);
@@ -281,6 +282,8 @@ __exportStar(require("./DashRepresentationType"), exports);
 __exportStar(require("./DashRepresentationTypeDiscriminator"), exports);
 __exportStar(require("./DashRepresentationTypeMode"), exports);
 __exportStar(require("./DashRepresentationTypeResponse"), exports);
+__exportStar(require("./DashScte35EventStreamSignalling"), exports);
+__exportStar(require("./DashScte35PeriodOption"), exports);
 __exportStar(require("./DashSegmentedRepresentation"), exports);
 __exportStar(require("./DashVttRepresentation"), exports);
 __exportStar(require("./DashWebmRepresentation"), exports);

package/package.json

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