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

package/dist/models/BitmovinStreamQuality.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @export
+ * @enum {string}
+ */
+export declare enum BitmovinStreamQuality {
+    NONE = "NONE",
+    PREVIEW = "PREVIEW",
+    DEFAULT = "DEFAULT"
+}
+export default BitmovinStreamQuality;

package/dist/models/BitmovinStreamQuality.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BitmovinStreamQuality = void 0;
+/**
+ * @export
+ * @enum {string}
+ */
+var BitmovinStreamQuality;
+(function (BitmovinStreamQuality) {
+    BitmovinStreamQuality["NONE"] = "NONE";
+    BitmovinStreamQuality["PREVIEW"] = "PREVIEW";
+    BitmovinStreamQuality["DEFAULT"] = "DEFAULT";
+})(BitmovinStreamQuality = exports.BitmovinStreamQuality || (exports.BitmovinStreamQuality = {}));
+exports.default = BitmovinStreamQuality;

package/dist/models/BitmovinStreamResponse.d.ts

@@ -0,0 +1,58 @@
+import BitmovinStreamQuality from './BitmovinStreamQuality';
+import BitmovinStreamStatus from './BitmovinStreamStatus';
+/**
+ * @export
+ * @class BitmovinStreamResponse
+ */
+export declare class BitmovinStreamResponse {
+    /**
+     * The identifier of the Stream
+     * @type {string}
+     * @memberof BitmovinStreamResponse
+     */
+    id?: string;
+    /**
+     * The asset URL of the Stream
+     * @type {string}
+     * @memberof BitmovinStreamResponse
+     */
+    assetUrl?: string;
+    /**
+     * The title of the Stream
+     * @type {string}
+     * @memberof BitmovinStreamResponse
+     */
+    title?: string;
+    /**
+     * The description of the Stream
+     * @type {string}
+     * @memberof BitmovinStreamResponse
+     */
+    description?: string;
+    /**
+     * Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
+     * @type {Date}
+     * @memberof BitmovinStreamResponse
+     */
+    createdAt?: Date;
+    /**
+     * The status of the Stream
+     * @type {BitmovinStreamStatus}
+     * @memberof BitmovinStreamResponse
+     */
+    status?: BitmovinStreamStatus;
+    /**
+     * The target quality of the Stream
+     * @type {BitmovinStreamQuality}
+     * @memberof BitmovinStreamResponse
+     */
+    targetQuality?: BitmovinStreamQuality;
+    /**
+     * List of available stream qualities
+     * @type {BitmovinStreamQuality[]}
+     * @memberof BitmovinStreamResponse
+     */
+    availableQualities?: BitmovinStreamQuality[];
+    constructor(obj?: Partial<BitmovinStreamResponse>);
+}
+export default BitmovinStreamResponse;

package/dist/models/BitmovinStreamResponse.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BitmovinStreamResponse = void 0;
+var Mapper_1 = require("../common/Mapper");
+/**
+ * @export
+ * @class BitmovinStreamResponse
+ */
+var BitmovinStreamResponse = /** @class */ (function () {
+    function BitmovinStreamResponse(obj) {
+        if (!obj) {
+            return;
+        }
+        this.id = (0, Mapper_1.map)(obj.id);
+        this.assetUrl = (0, Mapper_1.map)(obj.assetUrl);
+        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.status = (0, Mapper_1.map)(obj.status);
+        this.targetQuality = (0, Mapper_1.map)(obj.targetQuality);
+        this.availableQualities = (0, Mapper_1.mapArray)(obj.availableQualities);
+    }
+    return BitmovinStreamResponse;
+}());
+exports.BitmovinStreamResponse = BitmovinStreamResponse;
+exports.default = BitmovinStreamResponse;

package/dist/models/BitmovinStreamStatus.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @export
+ * @enum {string}
+ */
+export declare enum BitmovinStreamStatus {
+    PUBLISHED = "PUBLISHED",
+    UNPUBLISHED = "UNPUBLISHED"
+}
+export default BitmovinStreamStatus;

package/dist/models/BitmovinStreamStatus.js

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

package/dist/models/CreateBitmovinStreamRequest.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @export
+ * @class CreateBitmovinStreamRequest
+ */
+export declare class CreateBitmovinStreamRequest {
+    /**
+     * The Streams input asset URL
+     * @type {string}
+     * @memberof CreateBitmovinStreamRequest
+     */
+    assetUrl?: string;
+    /**
+     * Title of the Stream
+     * @type {string}
+     * @memberof CreateBitmovinStreamRequest
+     */
+    title?: string;
+    /**
+     * Description of the Stream
+     * @type {string}
+     * @memberof CreateBitmovinStreamRequest
+     */
+    description?: string;
+    constructor(obj?: Partial<CreateBitmovinStreamRequest>);
+}
+export default CreateBitmovinStreamRequest;

package/dist/models/CreateBitmovinStreamRequest.js

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

package/dist/models/UpdateBitmovinStreamRequest.d.ts

@@ -0,0 +1,27 @@
+import BitmovinStreamStatus from './BitmovinStreamStatus';
+/**
+ * @export
+ * @class UpdateBitmovinStreamRequest
+ */
+export declare class UpdateBitmovinStreamRequest {
+    /**
+     * The status of the Stream
+     * @type {BitmovinStreamStatus}
+     * @memberof UpdateBitmovinStreamRequest
+     */
+    status?: BitmovinStreamStatus;
+    /**
+     * Title of the Stream
+     * @type {string}
+     * @memberof UpdateBitmovinStreamRequest
+     */
+    title?: string;
+    /**
+     * Description of the Stream
+     * @type {string}
+     * @memberof UpdateBitmovinStreamRequest
+     */
+    description?: string;
+    constructor(obj?: Partial<UpdateBitmovinStreamRequest>);
+}
+export default UpdateBitmovinStreamRequest;

package/dist/models/UpdateBitmovinStreamRequest.js

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

package/dist/models/index.d.ts

@@ -159,6 +159,9 @@ export * from './BillableEncodingMinutesDetails';
 export * from './BitmovinResource';
 export * from './BitmovinResponse';
 export * from './BitmovinResponseList';
+export * from './BitmovinStreamQuality';
+export * from './BitmovinStreamResponse';
+export * from './BitmovinStreamStatus';
 export * from './BitrateSelectionMode';
 export * from './BroadcastTsAudioInputStreamConfiguration';
 export * from './BroadcastTsInputStreamConfiguration';
@@ -210,6 +213,7 @@ export * from './ContentProtection';
 export * from './ConvertSccCaption';
 export * from './ConvertSccCaptionWebVttSettings';
 export * from './ConvertSccPositionMode';
+export * from './CreateBitmovinStreamRequest';
 export * from './CropFilter';
 export * from './CustomAttribute';
 export * from './CustomData';
@@ -718,6 +722,7 @@ export * from './TuInterDepth';
 export * from './TuIntraDepth';
 export * from './Tweaks';
 export * from './UnsharpFilter';
+export * from './UpdateBitmovinStreamRequest';
 export * from './UpdateOrganizationRequest';
 export * from './UtcTiming';
 export * from './VariantStreamDroppingMode';

package/dist/models/index.js

@@ -175,6 +175,9 @@ __exportStar(require("./BillableEncodingMinutesDetails"), exports);
 __exportStar(require("./BitmovinResource"), exports);
 __exportStar(require("./BitmovinResponse"), exports);
 __exportStar(require("./BitmovinResponseList"), exports);
+__exportStar(require("./BitmovinStreamQuality"), exports);
+__exportStar(require("./BitmovinStreamResponse"), exports);
+__exportStar(require("./BitmovinStreamStatus"), exports);
 __exportStar(require("./BitrateSelectionMode"), exports);
 __exportStar(require("./BroadcastTsAudioInputStreamConfiguration"), exports);
 __exportStar(require("./BroadcastTsInputStreamConfiguration"), exports);
@@ -226,6 +229,7 @@ __exportStar(require("./ContentProtection"), exports);
 __exportStar(require("./ConvertSccCaption"), exports);
 __exportStar(require("./ConvertSccCaptionWebVttSettings"), exports);
 __exportStar(require("./ConvertSccPositionMode"), exports);
+__exportStar(require("./CreateBitmovinStreamRequest"), exports);
 __exportStar(require("./CropFilter"), exports);
 __exportStar(require("./CustomAttribute"), exports);
 __exportStar(require("./CustomData"), exports);
@@ -734,6 +738,7 @@ __exportStar(require("./TuInterDepth"), exports);
 __exportStar(require("./TuIntraDepth"), exports);
 __exportStar(require("./Tweaks"), exports);
 __exportStar(require("./UnsharpFilter"), exports);
+__exportStar(require("./UpdateBitmovinStreamRequest"), exports);
 __exportStar(require("./UpdateOrganizationRequest"), exports);
 __exportStar(require("./UtcTiming"), exports);
 __exportStar(require("./VariantStreamDroppingMode"), exports);

package/dist/streams/BitmovinStreamResponseListQueryParams.d.ts

@@ -0,0 +1,39 @@
+export interface BitmovinStreamResponseListQueryParams {
+    /**
+     * Index of the first item to return, starting at 0. Default is 0
+     * @type {number}
+     * @memberof BitmovinStreamResponseListQueryParams
+     */
+    offset?: number | undefined;
+    /**
+     * Maximum number of items to return. Default is 25, maximum is 100
+     * @type {number}
+     * @memberof BitmovinStreamResponseListQueryParams
+     */
+    limit?: number | undefined;
+    /**
+     * Order list result according an resource attribute.  The fields that can be used for sorting are: + `createdAt`
+     * @type {string}
+     * @memberof BitmovinStreamResponseListQueryParams
+     */
+    sort?: string | undefined;
+}
+export declare class BitmovinStreamResponseListQueryParamsBuilder {
+    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 sort Order list result according an resource attribute.  The fields that can be used for sorting are: + `createdAt`
+     */
+    sort(sort: string): this;
+    buildQueryParams(): BitmovinStreamResponseListQueryParams;
+}

package/dist/streams/BitmovinStreamResponseListQueryParams.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BitmovinStreamResponseListQueryParamsBuilder = void 0;
+var BitmovinStreamResponseListQueryParamsBuilder = /** @class */ (function () {
+    function BitmovinStreamResponseListQueryParamsBuilder() {
+        this.internalParams = {};
+    }
+    /**
+     *
+     * @param offset Index of the first item to return, starting at 0. Default is 0
+     */
+    BitmovinStreamResponseListQueryParamsBuilder.prototype.offset = function (offset) {
+        this.internalParams.offset = offset;
+        return this;
+    };
+    /**
+     *
+     * @param limit Maximum number of items to return. Default is 25, maximum is 100
+     */
+    BitmovinStreamResponseListQueryParamsBuilder.prototype.limit = function (limit) {
+        this.internalParams.limit = limit;
+        return this;
+    };
+    /**
+     *
+     * @param sort Order list result according an resource attribute.  The fields that can be used for sorting are: + `createdAt`
+     */
+    BitmovinStreamResponseListQueryParamsBuilder.prototype.sort = function (sort) {
+        this.internalParams.sort = sort;
+        return this;
+    };
+    BitmovinStreamResponseListQueryParamsBuilder.prototype.buildQueryParams = function () {
+        return this.internalParams;
+    };
+    return BitmovinStreamResponseListQueryParamsBuilder;
+}());
+exports.BitmovinStreamResponseListQueryParamsBuilder = BitmovinStreamResponseListQueryParamsBuilder;

package/dist/streams/StreamsApi.d.ts

@@ -0,0 +1,45 @@
+import { BaseAPI } from '../common/BaseAPI';
+import Configuration from '../common/Configuration';
+import BitmovinStreamResponse from '../models/BitmovinStreamResponse';
+import CreateBitmovinStreamRequest from '../models/CreateBitmovinStreamRequest';
+import UpdateBitmovinStreamRequest from '../models/UpdateBitmovinStreamRequest';
+import PaginationResponse from '../models/PaginationResponse';
+import { BitmovinStreamResponseListQueryParams, BitmovinStreamResponseListQueryParamsBuilder } from './BitmovinStreamResponseListQueryParams';
+/**
+ * StreamsApi - object-oriented interface
+ * @export
+ * @class StreamsApi
+ * @extends {BaseAPI}
+ */
+export default class StreamsApi extends BaseAPI {
+    constructor(configuration: Configuration);
+    /**
+     * @summary Create new Stream
+     * @param {CreateBitmovinStreamRequest} createBitmovinStreamRequest Create a new Stream.
+     * @throws {BitmovinError}
+     * @memberof StreamsApi
+     */
+    create(createBitmovinStreamRequest?: CreateBitmovinStreamRequest): Promise<BitmovinStreamResponse>;
+    /**
+     * @summary Get Stream by id
+     * @param {string} streamId Id of the Stream.
+     * @throws {BitmovinError}
+     * @memberof StreamsApi
+     */
+    get(streamId: string): Promise<BitmovinStreamResponse>;
+    /**
+     * @summary Get paginated list of Streams
+     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
+     * @throws {BitmovinError}
+     * @memberof StreamsApi
+     */
+    list(queryParameters?: BitmovinStreamResponseListQueryParams | ((q: BitmovinStreamResponseListQueryParamsBuilder) => BitmovinStreamResponseListQueryParamsBuilder)): Promise<PaginationResponse<BitmovinStreamResponse>>;
+    /**
+     * @summary Update Stream by id
+     * @param {string} streamId Id of the Stream.
+     * @param {UpdateBitmovinStreamRequest} updateBitmovinStreamRequest Stream fields to update.
+     * @throws {BitmovinError}
+     * @memberof StreamsApi
+     */
+    patchBitmovinStreamsStreamsByStreamId(streamId: string, updateBitmovinStreamRequest?: UpdateBitmovinStreamRequest): Promise<BitmovinStreamResponse>;
+}

package/dist/streams/StreamsApi.js

@@ -0,0 +1,94 @@
+"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 BitmovinStreamResponse_1 = require("../models/BitmovinStreamResponse");
+var PaginationResponse_1 = require("../models/PaginationResponse");
+var BitmovinStreamResponseListQueryParams_1 = require("./BitmovinStreamResponseListQueryParams");
+/**
+ * StreamsApi - object-oriented interface
+ * @export
+ * @class StreamsApi
+ * @extends {BaseAPI}
+ */
+var StreamsApi = /** @class */ (function (_super) {
+    __extends(StreamsApi, _super);
+    function StreamsApi(configuration) {
+        return _super.call(this, configuration) || this;
+    }
+    /**
+     * @summary Create new Stream
+     * @param {CreateBitmovinStreamRequest} createBitmovinStreamRequest Create a new Stream.
+     * @throws {BitmovinError}
+     * @memberof StreamsApi
+     */
+    StreamsApi.prototype.create = function (createBitmovinStreamRequest) {
+        return this.restClient.post('/streams', {}, createBitmovinStreamRequest).then(function (response) {
+            return (0, Mapper_1.map)(response, BitmovinStreamResponse_1.default);
+        });
+    };
+    /**
+     * @summary Get Stream by id
+     * @param {string} streamId Id of the Stream.
+     * @throws {BitmovinError}
+     * @memberof StreamsApi
+     */
+    StreamsApi.prototype.get = function (streamId) {
+        var pathParamMap = {
+            stream_id: streamId
+        };
+        return this.restClient.get('/streams/{stream_id}', pathParamMap).then(function (response) {
+            return (0, Mapper_1.map)(response, BitmovinStreamResponse_1.default);
+        });
+    };
+    /**
+     * @summary Get paginated list of Streams
+     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
+     * @throws {BitmovinError}
+     * @memberof StreamsApi
+     */
+    StreamsApi.prototype.list = function (queryParameters) {
+        var queryParams = {};
+        if (typeof queryParameters === 'function') {
+            queryParams = queryParameters(new BitmovinStreamResponseListQueryParams_1.BitmovinStreamResponseListQueryParamsBuilder()).buildQueryParams();
+        }
+        else if (queryParameters) {
+            queryParams = queryParameters;
+        }
+        return this.restClient.get('/streams', {}, queryParams).then(function (response) {
+            return new PaginationResponse_1.default(response, BitmovinStreamResponse_1.default);
+        });
+    };
+    /**
+     * @summary Update Stream by id
+     * @param {string} streamId Id of the Stream.
+     * @param {UpdateBitmovinStreamRequest} updateBitmovinStreamRequest Stream fields to update.
+     * @throws {BitmovinError}
+     * @memberof StreamsApi
+     */
+    StreamsApi.prototype.patchBitmovinStreamsStreamsByStreamId = function (streamId, updateBitmovinStreamRequest) {
+        var pathParamMap = {
+            stream_id: streamId
+        };
+        return this.restClient.patch('/streams/{stream_id}', pathParamMap, updateBitmovinStreamRequest).then(function (response) {
+            return (0, Mapper_1.map)(response, BitmovinStreamResponse_1.default);
+        });
+    };
+    return StreamsApi;
+}(BaseAPI_1.BaseAPI));
+exports.default = StreamsApi;

package/package.json

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