@bitmovin/api-sdk 1.198.0 → 1.199.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.
@@ -240,7 +240,7 @@ var HeaderHandler = /** @class */ (function (_super) {
240
240
  var headers = {
241
241
  'X-Api-Key': apiKey,
242
242
  'X-Api-Client': 'bitmovin-api-sdk-javascript',
243
- 'X-Api-Client-Version': '1.198.0',
243
+ 'X-Api-Client-Version': '1.199.0',
244
244
  'Content-Type': 'application/json'
245
245
  };
246
246
  if (tenantOrgId) {
@@ -11,7 +11,6 @@ import InfrastructureApi from './infrastructure/InfrastructureApi';
11
11
  import StatisticsApi from './statistics/StatisticsApi';
12
12
  import WatchFoldersApi from './watchFolders/WatchFoldersApi';
13
13
  import SimpleApi from './simple/SimpleApi';
14
- import HistoryApi from './history/HistoryApi';
15
14
  import ErrorDefinitionsApi from './errorDefinitions/ErrorDefinitionsApi';
16
15
  /**
17
16
  * EncodingApi - object-oriented interface
@@ -31,7 +30,6 @@ export default class EncodingApi extends BaseAPI {
31
30
  statistics: StatisticsApi;
32
31
  watchFolders: WatchFoldersApi;
33
32
  simple: SimpleApi;
34
- history: HistoryApi;
35
33
  errorDefinitions: ErrorDefinitionsApi;
36
34
  constructor(configuration: Configuration);
37
35
  }
@@ -27,7 +27,6 @@ var InfrastructureApi_1 = require("./infrastructure/InfrastructureApi");
27
27
  var StatisticsApi_1 = require("./statistics/StatisticsApi");
28
28
  var WatchFoldersApi_1 = require("./watchFolders/WatchFoldersApi");
29
29
  var SimpleApi_1 = require("./simple/SimpleApi");
30
- var HistoryApi_1 = require("./history/HistoryApi");
31
30
  var ErrorDefinitionsApi_1 = require("./errorDefinitions/ErrorDefinitionsApi");
32
31
  /**
33
32
  * EncodingApi - object-oriented interface
@@ -50,7 +49,6 @@ var EncodingApi = /** @class */ (function (_super) {
50
49
  _this.statistics = new StatisticsApi_1.default(configuration);
51
50
  _this.watchFolders = new WatchFoldersApi_1.default(configuration);
52
51
  _this.simple = new SimpleApi_1.default(configuration);
53
- _this.history = new HistoryApi_1.default(configuration);
54
52
  _this.errorDefinitions = new ErrorDefinitionsApi_1.default(configuration);
55
53
  return _this;
56
54
  }
@@ -10,12 +10,6 @@ export declare class Keyframe extends BitmovinResource {
10
10
  * @memberof Keyframe
11
11
  */
12
12
  time?: number;
13
- /**
14
- * Instructs the encoder to cut the segment at this position
15
- * @type {boolean}
16
- * @memberof Keyframe
17
- */
18
- segmentCut?: boolean;
19
13
  constructor(obj?: Partial<Keyframe>);
20
14
  }
21
15
  export default Keyframe;
@@ -30,7 +30,6 @@ var Keyframe = /** @class */ (function (_super) {
30
30
  return _this;
31
31
  }
32
32
  _this.time = (0, Mapper_1.map)(obj.time);
33
- _this.segmentCut = (0, Mapper_1.map)(obj.segmentCut);
34
33
  return _this;
35
34
  }
36
35
  return Keyframe;
@@ -16,6 +16,12 @@ export declare class ResetLiveManifestTimeShift extends BitmovinResponse {
16
16
  * @memberof ResetLiveManifestTimeShift
17
17
  */
18
18
  manifestIds?: string[];
19
+ /**
20
+ * If set to true, the Progressive muxing start position will be shifted to the start of the first remaining segment after the removal. NOTE: This only works for Progressive MP4 muxings.
21
+ * @type {boolean}
22
+ * @memberof ResetLiveManifestTimeShift
23
+ */
24
+ shiftProgressiveMuxingStartPosition?: boolean;
19
25
  constructor(obj?: Partial<ResetLiveManifestTimeShift>);
20
26
  }
21
27
  export default ResetLiveManifestTimeShift;
@@ -31,6 +31,7 @@ var ResetLiveManifestTimeShift = /** @class */ (function (_super) {
31
31
  }
32
32
  _this.residualPeriodInSeconds = (0, Mapper_1.map)(obj.residualPeriodInSeconds);
33
33
  _this.manifestIds = (0, Mapper_1.mapArray)(obj.manifestIds);
34
+ _this.shiftProgressiveMuxingStartPosition = (0, Mapper_1.map)(obj.shiftProgressiveMuxingStartPosition);
34
35
  return _this;
35
36
  }
36
37
  return ResetLiveManifestTimeShift;
@@ -403,9 +403,6 @@ export * from './HeAacV1AudioConfiguration';
403
403
  export * from './HeAacV1Signaling';
404
404
  export * from './HeAacV2AudioConfiguration';
405
405
  export * from './HeAacV2Signaling';
406
- export * from './HistoryEncoding';
407
- export * from './HistoryMuxing';
408
- export * from './HistoryStream';
409
406
  export * from './HlsManifest';
410
407
  export * from './HlsManifestAdMarkerSettings';
411
408
  export * from './HlsManifestAdMarkerType';
@@ -419,9 +419,6 @@ __exportStar(require("./HeAacV1AudioConfiguration"), exports);
419
419
  __exportStar(require("./HeAacV1Signaling"), exports);
420
420
  __exportStar(require("./HeAacV2AudioConfiguration"), exports);
421
421
  __exportStar(require("./HeAacV2Signaling"), exports);
422
- __exportStar(require("./HistoryEncoding"), exports);
423
- __exportStar(require("./HistoryMuxing"), exports);
424
- __exportStar(require("./HistoryStream"), exports);
425
422
  __exportStar(require("./HlsManifest"), exports);
426
423
  __exportStar(require("./HlsManifestAdMarkerSettings"), exports);
427
424
  __exportStar(require("./HlsManifestAdMarkerType"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bitmovin/api-sdk",
3
- "version": "1.198.0",
3
+ "version": "1.199.0",
4
4
  "description": "Bitmovin JS/TS API SDK",
5
5
  "author": "Bitmovin Inc",
6
6
  "keywords": [
@@ -1,13 +0,0 @@
1
- import { BaseAPI } from '../../common/BaseAPI';
2
- import Configuration from '../../common/Configuration';
3
- import EncodingsApi from './encodings/EncodingsApi';
4
- /**
5
- * HistoryApi - object-oriented interface
6
- * @export
7
- * @class HistoryApi
8
- * @extends {BaseAPI}
9
- */
10
- export default class HistoryApi extends BaseAPI {
11
- encodings: EncodingsApi;
12
- constructor(configuration: Configuration);
13
- }
@@ -1,35 +0,0 @@
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 EncodingsApi_1 = require("./encodings/EncodingsApi");
20
- /**
21
- * HistoryApi - object-oriented interface
22
- * @export
23
- * @class HistoryApi
24
- * @extends {BaseAPI}
25
- */
26
- var HistoryApi = /** @class */ (function (_super) {
27
- __extends(HistoryApi, _super);
28
- function HistoryApi(configuration) {
29
- var _this = _super.call(this, configuration) || this;
30
- _this.encodings = new EncodingsApi_1.default(configuration);
31
- return _this;
32
- }
33
- return HistoryApi;
34
- }(BaseAPI_1.BaseAPI));
35
- exports.default = HistoryApi;
@@ -1,217 +0,0 @@
1
- import CloudRegion from '../../../models/CloudRegion';
2
- import EncodingMode from '../../../models/EncodingMode';
3
- export interface EncodingListQueryParams {
4
- /**
5
- * Index of the first item to return, starting at 0. Default is 0
6
- * @type {number}
7
- * @memberof EncodingListQueryParams
8
- */
9
- offset?: number | undefined;
10
- /**
11
- * Maximum number of items to return. Default is 25, maximum is 100
12
- * @type {number}
13
- * @memberof EncodingListQueryParams
14
- */
15
- limit?: number | undefined;
16
- /**
17
- * A boolean indicating whether the total count should be returned as well. Default is false
18
- * @type {boolean}
19
- * @memberof EncodingListQueryParams
20
- */
21
- includeTotalCount?: boolean | undefined;
22
- /**
23
- * Order list result according an encoding resource attribute. The fields that can be used for sorting are: + `id` + `startedAt` + `createdAt` + `modifiedAt` + `finishedAt` + `type` + `name` + `status` + `cloudRegion` + `encoderVersion`
24
- * @type {string}
25
- * @memberof EncodingListQueryParams
26
- */
27
- sort?: string | undefined;
28
- /**
29
- * Filter encodings to only show the ones with the type specified.
30
- * @type {string}
31
- * @memberof EncodingListQueryParams
32
- */
33
- type?: string | undefined;
34
- /**
35
- * Filter encodings to only show the ones with the status specified.
36
- * @type {string}
37
- * @memberof EncodingListQueryParams
38
- */
39
- status?: string | undefined;
40
- /**
41
- * Filter encodings to only show the ones with the cloudRegion specified.
42
- * @type {CloudRegion}
43
- * @memberof EncodingListQueryParams
44
- */
45
- cloudRegion?: CloudRegion | undefined;
46
- /**
47
- * Filter encodings to only show the ones with the selectedCloudRegion specified which was selected when cloudregion:AUTO was set
48
- * @type {CloudRegion}
49
- * @memberof EncodingListQueryParams
50
- */
51
- selectedCloudRegion?: CloudRegion | undefined;
52
- /**
53
- * Filter encodings to only show the ones with the encoderVersion specified.
54
- * @type {string}
55
- * @memberof EncodingListQueryParams
56
- */
57
- encoderVersion?: string | undefined;
58
- /**
59
- * Filter encodings to only show the ones with the encoderVersion specified that was actually used for the encoding.
60
- * @type {string}
61
- * @memberof EncodingListQueryParams
62
- */
63
- selectedEncoderVersion?: string | undefined;
64
- /**
65
- * Filter encodings to only show the ones with the encodingMode specified that was actually used for the encoding.
66
- * @type {EncodingMode}
67
- * @memberof EncodingListQueryParams
68
- */
69
- selectedEncodingMode?: EncodingMode | undefined;
70
- /**
71
- * Filter encodings to only show the ones with this exact name.
72
- * @type {string}
73
- * @memberof EncodingListQueryParams
74
- */
75
- name?: string | undefined;
76
- /**
77
- * The search query string for advanced filtering. We are using the [Apache Lucene](https://lucene.apache.org/) query syntax here. Only lucene queries equivalent to exact matching and startsWith are supported. Also only AND conjunctions supported at the moment. Please be aware that our filters are **case-insensitive** Examples of supported lucene queries: + `name:MyEncoding1` - This searches for encodings with names that are equal to `myencoding1` + `name:\"My Encoding\"` - This searches for encodings with names that are equal to `my encoding` + `name:MyEncoding\\*` - This searches for encodings with names that are equal to `myencoding*` Please have a look at the [Lucene Documentation - Escaping Special Characters](https://lucene.apache.org/core/8_1_1/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#Escaping_Special_Characters) section to see what characters have to be escaped. + `name:test*` - This searches for encodings with names that start with `test` + `name:test* AND labels:Customer1` - This searches for encodings with names starting with `test` and labels containing an entry that is equal to `customer1` Available search fields: + `name` + `labels` Please be aware to send these queries url encoded. If you provide fields or lucene queries that are not supported, it will result in an error response.
78
- * @type {string}
79
- * @memberof EncodingListQueryParams
80
- */
81
- search?: string | undefined;
82
- /**
83
- * Filter encodings to only return those created after this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
84
- * @type {Date}
85
- * @memberof EncodingListQueryParams
86
- */
87
- createdAtNewerThan?: Date | undefined;
88
- /**
89
- * Filter encodings to only return those created before this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
90
- * @type {Date}
91
- * @memberof EncodingListQueryParams
92
- */
93
- createdAtOlderThan?: Date | undefined;
94
- /**
95
- * Filter encodings to only return those started after this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
96
- * @type {Date}
97
- * @memberof EncodingListQueryParams
98
- */
99
- startedAtNewerThan?: Date | undefined;
100
- /**
101
- * Filter encodings to only return those started before this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
102
- * @type {Date}
103
- * @memberof EncodingListQueryParams
104
- */
105
- startedAtOlderThan?: Date | undefined;
106
- /**
107
- * Filter encodings to only return those finished at newer than this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Available for all encodings started after REST API Service release v1.50.0 (Changelogs for more information https://bitmovin.com/docs/encoding/changelogs/rest)
108
- * @type {Date}
109
- * @memberof EncodingListQueryParams
110
- */
111
- finishedAtNewerThan?: Date | undefined;
112
- /**
113
- * Filter encodings to only return those finished at older than this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Available for all encodings started after REST API Service release v1.50.0 (Changelogs for more information https://bitmovin.com/docs/encoding/changelogs/rest)
114
- * @type {Date}
115
- * @memberof EncodingListQueryParams
116
- */
117
- finishedAtOlderThan?: Date | undefined;
118
- }
119
- export declare class EncodingListQueryParamsBuilder {
120
- private internalParams;
121
- /**
122
- *
123
- * @param offset Index of the first item to return, starting at 0. Default is 0
124
- */
125
- offset(offset: number): this;
126
- /**
127
- *
128
- * @param limit Maximum number of items to return. Default is 25, maximum is 100
129
- */
130
- limit(limit: number): this;
131
- /**
132
- *
133
- * @param includeTotalCount A boolean indicating whether the total count should be returned as well. Default is false
134
- */
135
- includeTotalCount(includeTotalCount: boolean): this;
136
- /**
137
- *
138
- * @param sort Order list result according an encoding resource attribute. The fields that can be used for sorting are: + `id` + `startedAt` + `createdAt` + `modifiedAt` + `finishedAt` + `type` + `name` + `status` + `cloudRegion` + `encoderVersion`
139
- */
140
- sort(sort: string): this;
141
- /**
142
- *
143
- * @param type Filter encodings to only show the ones with the type specified.
144
- */
145
- type(type: string): this;
146
- /**
147
- *
148
- * @param status Filter encodings to only show the ones with the status specified.
149
- */
150
- status(status: string): this;
151
- /**
152
- *
153
- * @param cloudRegion Filter encodings to only show the ones with the cloudRegion specified.
154
- */
155
- cloudRegion(cloudRegion: CloudRegion): this;
156
- /**
157
- *
158
- * @param selectedCloudRegion Filter encodings to only show the ones with the selectedCloudRegion specified which was selected when cloudregion:AUTO was set
159
- */
160
- selectedCloudRegion(selectedCloudRegion: CloudRegion): this;
161
- /**
162
- *
163
- * @param encoderVersion Filter encodings to only show the ones with the encoderVersion specified.
164
- */
165
- encoderVersion(encoderVersion: string): this;
166
- /**
167
- *
168
- * @param selectedEncoderVersion Filter encodings to only show the ones with the encoderVersion specified that was actually used for the encoding.
169
- */
170
- selectedEncoderVersion(selectedEncoderVersion: string): this;
171
- /**
172
- *
173
- * @param selectedEncodingMode Filter encodings to only show the ones with the encodingMode specified that was actually used for the encoding.
174
- */
175
- selectedEncodingMode(selectedEncodingMode: EncodingMode): this;
176
- /**
177
- *
178
- * @param name Filter encodings to only show the ones with this exact name.
179
- */
180
- name(name: string): this;
181
- /**
182
- *
183
- * @param search The search query string for advanced filtering. We are using the [Apache Lucene](https://lucene.apache.org/) query syntax here. Only lucene queries equivalent to exact matching and startsWith are supported. Also only AND conjunctions supported at the moment. Please be aware that our filters are **case-insensitive** Examples of supported lucene queries: + `name:MyEncoding1` - This searches for encodings with names that are equal to `myencoding1` + `name:\"My Encoding\"` - This searches for encodings with names that are equal to `my encoding` + `name:MyEncoding\\*` - This searches for encodings with names that are equal to `myencoding*` Please have a look at the [Lucene Documentation - Escaping Special Characters](https://lucene.apache.org/core/8_1_1/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#Escaping_Special_Characters) section to see what characters have to be escaped. + `name:test*` - This searches for encodings with names that start with `test` + `name:test* AND labels:Customer1` - This searches for encodings with names starting with `test` and labels containing an entry that is equal to `customer1` Available search fields: + `name` + `labels` Please be aware to send these queries url encoded. If you provide fields or lucene queries that are not supported, it will result in an error response.
184
- */
185
- search(search: string): this;
186
- /**
187
- *
188
- * @param createdAtNewerThan Filter encodings to only return those created after this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
189
- */
190
- createdAtNewerThan(createdAtNewerThan: Date): this;
191
- /**
192
- *
193
- * @param createdAtOlderThan Filter encodings to only return those created before this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
194
- */
195
- createdAtOlderThan(createdAtOlderThan: Date): this;
196
- /**
197
- *
198
- * @param startedAtNewerThan Filter encodings to only return those started after this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
199
- */
200
- startedAtNewerThan(startedAtNewerThan: Date): this;
201
- /**
202
- *
203
- * @param startedAtOlderThan Filter encodings to only return those started before this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
204
- */
205
- startedAtOlderThan(startedAtOlderThan: Date): this;
206
- /**
207
- *
208
- * @param finishedAtNewerThan Filter encodings to only return those finished at newer than this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Available for all encodings started after REST API Service release v1.50.0 (Changelogs for more information https://bitmovin.com/docs/encoding/changelogs/rest)
209
- */
210
- finishedAtNewerThan(finishedAtNewerThan: Date): this;
211
- /**
212
- *
213
- * @param finishedAtOlderThan Filter encodings to only return those finished at older than this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Available for all encodings started after REST API Service release v1.50.0 (Changelogs for more information https://bitmovin.com/docs/encoding/changelogs/rest)
214
- */
215
- finishedAtOlderThan(finishedAtOlderThan: Date): this;
216
- buildQueryParams(): EncodingListQueryParams;
217
- }
@@ -1,165 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.EncodingListQueryParamsBuilder = void 0;
4
- var EncodingListQueryParamsBuilder = /** @class */ (function () {
5
- function EncodingListQueryParamsBuilder() {
6
- this.internalParams = {};
7
- }
8
- /**
9
- *
10
- * @param offset Index of the first item to return, starting at 0. Default is 0
11
- */
12
- EncodingListQueryParamsBuilder.prototype.offset = function (offset) {
13
- this.internalParams.offset = offset;
14
- return this;
15
- };
16
- /**
17
- *
18
- * @param limit Maximum number of items to return. Default is 25, maximum is 100
19
- */
20
- EncodingListQueryParamsBuilder.prototype.limit = function (limit) {
21
- this.internalParams.limit = limit;
22
- return this;
23
- };
24
- /**
25
- *
26
- * @param includeTotalCount A boolean indicating whether the total count should be returned as well. Default is false
27
- */
28
- EncodingListQueryParamsBuilder.prototype.includeTotalCount = function (includeTotalCount) {
29
- this.internalParams.includeTotalCount = includeTotalCount;
30
- return this;
31
- };
32
- /**
33
- *
34
- * @param sort Order list result according an encoding resource attribute. The fields that can be used for sorting are: + `id` + `startedAt` + `createdAt` + `modifiedAt` + `finishedAt` + `type` + `name` + `status` + `cloudRegion` + `encoderVersion`
35
- */
36
- EncodingListQueryParamsBuilder.prototype.sort = function (sort) {
37
- this.internalParams.sort = sort;
38
- return this;
39
- };
40
- /**
41
- *
42
- * @param type Filter encodings to only show the ones with the type specified.
43
- */
44
- EncodingListQueryParamsBuilder.prototype.type = function (type) {
45
- this.internalParams.type = type;
46
- return this;
47
- };
48
- /**
49
- *
50
- * @param status Filter encodings to only show the ones with the status specified.
51
- */
52
- EncodingListQueryParamsBuilder.prototype.status = function (status) {
53
- this.internalParams.status = status;
54
- return this;
55
- };
56
- /**
57
- *
58
- * @param cloudRegion Filter encodings to only show the ones with the cloudRegion specified.
59
- */
60
- EncodingListQueryParamsBuilder.prototype.cloudRegion = function (cloudRegion) {
61
- this.internalParams.cloudRegion = cloudRegion;
62
- return this;
63
- };
64
- /**
65
- *
66
- * @param selectedCloudRegion Filter encodings to only show the ones with the selectedCloudRegion specified which was selected when cloudregion:AUTO was set
67
- */
68
- EncodingListQueryParamsBuilder.prototype.selectedCloudRegion = function (selectedCloudRegion) {
69
- this.internalParams.selectedCloudRegion = selectedCloudRegion;
70
- return this;
71
- };
72
- /**
73
- *
74
- * @param encoderVersion Filter encodings to only show the ones with the encoderVersion specified.
75
- */
76
- EncodingListQueryParamsBuilder.prototype.encoderVersion = function (encoderVersion) {
77
- this.internalParams.encoderVersion = encoderVersion;
78
- return this;
79
- };
80
- /**
81
- *
82
- * @param selectedEncoderVersion Filter encodings to only show the ones with the encoderVersion specified that was actually used for the encoding.
83
- */
84
- EncodingListQueryParamsBuilder.prototype.selectedEncoderVersion = function (selectedEncoderVersion) {
85
- this.internalParams.selectedEncoderVersion = selectedEncoderVersion;
86
- return this;
87
- };
88
- /**
89
- *
90
- * @param selectedEncodingMode Filter encodings to only show the ones with the encodingMode specified that was actually used for the encoding.
91
- */
92
- EncodingListQueryParamsBuilder.prototype.selectedEncodingMode = function (selectedEncodingMode) {
93
- this.internalParams.selectedEncodingMode = selectedEncodingMode;
94
- return this;
95
- };
96
- /**
97
- *
98
- * @param name Filter encodings to only show the ones with this exact name.
99
- */
100
- EncodingListQueryParamsBuilder.prototype.name = function (name) {
101
- this.internalParams.name = name;
102
- return this;
103
- };
104
- /**
105
- *
106
- * @param search The search query string for advanced filtering. We are using the [Apache Lucene](https://lucene.apache.org/) query syntax here. Only lucene queries equivalent to exact matching and startsWith are supported. Also only AND conjunctions supported at the moment. Please be aware that our filters are **case-insensitive** Examples of supported lucene queries: + `name:MyEncoding1` - This searches for encodings with names that are equal to `myencoding1` + `name:\"My Encoding\"` - This searches for encodings with names that are equal to `my encoding` + `name:MyEncoding\\*` - This searches for encodings with names that are equal to `myencoding*` Please have a look at the [Lucene Documentation - Escaping Special Characters](https://lucene.apache.org/core/8_1_1/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#Escaping_Special_Characters) section to see what characters have to be escaped. + `name:test*` - This searches for encodings with names that start with `test` + `name:test* AND labels:Customer1` - This searches for encodings with names starting with `test` and labels containing an entry that is equal to `customer1` Available search fields: + `name` + `labels` Please be aware to send these queries url encoded. If you provide fields or lucene queries that are not supported, it will result in an error response.
107
- */
108
- EncodingListQueryParamsBuilder.prototype.search = function (search) {
109
- this.internalParams.search = search;
110
- return this;
111
- };
112
- /**
113
- *
114
- * @param createdAtNewerThan Filter encodings to only return those created after this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
115
- */
116
- EncodingListQueryParamsBuilder.prototype.createdAtNewerThan = function (createdAtNewerThan) {
117
- this.internalParams.createdAtNewerThan = createdAtNewerThan;
118
- return this;
119
- };
120
- /**
121
- *
122
- * @param createdAtOlderThan Filter encodings to only return those created before this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
123
- */
124
- EncodingListQueryParamsBuilder.prototype.createdAtOlderThan = function (createdAtOlderThan) {
125
- this.internalParams.createdAtOlderThan = createdAtOlderThan;
126
- return this;
127
- };
128
- /**
129
- *
130
- * @param startedAtNewerThan Filter encodings to only return those started after this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
131
- */
132
- EncodingListQueryParamsBuilder.prototype.startedAtNewerThan = function (startedAtNewerThan) {
133
- this.internalParams.startedAtNewerThan = startedAtNewerThan;
134
- return this;
135
- };
136
- /**
137
- *
138
- * @param startedAtOlderThan Filter encodings to only return those started before this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
139
- */
140
- EncodingListQueryParamsBuilder.prototype.startedAtOlderThan = function (startedAtOlderThan) {
141
- this.internalParams.startedAtOlderThan = startedAtOlderThan;
142
- return this;
143
- };
144
- /**
145
- *
146
- * @param finishedAtNewerThan Filter encodings to only return those finished at newer than this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Available for all encodings started after REST API Service release v1.50.0 (Changelogs for more information https://bitmovin.com/docs/encoding/changelogs/rest)
147
- */
148
- EncodingListQueryParamsBuilder.prototype.finishedAtNewerThan = function (finishedAtNewerThan) {
149
- this.internalParams.finishedAtNewerThan = finishedAtNewerThan;
150
- return this;
151
- };
152
- /**
153
- *
154
- * @param finishedAtOlderThan Filter encodings to only return those finished at older than this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Available for all encodings started after REST API Service release v1.50.0 (Changelogs for more information https://bitmovin.com/docs/encoding/changelogs/rest)
155
- */
156
- EncodingListQueryParamsBuilder.prototype.finishedAtOlderThan = function (finishedAtOlderThan) {
157
- this.internalParams.finishedAtOlderThan = finishedAtOlderThan;
158
- return this;
159
- };
160
- EncodingListQueryParamsBuilder.prototype.buildQueryParams = function () {
161
- return this.internalParams;
162
- };
163
- return EncodingListQueryParamsBuilder;
164
- }());
165
- exports.EncodingListQueryParamsBuilder = EncodingListQueryParamsBuilder;
@@ -1,29 +0,0 @@
1
- import { BaseAPI } from '../../../common/BaseAPI';
2
- import Configuration from '../../../common/Configuration';
3
- import Encoding from '../../../models/Encoding';
4
- import HistoryEncoding from '../../../models/HistoryEncoding';
5
- import PaginationResponse from '../../../models/PaginationResponse';
6
- import { EncodingListQueryParams, EncodingListQueryParamsBuilder } from './EncodingListQueryParams';
7
- /**
8
- * EncodingsApi - object-oriented interface
9
- * @export
10
- * @class EncodingsApi
11
- * @extends {BaseAPI}
12
- */
13
- export default class EncodingsApi extends BaseAPI {
14
- constructor(configuration: Configuration);
15
- /**
16
- * @summary (Experimental) History Encoding Details
17
- * @param {string} encodingId Id of the encoding.
18
- * @throws {BitmovinError}
19
- * @memberof EncodingsApi
20
- */
21
- get(encodingId: string): Promise<HistoryEncoding>;
22
- /**
23
- * @summary (Experimental) List all History Encodings
24
- * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
25
- * @throws {BitmovinError}
26
- * @memberof EncodingsApi
27
- */
28
- list(queryParameters?: EncodingListQueryParams | ((q: EncodingListQueryParamsBuilder) => EncodingListQueryParamsBuilder)): Promise<PaginationResponse<Encoding>>;
29
- }
@@ -1,69 +0,0 @@
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 Encoding_1 = require("../../../models/Encoding");
21
- var HistoryEncoding_1 = require("../../../models/HistoryEncoding");
22
- var PaginationResponse_1 = require("../../../models/PaginationResponse");
23
- var EncodingListQueryParams_1 = require("./EncodingListQueryParams");
24
- /**
25
- * EncodingsApi - object-oriented interface
26
- * @export
27
- * @class EncodingsApi
28
- * @extends {BaseAPI}
29
- */
30
- var EncodingsApi = /** @class */ (function (_super) {
31
- __extends(EncodingsApi, _super);
32
- function EncodingsApi(configuration) {
33
- return _super.call(this, configuration) || this;
34
- }
35
- /**
36
- * @summary (Experimental) History Encoding Details
37
- * @param {string} encodingId Id of the encoding.
38
- * @throws {BitmovinError}
39
- * @memberof EncodingsApi
40
- */
41
- EncodingsApi.prototype.get = function (encodingId) {
42
- var pathParamMap = {
43
- encoding_id: encodingId
44
- };
45
- return this.restClient.get('/encoding/history/encodings/{encoding_id}', pathParamMap).then(function (response) {
46
- return (0, Mapper_1.map)(response, HistoryEncoding_1.default);
47
- });
48
- };
49
- /**
50
- * @summary (Experimental) List all History Encodings
51
- * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
52
- * @throws {BitmovinError}
53
- * @memberof EncodingsApi
54
- */
55
- EncodingsApi.prototype.list = function (queryParameters) {
56
- var queryParams = {};
57
- if (typeof queryParameters === 'function') {
58
- queryParams = queryParameters(new EncodingListQueryParams_1.EncodingListQueryParamsBuilder()).buildQueryParams();
59
- }
60
- else if (queryParameters) {
61
- queryParams = queryParameters;
62
- }
63
- return this.restClient.get('/encoding/history/encodings', {}, queryParams).then(function (response) {
64
- return new PaginationResponse_1.default(response, Encoding_1.default);
65
- });
66
- };
67
- return EncodingsApi;
68
- }(BaseAPI_1.BaseAPI));
69
- exports.default = EncodingsApi;