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

package/dist/encoding/encodings/live/hd/HdApi.d.ts

@@ -18,7 +18,7 @@ export default class HdApi extends BaseAPI {
      */
     getStartRequest(encodingId: string): Promise<StartLiveChannelEncodingRequest>;
     /**
-     * @summary Start Live Encoding
+     * @summary Start HD Options Live Encoding
      * @param {string} encodingId Id of the encoding
      * @param {StartLiveChannelEncodingRequest} startLiveChannelEncodingRequest Live Encoding startup options
      * @throws {BitmovinError}

package/dist/encoding/encodings/live/hd/HdApi.js

@@ -45,7 +45,7 @@ var HdApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * @summary Start Live Encoding
+     * @summary Start HD Options Live Encoding
      * @param {string} encodingId Id of the encoding
      * @param {StartLiveChannelEncodingRequest} startLiveChannelEncodingRequest Live Encoding startup options
      * @throws {BitmovinError}

package/dist/models/AnalyticsAttribute.d.ts

@@ -122,6 +122,7 @@ export declare enum AnalyticsAttribute {
     VIDEOTIME_END = "VIDEOTIME_END",
     VIDEOTIME_START = "VIDEOTIME_START",
     VIDEOSTART_FAILED = "VIDEOSTART_FAILED",
-    VIDEOSTART_FAILED_REASON = "VIDEOSTART_FAILED_REASON"
+    VIDEOSTART_FAILED_REASON = "VIDEOSTART_FAILED_REASON",
+    VIEWTIME = "VIEWTIME"
 }
 export default AnalyticsAttribute;

package/dist/models/AnalyticsAttribute.js

@@ -127,5 +127,6 @@ var AnalyticsAttribute;
     AnalyticsAttribute["VIDEOTIME_START"] = "VIDEOTIME_START";
     AnalyticsAttribute["VIDEOSTART_FAILED"] = "VIDEOSTART_FAILED";
     AnalyticsAttribute["VIDEOSTART_FAILED_REASON"] = "VIDEOSTART_FAILED_REASON";
+    AnalyticsAttribute["VIEWTIME"] = "VIEWTIME";
 })(AnalyticsAttribute = exports.AnalyticsAttribute || (exports.AnalyticsAttribute = {}));
 exports.default = AnalyticsAttribute;

package/dist/models/NexGuardFileMarker.d.ts

@@ -13,7 +13,7 @@ export declare class NexGuardFileMarker extends BitmovinResource {
      */
     license?: string;
     /**
-     * The type of watermarking to be used. Usually, OTT is the one recommended in production.
+     * The type of watermarking to be used: * `OTT` - A/B watermarking (for video streams only) * `DUPLICATED` - Stream duplication to match A/B video streams in CDN delivery (for audio streams only)
      * @type {NexGuardWatermarkingType}
      * @memberof NexGuardFileMarker
      */

package/dist/models/StreamsLiveResponse.d.ts

@@ -2,6 +2,7 @@ import StreamsAdConfigResponse from './StreamsAdConfigResponse';
 import StreamsContentProtectionResponse from './StreamsContentProtectionResponse';
 import StreamsLiveLifeCycle from './StreamsLiveLifeCycle';
 import StreamsStyleConfigResponse from './StreamsStyleConfigResponse';
+import StreamsTrimmingStatus from './StreamsTrimmingStatus';
 /**
  * @export
  * @class StreamsLiveResponse
@@ -64,6 +65,12 @@ export declare class StreamsLiveResponse {
      * @memberof StreamsLiveResponse
      */
     contentProtection?: StreamsContentProtectionResponse;
+    /**
+     * Stream trimming information
+     * @type {StreamsTrimmingStatus}
+     * @memberof StreamsLiveResponse
+     */
+    trimming?: StreamsTrimmingStatus;
     constructor(obj?: Partial<StreamsLiveResponse>);
 }
 export default StreamsLiveResponse;

package/dist/models/StreamsLiveResponse.js

@@ -24,6 +24,7 @@ var StreamsLiveResponse = /** @class */ (function () {
         this.posterUrl = (0, Mapper_1.map)(obj.posterUrl);
         this.adConfig = (0, Mapper_1.map)(obj.adConfig, StreamsAdConfigResponse_1.default);
         this.contentProtection = (0, Mapper_1.map)(obj.contentProtection, StreamsContentProtectionResponse_1.default);
+        this.trimming = (0, Mapper_1.map)(obj.trimming);
     }
     return StreamsLiveResponse;
 }());

package/dist/models/StreamsSearchResponse.d.ts

@@ -0,0 +1,39 @@
+import StreamsType from './StreamsType';
+/**
+ * @export
+ * @class StreamsSearchResponse
+ */
+export declare class StreamsSearchResponse {
+    /**
+     * The identifier of the stream
+     * @type {string}
+     * @memberof StreamsSearchResponse
+     */
+    id?: string;
+    /**
+     * The title of the stream
+     * @type {string}
+     * @memberof StreamsSearchResponse
+     */
+    title?: string;
+    /**
+     * The description of the stream
+     * @type {string}
+     * @memberof StreamsSearchResponse
+     */
+    description?: string;
+    /**
+     * Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
+     * @type {Date}
+     * @memberof StreamsSearchResponse
+     */
+    createdAt?: Date;
+    /**
+     * The type the stream
+     * @type {StreamsType}
+     * @memberof StreamsSearchResponse
+     */
+    type?: StreamsType;
+    constructor(obj?: Partial<StreamsSearchResponse>);
+}
+export default StreamsSearchResponse;

package/dist/models/StreamsSearchResponse.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreamsSearchResponse = void 0;
+var Mapper_1 = require("../common/Mapper");
+/**
+ * @export
+ * @class StreamsSearchResponse
+ */
+var StreamsSearchResponse = /** @class */ (function () {
+    function StreamsSearchResponse(obj) {
+        if (!obj) {
+            return;
+        }
+        this.id = (0, Mapper_1.map)(obj.id);
+        this.title = (0, Mapper_1.map)(obj.title);
+        this.description = (0, Mapper_1.map)(obj.description);
+        this.createdAt = (0, Mapper_1.map)(obj.createdAt, Date);
+        this.type = (0, Mapper_1.map)(obj.type);
+    }
+    return StreamsSearchResponse;
+}());
+exports.StreamsSearchResponse = StreamsSearchResponse;
+exports.default = StreamsSearchResponse;

package/dist/models/StreamsTrimmingStatus.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @export
+ * @enum {string}
+ */
+export declare enum StreamsTrimmingStatus {
+    UNAVAILABLE = "UNAVAILABLE",
+    AVAILABLE = "AVAILABLE",
+    STARTED = "STARTED",
+    ERROR = "ERROR",
+    FINISHED = "FINISHED"
+}
+export default StreamsTrimmingStatus;

package/dist/models/StreamsTrimmingStatus.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreamsTrimmingStatus = void 0;
+/**
+ * @export
+ * @enum {string}
+ */
+var StreamsTrimmingStatus;
+(function (StreamsTrimmingStatus) {
+    StreamsTrimmingStatus["UNAVAILABLE"] = "UNAVAILABLE";
+    StreamsTrimmingStatus["AVAILABLE"] = "AVAILABLE";
+    StreamsTrimmingStatus["STARTED"] = "STARTED";
+    StreamsTrimmingStatus["ERROR"] = "ERROR";
+    StreamsTrimmingStatus["FINISHED"] = "FINISHED";
+})(StreamsTrimmingStatus = exports.StreamsTrimmingStatus || (exports.StreamsTrimmingStatus = {}));
+exports.default = StreamsTrimmingStatus;

package/dist/models/StreamsType.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @export
+ * @enum {string}
+ */
+export declare enum StreamsType {
+    VIDEO = "VIDEO",
+    LIVE = "LIVE"
+}
+export default StreamsType;

package/dist/models/StreamsType.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreamsType = void 0;
+/**
+ * @export
+ * @enum {string}
+ */
+var StreamsType;
+(function (StreamsType) {
+    StreamsType["VIDEO"] = "VIDEO";
+    StreamsType["LIVE"] = "LIVE";
+})(StreamsType = exports.StreamsType || (exports.StreamsType = {}));
+exports.default = StreamsType;

package/dist/models/StreamsVideoResponse.d.ts

@@ -1,6 +1,7 @@
 import StreamsAdConfigResponse from './StreamsAdConfigResponse';
 import StreamsContentProtectionResponse from './StreamsContentProtectionResponse';
 import StreamsStyleConfigResponse from './StreamsStyleConfigResponse';
+import StreamsTrimmingStatus from './StreamsTrimmingStatus';
 import StreamsVideoEncodingTask from './StreamsVideoEncodingTask';
 import StreamsVideoStatus from './StreamsVideoStatus';
 /**
@@ -71,6 +72,12 @@ export declare class StreamsVideoResponse {
      * @memberof StreamsVideoResponse
      */
     contentProtection?: StreamsContentProtectionResponse;
+    /**
+     * Stream trimming information
+     * @type {StreamsTrimmingStatus}
+     * @memberof StreamsVideoResponse
+     */
+    trimming?: StreamsTrimmingStatus;
     constructor(obj?: Partial<StreamsVideoResponse>);
 }
 export default StreamsVideoResponse;

package/dist/models/StreamsVideoResponse.js

@@ -26,6 +26,7 @@ var StreamsVideoResponse = /** @class */ (function () {
         this.posterUrl = (0, Mapper_1.map)(obj.posterUrl);
         this.adConfig = (0, Mapper_1.map)(obj.adConfig, StreamsAdConfigResponse_1.default);
         this.contentProtection = (0, Mapper_1.map)(obj.contentProtection, StreamsContentProtectionResponse_1.default);
+        this.trimming = (0, Mapper_1.map)(obj.trimming);
     }
     return StreamsVideoResponse;
 }());

package/dist/models/index.d.ts

@@ -711,8 +711,11 @@ export * from './StreamsLiveCreateRequest';
 export * from './StreamsLiveLifeCycle';
 export * from './StreamsLiveResponse';
 export * from './StreamsLiveUpdateRequest';
+export * from './StreamsSearchResponse';
 export * from './StreamsStyleConfigPlayerStyle';
 export * from './StreamsStyleConfigResponse';
+export * from './StreamsTrimmingStatus';
+export * from './StreamsType';
 export * from './StreamsVideoCreateRequest';
 export * from './StreamsVideoEncodingStatus';
 export * from './StreamsVideoEncodingTask';

package/dist/models/index.js

@@ -727,8 +727,11 @@ __exportStar(require("./StreamsLiveCreateRequest"), exports);
 __exportStar(require("./StreamsLiveLifeCycle"), exports);
 __exportStar(require("./StreamsLiveResponse"), exports);
 __exportStar(require("./StreamsLiveUpdateRequest"), exports);
+__exportStar(require("./StreamsSearchResponse"), exports);
 __exportStar(require("./StreamsStyleConfigPlayerStyle"), exports);
 __exportStar(require("./StreamsStyleConfigResponse"), exports);
+__exportStar(require("./StreamsTrimmingStatus"), exports);
+__exportStar(require("./StreamsType"), exports);
 __exportStar(require("./StreamsVideoCreateRequest"), exports);
 __exportStar(require("./StreamsVideoEncodingStatus"), exports);
 __exportStar(require("./StreamsVideoEncodingTask"), exports);

package/dist/streams/StreamsApi.d.ts

@@ -1,5 +1,6 @@
 import { BaseAPI } from '../common/BaseAPI';
 import Configuration from '../common/Configuration';
+import SearchApi from './search/SearchApi';
 import VideoApi from './video/VideoApi';
 import LiveApi from './live/LiveApi';
 /**
@@ -9,6 +10,7 @@ import LiveApi from './live/LiveApi';
  * @extends {BaseAPI}
  */
 export default class StreamsApi extends BaseAPI {
+    search: SearchApi;
     video: VideoApi;
     live: LiveApi;
     constructor(configuration: Configuration);

package/dist/streams/StreamsApi.js

@@ -16,6 +16,7 @@ var __extends = (this && this.__extends) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 var BaseAPI_1 = require("../common/BaseAPI");
+var SearchApi_1 = require("./search/SearchApi");
 var VideoApi_1 = require("./video/VideoApi");
 var LiveApi_1 = require("./live/LiveApi");
 /**
@@ -28,6 +29,7 @@ var StreamsApi = /** @class */ (function (_super) {
     __extends(StreamsApi, _super);
     function StreamsApi(configuration) {
         var _this = _super.call(this, configuration) || this;
+        _this.search = new SearchApi_1.default(configuration);
         _this.video = new VideoApi_1.default(configuration);
         _this.live = new LiveApi_1.default(configuration);
         return _this;

package/dist/streams/search/SearchApi.d.ts

@@ -0,0 +1,21 @@
+import { BaseAPI } from '../../common/BaseAPI';
+import Configuration from '../../common/Configuration';
+import StreamsSearchResponse from '../../models/StreamsSearchResponse';
+import PaginationResponse from '../../models/PaginationResponse';
+import { StreamsSearchResponseListQueryParams, StreamsSearchResponseListQueryParamsBuilder } from './StreamsSearchResponseListQueryParams';
+/**
+ * SearchApi - object-oriented interface
+ * @export
+ * @class SearchApi
+ * @extends {BaseAPI}
+ */
+export default class SearchApi extends BaseAPI {
+    constructor(configuration: Configuration);
+    /**
+     * @summary Get paginated search results of VOD and Live streams
+     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
+     * @throws {BitmovinError}
+     * @memberof SearchApi
+     */
+    list(queryParameters?: StreamsSearchResponseListQueryParams | ((q: StreamsSearchResponseListQueryParamsBuilder) => StreamsSearchResponseListQueryParamsBuilder)): Promise<PaginationResponse<StreamsSearchResponse>>;
+}

package/dist/streams/search/SearchApi.js

@@ -0,0 +1,53 @@
+"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 StreamsSearchResponse_1 = require("../../models/StreamsSearchResponse");
+var PaginationResponse_1 = require("../../models/PaginationResponse");
+var StreamsSearchResponseListQueryParams_1 = require("./StreamsSearchResponseListQueryParams");
+/**
+ * SearchApi - object-oriented interface
+ * @export
+ * @class SearchApi
+ * @extends {BaseAPI}
+ */
+var SearchApi = /** @class */ (function (_super) {
+    __extends(SearchApi, _super);
+    function SearchApi(configuration) {
+        return _super.call(this, configuration) || this;
+    }
+    /**
+     * @summary Get paginated search results of VOD and Live streams
+     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
+     * @throws {BitmovinError}
+     * @memberof SearchApi
+     */
+    SearchApi.prototype.list = function (queryParameters) {
+        var queryParams = {};
+        if (typeof queryParameters === 'function') {
+            queryParams = queryParameters(new StreamsSearchResponseListQueryParams_1.StreamsSearchResponseListQueryParamsBuilder()).buildQueryParams();
+        }
+        else if (queryParameters) {
+            queryParams = queryParameters;
+        }
+        return this.restClient.get('/streams/search', {}, queryParams).then(function (response) {
+            return new PaginationResponse_1.default(response, StreamsSearchResponse_1.default);
+        });
+    };
+    return SearchApi;
+}(BaseAPI_1.BaseAPI));
+exports.default = SearchApi;

package/dist/streams/search/StreamsSearchResponseListQueryParams.d.ts

@@ -0,0 +1,39 @@
+export interface StreamsSearchResponseListQueryParams {
+    /**
+     * Index of the first item to return, starting at 0. Default is 0
+     * @type {number}
+     * @memberof StreamsSearchResponseListQueryParams
+     */
+    offset?: number | undefined;
+    /**
+     * Maximum number of items to return. Default is 25, maximum is 100
+     * @type {number}
+     * @memberof StreamsSearchResponseListQueryParams
+     */
+    limit?: number | undefined;
+    /**
+     * Query to search against
+     * @type {string}
+     * @memberof StreamsSearchResponseListQueryParams
+     */
+    query?: string | undefined;
+}
+export declare class StreamsSearchResponseListQueryParamsBuilder {
+    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 query Query to search against
+     */
+    query(query: string): this;
+    buildQueryParams(): StreamsSearchResponseListQueryParams;
+}

package/dist/streams/search/StreamsSearchResponseListQueryParams.js

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

package/package.json

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