@bitmovin/api-sdk 1.138.0 → 1.139.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. package/README.md +1 -1
  2. package/dist/BitmovinApi.d.ts +2 -2
  3. package/dist/BitmovinApi.js +2 -2
  4. package/dist/bitmovin-api-sdk.browser.js +351 -272
  5. package/dist/bitmovin-api-sdk.browser.min.js +1 -1
  6. package/dist/common/RestClient.js +1 -1
  7. package/dist/models/SimpleEncodingVodJobOutput.d.ts +7 -0
  8. package/dist/models/SimpleEncodingVodJobOutput.js +3 -0
  9. package/dist/models/SimpleEncodingVodJobOutputArtifact.d.ts +20 -0
  10. package/dist/models/SimpleEncodingVodJobOutputArtifact.js +20 -0
  11. package/dist/models/StreamsVideoCreateRequest.d.ts +26 -0
  12. package/dist/models/{CreateBitmovinStreamRequest.js → StreamsVideoCreateRequest.js} +7 -7
  13. package/dist/models/{BitmovinStreamEncodingStatus.d.ts → StreamsVideoEncodingStatus.d.ts} +2 -2
  14. package/dist/models/StreamsVideoEncodingStatus.js +14 -0
  15. package/dist/models/StreamsVideoEncodingTask.d.ts +22 -0
  16. package/dist/models/StreamsVideoEncodingTask.js +20 -0
  17. package/dist/models/{BitmovinStreamQuality.d.ts → StreamsVideoQuality.d.ts} +2 -2
  18. package/dist/models/StreamsVideoQuality.js +14 -0
  19. package/dist/models/StreamsVideoResponse.d.ts +52 -0
  20. package/dist/models/{BitmovinStreamResponse.js → StreamsVideoResponse.js} +9 -11
  21. package/dist/models/{BitmovinStreamStatus.d.ts → StreamsVideoStatus.d.ts} +2 -2
  22. package/dist/models/StreamsVideoStatus.js +13 -0
  23. package/dist/models/StreamsVideoUpdateRequest.d.ts +27 -0
  24. package/dist/models/{UpdateBitmovinStreamRequest.js → StreamsVideoUpdateRequest.js} +7 -7
  25. package/dist/models/index.d.ts +8 -7
  26. package/dist/models/index.js +8 -7
  27. package/dist/streams/StreamsApi.d.ts +2 -34
  28. package/dist/streams/StreamsApi.js +4 -63
  29. package/dist/streams/{BitmovinStreamResponseListQueryParams.d.ts → video/StreamsVideoResponseListQueryParams.d.ts} +6 -6
  30. package/dist/streams/{BitmovinStreamResponseListQueryParams.js → video/StreamsVideoResponseListQueryParams.js} +9 -9
  31. package/dist/streams/video/VideoApi.d.ts +45 -0
  32. package/dist/streams/video/VideoApi.js +94 -0
  33. package/package.json +1 -1
  34. package/dist/models/BitmovinStreamEncodingStatus.js +0 -14
  35. package/dist/models/BitmovinStreamEncodingTask.d.ts +0 -22
  36. package/dist/models/BitmovinStreamEncodingTask.js +0 -20
  37. package/dist/models/BitmovinStreamQuality.js +0 -14
  38. package/dist/models/BitmovinStreamResponse.d.ts +0 -65
  39. package/dist/models/BitmovinStreamStatus.js +0 -13
  40. package/dist/models/CreateBitmovinStreamRequest.d.ts +0 -26
  41. package/dist/models/UpdateBitmovinStreamRequest.d.ts +0 -27
@@ -1,24 +1,24 @@
1
- export interface BitmovinStreamResponseListQueryParams {
1
+ export interface StreamsVideoResponseListQueryParams {
2
2
  /**
3
3
  * Index of the first item to return, starting at 0. Default is 0
4
4
  * @type {number}
5
- * @memberof BitmovinStreamResponseListQueryParams
5
+ * @memberof StreamsVideoResponseListQueryParams
6
6
  */
7
7
  offset?: number | undefined;
8
8
  /**
9
9
  * Maximum number of items to return. Default is 25, maximum is 100
10
10
  * @type {number}
11
- * @memberof BitmovinStreamResponseListQueryParams
11
+ * @memberof StreamsVideoResponseListQueryParams
12
12
  */
13
13
  limit?: number | undefined;
14
14
  /**
15
15
  * Order list result according an resource attribute. The fields that can be used for sorting are: + `createdAt`
16
16
  * @type {string}
17
- * @memberof BitmovinStreamResponseListQueryParams
17
+ * @memberof StreamsVideoResponseListQueryParams
18
18
  */
19
19
  sort?: string | undefined;
20
20
  }
21
- export declare class BitmovinStreamResponseListQueryParamsBuilder {
21
+ export declare class StreamsVideoResponseListQueryParamsBuilder {
22
22
  private internalParams;
23
23
  /**
24
24
  *
@@ -35,5 +35,5 @@ export declare class BitmovinStreamResponseListQueryParamsBuilder {
35
35
  * @param sort Order list result according an resource attribute. The fields that can be used for sorting are: + `createdAt`
36
36
  */
37
37
  sort(sort: string): this;
38
- buildQueryParams(): BitmovinStreamResponseListQueryParams;
38
+ buildQueryParams(): StreamsVideoResponseListQueryParams;
39
39
  }
@@ -1,15 +1,15 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.BitmovinStreamResponseListQueryParamsBuilder = void 0;
4
- var BitmovinStreamResponseListQueryParamsBuilder = /** @class */ (function () {
5
- function BitmovinStreamResponseListQueryParamsBuilder() {
3
+ exports.StreamsVideoResponseListQueryParamsBuilder = void 0;
4
+ var StreamsVideoResponseListQueryParamsBuilder = /** @class */ (function () {
5
+ function StreamsVideoResponseListQueryParamsBuilder() {
6
6
  this.internalParams = {};
7
7
  }
8
8
  /**
9
9
  *
10
10
  * @param offset Index of the first item to return, starting at 0. Default is 0
11
11
  */
12
- BitmovinStreamResponseListQueryParamsBuilder.prototype.offset = function (offset) {
12
+ StreamsVideoResponseListQueryParamsBuilder.prototype.offset = function (offset) {
13
13
  this.internalParams.offset = offset;
14
14
  return this;
15
15
  };
@@ -17,7 +17,7 @@ var BitmovinStreamResponseListQueryParamsBuilder = /** @class */ (function () {
17
17
  *
18
18
  * @param limit Maximum number of items to return. Default is 25, maximum is 100
19
19
  */
20
- BitmovinStreamResponseListQueryParamsBuilder.prototype.limit = function (limit) {
20
+ StreamsVideoResponseListQueryParamsBuilder.prototype.limit = function (limit) {
21
21
  this.internalParams.limit = limit;
22
22
  return this;
23
23
  };
@@ -25,13 +25,13 @@ var BitmovinStreamResponseListQueryParamsBuilder = /** @class */ (function () {
25
25
  *
26
26
  * @param sort Order list result according an resource attribute. The fields that can be used for sorting are: + `createdAt`
27
27
  */
28
- BitmovinStreamResponseListQueryParamsBuilder.prototype.sort = function (sort) {
28
+ StreamsVideoResponseListQueryParamsBuilder.prototype.sort = function (sort) {
29
29
  this.internalParams.sort = sort;
30
30
  return this;
31
31
  };
32
- BitmovinStreamResponseListQueryParamsBuilder.prototype.buildQueryParams = function () {
32
+ StreamsVideoResponseListQueryParamsBuilder.prototype.buildQueryParams = function () {
33
33
  return this.internalParams;
34
34
  };
35
- return BitmovinStreamResponseListQueryParamsBuilder;
35
+ return StreamsVideoResponseListQueryParamsBuilder;
36
36
  }());
37
- exports.BitmovinStreamResponseListQueryParamsBuilder = BitmovinStreamResponseListQueryParamsBuilder;
37
+ exports.StreamsVideoResponseListQueryParamsBuilder = StreamsVideoResponseListQueryParamsBuilder;
@@ -0,0 +1,45 @@
1
+ import { BaseAPI } from '../../common/BaseAPI';
2
+ import Configuration from '../../common/Configuration';
3
+ import StreamsVideoCreateRequest from '../../models/StreamsVideoCreateRequest';
4
+ import StreamsVideoResponse from '../../models/StreamsVideoResponse';
5
+ import StreamsVideoUpdateRequest from '../../models/StreamsVideoUpdateRequest';
6
+ import PaginationResponse from '../../models/PaginationResponse';
7
+ import { StreamsVideoResponseListQueryParams, StreamsVideoResponseListQueryParamsBuilder } from './StreamsVideoResponseListQueryParams';
8
+ /**
9
+ * VideoApi - object-oriented interface
10
+ * @export
11
+ * @class VideoApi
12
+ * @extends {BaseAPI}
13
+ */
14
+ export default class VideoApi extends BaseAPI {
15
+ constructor(configuration: Configuration);
16
+ /**
17
+ * @summary Create new Stream
18
+ * @param {StreamsVideoCreateRequest} streamsVideoCreateRequest Create a new stream.
19
+ * @throws {BitmovinError}
20
+ * @memberof VideoApi
21
+ */
22
+ create(streamsVideoCreateRequest?: StreamsVideoCreateRequest): Promise<StreamsVideoResponse>;
23
+ /**
24
+ * @summary Get stream by id
25
+ * @param {string} streamId Id of the stream.
26
+ * @throws {BitmovinError}
27
+ * @memberof VideoApi
28
+ */
29
+ get(streamId: string): Promise<StreamsVideoResponse>;
30
+ /**
31
+ * @summary Get paginated list of streams
32
+ * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
33
+ * @throws {BitmovinError}
34
+ * @memberof VideoApi
35
+ */
36
+ list(queryParameters?: StreamsVideoResponseListQueryParams | ((q: StreamsVideoResponseListQueryParamsBuilder) => StreamsVideoResponseListQueryParamsBuilder)): Promise<PaginationResponse<StreamsVideoResponse>>;
37
+ /**
38
+ * @summary Update stream by id
39
+ * @param {string} streamId Id of the stream.
40
+ * @param {StreamsVideoUpdateRequest} streamsVideoUpdateRequest Stream fields to update.
41
+ * @throws {BitmovinError}
42
+ * @memberof VideoApi
43
+ */
44
+ patchStreamsVideo(streamId: string, streamsVideoUpdateRequest?: StreamsVideoUpdateRequest): Promise<StreamsVideoResponse>;
45
+ }
@@ -0,0 +1,94 @@
1
+ "use strict";
2
+ var __extends = (this && this.__extends) || (function () {
3
+ var extendStatics = function (d, b) {
4
+ extendStatics = Object.setPrototypeOf ||
5
+ ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
6
+ function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
7
+ return extendStatics(d, b);
8
+ };
9
+ return function (d, b) {
10
+ if (typeof b !== "function" && b !== null)
11
+ throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
12
+ extendStatics(d, b);
13
+ function __() { this.constructor = d; }
14
+ d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
15
+ };
16
+ })();
17
+ Object.defineProperty(exports, "__esModule", { value: true });
18
+ var BaseAPI_1 = require("../../common/BaseAPI");
19
+ var Mapper_1 = require("../../common/Mapper");
20
+ var StreamsVideoResponse_1 = require("../../models/StreamsVideoResponse");
21
+ var PaginationResponse_1 = require("../../models/PaginationResponse");
22
+ var StreamsVideoResponseListQueryParams_1 = require("./StreamsVideoResponseListQueryParams");
23
+ /**
24
+ * VideoApi - object-oriented interface
25
+ * @export
26
+ * @class VideoApi
27
+ * @extends {BaseAPI}
28
+ */
29
+ var VideoApi = /** @class */ (function (_super) {
30
+ __extends(VideoApi, _super);
31
+ function VideoApi(configuration) {
32
+ return _super.call(this, configuration) || this;
33
+ }
34
+ /**
35
+ * @summary Create new Stream
36
+ * @param {StreamsVideoCreateRequest} streamsVideoCreateRequest Create a new stream.
37
+ * @throws {BitmovinError}
38
+ * @memberof VideoApi
39
+ */
40
+ VideoApi.prototype.create = function (streamsVideoCreateRequest) {
41
+ return this.restClient.post('/streams/video', {}, streamsVideoCreateRequest).then(function (response) {
42
+ return (0, Mapper_1.map)(response, StreamsVideoResponse_1.default);
43
+ });
44
+ };
45
+ /**
46
+ * @summary Get stream by id
47
+ * @param {string} streamId Id of the stream.
48
+ * @throws {BitmovinError}
49
+ * @memberof VideoApi
50
+ */
51
+ VideoApi.prototype.get = function (streamId) {
52
+ var pathParamMap = {
53
+ stream_id: streamId
54
+ };
55
+ return this.restClient.get('/streams/video/{stream_id}', pathParamMap).then(function (response) {
56
+ return (0, Mapper_1.map)(response, StreamsVideoResponse_1.default);
57
+ });
58
+ };
59
+ /**
60
+ * @summary Get paginated list of streams
61
+ * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
62
+ * @throws {BitmovinError}
63
+ * @memberof VideoApi
64
+ */
65
+ VideoApi.prototype.list = function (queryParameters) {
66
+ var queryParams = {};
67
+ if (typeof queryParameters === 'function') {
68
+ queryParams = queryParameters(new StreamsVideoResponseListQueryParams_1.StreamsVideoResponseListQueryParamsBuilder()).buildQueryParams();
69
+ }
70
+ else if (queryParameters) {
71
+ queryParams = queryParameters;
72
+ }
73
+ return this.restClient.get('/streams/video', {}, queryParams).then(function (response) {
74
+ return new PaginationResponse_1.default(response, StreamsVideoResponse_1.default);
75
+ });
76
+ };
77
+ /**
78
+ * @summary Update stream by id
79
+ * @param {string} streamId Id of the stream.
80
+ * @param {StreamsVideoUpdateRequest} streamsVideoUpdateRequest Stream fields to update.
81
+ * @throws {BitmovinError}
82
+ * @memberof VideoApi
83
+ */
84
+ VideoApi.prototype.patchStreamsVideo = function (streamId, streamsVideoUpdateRequest) {
85
+ var pathParamMap = {
86
+ stream_id: streamId
87
+ };
88
+ return this.restClient.patch('/streams/video/{stream_id}', pathParamMap, streamsVideoUpdateRequest).then(function (response) {
89
+ return (0, Mapper_1.map)(response, StreamsVideoResponse_1.default);
90
+ });
91
+ };
92
+ return VideoApi;
93
+ }(BaseAPI_1.BaseAPI));
94
+ exports.default = VideoApi;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bitmovin/api-sdk",
3
- "version": "1.138.0",
3
+ "version": "1.139.0",
4
4
  "description": "Bitmovin JS/TS API SDK",
5
5
  "author": "Bitmovin Inc",
6
6
  "keywords": [
@@ -1,14 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.BitmovinStreamEncodingStatus = void 0;
4
- /**
5
- * @export
6
- * @enum {string}
7
- */
8
- var BitmovinStreamEncodingStatus;
9
- (function (BitmovinStreamEncodingStatus) {
10
- BitmovinStreamEncodingStatus["STARTED"] = "STARTED";
11
- BitmovinStreamEncodingStatus["ERROR"] = "ERROR";
12
- BitmovinStreamEncodingStatus["FINISHED"] = "FINISHED";
13
- })(BitmovinStreamEncodingStatus = exports.BitmovinStreamEncodingStatus || (exports.BitmovinStreamEncodingStatus = {}));
14
- exports.default = BitmovinStreamEncodingStatus;
@@ -1,22 +0,0 @@
1
- import BitmovinStreamEncodingStatus from './BitmovinStreamEncodingStatus';
2
- import BitmovinStreamQuality from './BitmovinStreamQuality';
3
- /**
4
- * @export
5
- * @class BitmovinStreamEncodingTask
6
- */
7
- export declare class BitmovinStreamEncodingTask {
8
- /**
9
- * Quality of the encoding
10
- * @type {BitmovinStreamQuality}
11
- * @memberof BitmovinStreamEncodingTask
12
- */
13
- quality?: BitmovinStreamQuality;
14
- /**
15
- * Current state of the encoding
16
- * @type {BitmovinStreamEncodingStatus}
17
- * @memberof BitmovinStreamEncodingTask
18
- */
19
- status?: BitmovinStreamEncodingStatus;
20
- constructor(obj?: Partial<BitmovinStreamEncodingTask>);
21
- }
22
- export default BitmovinStreamEncodingTask;
@@ -1,20 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.BitmovinStreamEncodingTask = void 0;
4
- var Mapper_1 = require("../common/Mapper");
5
- /**
6
- * @export
7
- * @class BitmovinStreamEncodingTask
8
- */
9
- var BitmovinStreamEncodingTask = /** @class */ (function () {
10
- function BitmovinStreamEncodingTask(obj) {
11
- if (!obj) {
12
- return;
13
- }
14
- this.quality = (0, Mapper_1.map)(obj.quality);
15
- this.status = (0, Mapper_1.map)(obj.status);
16
- }
17
- return BitmovinStreamEncodingTask;
18
- }());
19
- exports.BitmovinStreamEncodingTask = BitmovinStreamEncodingTask;
20
- exports.default = BitmovinStreamEncodingTask;
@@ -1,14 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.BitmovinStreamQuality = void 0;
4
- /**
5
- * @export
6
- * @enum {string}
7
- */
8
- var BitmovinStreamQuality;
9
- (function (BitmovinStreamQuality) {
10
- BitmovinStreamQuality["NONE"] = "NONE";
11
- BitmovinStreamQuality["PREVIEW"] = "PREVIEW";
12
- BitmovinStreamQuality["DEFAULT"] = "DEFAULT";
13
- })(BitmovinStreamQuality = exports.BitmovinStreamQuality || (exports.BitmovinStreamQuality = {}));
14
- exports.default = BitmovinStreamQuality;
@@ -1,65 +0,0 @@
1
- import BitmovinStreamEncodingTask from './BitmovinStreamEncodingTask';
2
- import BitmovinStreamQuality from './BitmovinStreamQuality';
3
- import BitmovinStreamStatus from './BitmovinStreamStatus';
4
- /**
5
- * @export
6
- * @class BitmovinStreamResponse
7
- */
8
- export declare class BitmovinStreamResponse {
9
- /**
10
- * The identifier of the Stream
11
- * @type {string}
12
- * @memberof BitmovinStreamResponse
13
- */
14
- id?: string;
15
- /**
16
- * The asset URL of the Stream
17
- * @type {string}
18
- * @memberof BitmovinStreamResponse
19
- */
20
- assetUrl?: string;
21
- /**
22
- * The title of the Stream
23
- * @type {string}
24
- * @memberof BitmovinStreamResponse
25
- */
26
- title?: string;
27
- /**
28
- * The description of the Stream
29
- * @type {string}
30
- * @memberof BitmovinStreamResponse
31
- */
32
- description?: string;
33
- /**
34
- * Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
35
- * @type {Date}
36
- * @memberof BitmovinStreamResponse
37
- */
38
- createdAt?: Date;
39
- /**
40
- * The status of the Stream
41
- * @type {BitmovinStreamStatus}
42
- * @memberof BitmovinStreamResponse
43
- */
44
- status?: BitmovinStreamStatus;
45
- /**
46
- * The target quality of the Stream (OBSOLETE!)
47
- * @type {BitmovinStreamQuality}
48
- * @memberof BitmovinStreamResponse
49
- */
50
- targetQuality?: BitmovinStreamQuality;
51
- /**
52
- * List of available stream qualities (OBSOLETE!)
53
- * @type {BitmovinStreamQuality[]}
54
- * @memberof BitmovinStreamResponse
55
- */
56
- availableQualities?: BitmovinStreamQuality[];
57
- /**
58
- * List of encoding status information
59
- * @type {BitmovinStreamEncodingTask[]}
60
- * @memberof BitmovinStreamResponse
61
- */
62
- encodingTasks?: BitmovinStreamEncodingTask[];
63
- constructor(obj?: Partial<BitmovinStreamResponse>);
64
- }
65
- export default BitmovinStreamResponse;
@@ -1,13 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.BitmovinStreamStatus = void 0;
4
- /**
5
- * @export
6
- * @enum {string}
7
- */
8
- var BitmovinStreamStatus;
9
- (function (BitmovinStreamStatus) {
10
- BitmovinStreamStatus["PUBLISHED"] = "PUBLISHED";
11
- BitmovinStreamStatus["UNPUBLISHED"] = "UNPUBLISHED";
12
- })(BitmovinStreamStatus = exports.BitmovinStreamStatus || (exports.BitmovinStreamStatus = {}));
13
- exports.default = BitmovinStreamStatus;
@@ -1,26 +0,0 @@
1
- /**
2
- * @export
3
- * @class CreateBitmovinStreamRequest
4
- */
5
- export declare class CreateBitmovinStreamRequest {
6
- /**
7
- * The Streams input asset URL
8
- * @type {string}
9
- * @memberof CreateBitmovinStreamRequest
10
- */
11
- assetUrl?: string;
12
- /**
13
- * Title of the Stream
14
- * @type {string}
15
- * @memberof CreateBitmovinStreamRequest
16
- */
17
- title?: string;
18
- /**
19
- * Description of the Stream
20
- * @type {string}
21
- * @memberof CreateBitmovinStreamRequest
22
- */
23
- description?: string;
24
- constructor(obj?: Partial<CreateBitmovinStreamRequest>);
25
- }
26
- export default CreateBitmovinStreamRequest;
@@ -1,27 +0,0 @@
1
- import BitmovinStreamStatus from './BitmovinStreamStatus';
2
- /**
3
- * @export
4
- * @class UpdateBitmovinStreamRequest
5
- */
6
- export declare class UpdateBitmovinStreamRequest {
7
- /**
8
- * The status of the Stream
9
- * @type {BitmovinStreamStatus}
10
- * @memberof UpdateBitmovinStreamRequest
11
- */
12
- status?: BitmovinStreamStatus;
13
- /**
14
- * Title of the Stream
15
- * @type {string}
16
- * @memberof UpdateBitmovinStreamRequest
17
- */
18
- title?: string;
19
- /**
20
- * Description of the Stream
21
- * @type {string}
22
- * @memberof UpdateBitmovinStreamRequest
23
- */
24
- description?: string;
25
- constructor(obj?: Partial<UpdateBitmovinStreamRequest>);
26
- }
27
- export default UpdateBitmovinStreamRequest;