@dolbyio/dolbyio-rest-apis-client 5.0.0 → 5.0.2

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.
package/dist/index.js CHANGED
@@ -36,4 +36,4 @@ function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e;
36
36
  // Expose the logger to control when/where to log
37
37
 
38
38
  /** Gets the version of this library. */
39
- var version = exports.version = "5.0.0";
39
+ var version = exports.version = "5.0.2";
@@ -1,6 +1,6 @@
1
1
  import { AccountGeoCascade, GeoRestrictions } from './types/account';
2
2
  /**
3
- * Gets account wide geo cascade settings.
3
+ * Gets the account geo cascading settings.
4
4
  * If a Publish Token does not define any geo cascade settings, the account wide settings are used.
5
5
  *
6
6
  * @link https://docs.dolby.io/streaming-apis/reference/account_getgeocascade
@@ -11,7 +11,7 @@ import { AccountGeoCascade, GeoRestrictions } from './types/account';
11
11
  */
12
12
  export declare const getGeoCascade: (apiSecret: string) => Promise<AccountGeoCascade>;
13
13
  /**
14
- * Update account wide geo cascade settings to enable/disable the feature or update the account default cluster list.
14
+ * Update account wide geo cascading settings to enable/disable the feature or update the account default cluster list.
15
15
  * `["all"]` could be used in place of cluster list to cascade stream to all existing and any future clusters available to the account.
16
16
  *
17
17
  * @link https://docs.dolby.io/streaming-apis/reference/account_updategeocascade
@@ -23,9 +23,9 @@ export declare const getGeoCascade: (apiSecret: string) => Promise<AccountGeoCas
23
23
  */
24
24
  export declare const updateGeoCascade: (apiSecret: string, settings: AccountGeoCascade) => Promise<AccountGeoCascade>;
25
25
  /**
26
- * Gets the account geo restrictions.
26
+ * Gets the account geo restriction rules.
27
27
  *
28
- * If a Token (either Publish or Subscribe) does not define any geo restrictions, the account wide rules are used.
28
+ * If a token (either Publish or Subscribe) does not define any geo restrictions, the account wide rules are used.
29
29
  *
30
30
  * @link https://docs.dolby.io/streaming-apis/reference/geo_geo
31
31
  *
@@ -35,13 +35,13 @@ export declare const updateGeoCascade: (apiSecret: string, settings: AccountGeoC
35
35
  */
36
36
  export declare const readGeoRestrictions: (apiSecret: string) => Promise<GeoRestrictions>;
37
37
  /**
38
- * Updates the account geo restrictions.
38
+ * Updates the account geo restriction rules.
39
39
  *
40
40
  * @link https://docs.dolby.io/streaming-apis/reference/geo_updategeo
41
41
  *
42
42
  * @param apiSecret The API Secret used to authenticate this request.
43
- * @param allowedCountries The list of allowed countries. An empty array [] removes all rules.
44
- * @param deniedCountries The list of denied countries. An empty array [] removes all rules.
43
+ * @param allowedCountries The list of allowed countries. An empty array `[]` removes all rules.
44
+ * @param deniedCountries The list of denied countries. An empty array `[]` removes all rules.
45
45
  *
46
46
  * @returns A {@link GeoRestrictions} object through a {@link Promise}.
47
47
  */
@@ -13,7 +13,7 @@ function _regeneratorRuntime() { "use strict"; /*! regenerator-runtime -- Copyri
13
13
  function asyncGeneratorStep(n, t, e, r, o, a, c) { try { var i = n[a](c), u = i.value; } catch (n) { return void e(n); } i.done ? t(u) : Promise.resolve(u).then(r, o); }
14
14
  function _asyncToGenerator(n) { return function () { var t = this, e = arguments; return new Promise(function (r, o) { var a = n.apply(t, e); function _next(n) { asyncGeneratorStep(a, r, o, _next, _throw, "next", n); } function _throw(n) { asyncGeneratorStep(a, r, o, _next, _throw, "throw", n); } _next(void 0); }); }; }
15
15
  /**
16
- * Gets account wide geo cascade settings.
16
+ * Gets the account geo cascading settings.
17
17
  * If a Publish Token does not define any geo cascade settings, the account wide settings are used.
18
18
  *
19
19
  * @link https://docs.dolby.io/streaming-apis/reference/account_getgeocascade
@@ -52,7 +52,7 @@ var getGeoCascade = exports.getGeoCascade = /*#__PURE__*/function () {
52
52
  }();
53
53
 
54
54
  /**
55
- * Update account wide geo cascade settings to enable/disable the feature or update the account default cluster list.
55
+ * Update account wide geo cascading settings to enable/disable the feature or update the account default cluster list.
56
56
  * `["all"]` could be used in place of cluster list to cascade stream to all existing and any future clusters available to the account.
57
57
  *
58
58
  * @link https://docs.dolby.io/streaming-apis/reference/account_updategeocascade
@@ -93,9 +93,9 @@ var updateGeoCascade = exports.updateGeoCascade = /*#__PURE__*/function () {
93
93
  }();
94
94
 
95
95
  /**
96
- * Gets the account geo restrictions.
96
+ * Gets the account geo restriction rules.
97
97
  *
98
- * If a Token (either Publish or Subscribe) does not define any geo restrictions, the account wide rules are used.
98
+ * If a token (either Publish or Subscribe) does not define any geo restrictions, the account wide rules are used.
99
99
  *
100
100
  * @link https://docs.dolby.io/streaming-apis/reference/geo_geo
101
101
  *
@@ -133,13 +133,13 @@ var readGeoRestrictions = exports.readGeoRestrictions = /*#__PURE__*/function ()
133
133
  }();
134
134
 
135
135
  /**
136
- * Updates the account geo restrictions.
136
+ * Updates the account geo restriction rules.
137
137
  *
138
138
  * @link https://docs.dolby.io/streaming-apis/reference/geo_updategeo
139
139
  *
140
140
  * @param apiSecret The API Secret used to authenticate this request.
141
- * @param allowedCountries The list of allowed countries. An empty array [] removes all rules.
142
- * @param deniedCountries The list of denied countries. An empty array [] removes all rules.
141
+ * @param allowedCountries The list of allowed countries. An empty array `[]` removes all rules.
142
+ * @param deniedCountries The list of denied countries. An empty array `[]` removes all rules.
143
143
  *
144
144
  * @returns A {@link GeoRestrictions} object through a {@link Promise}.
145
145
  */
@@ -4,7 +4,7 @@ import { ListTranscodersSortOptions, ListTranscodersInstancesSortOptions, ListTr
4
4
  *
5
5
  * @link https://docs.dolby.io/streaming-apis/reference/transcoder_listtranscoders
6
6
  * @beta
7
- * @remarks Cloud transcoder usage is not currently available for general usage.
7
+ * @remarks Cloud transcoder is not currently available for general usage.
8
8
  * If you would like to opt in, please contact our Sales team.
9
9
  *
10
10
  * @param apiSecret The API Secret used to authenticate this request.
@@ -18,7 +18,7 @@ export declare const listTranscoders: (apiSecret: string, options: ListTranscode
18
18
  *
19
19
  * @link https://docs.dolby.io/streaming-apis/reference/transcoder_gettranscoder
20
20
  * @beta
21
- * @remarks Cloud transcoder usage is not currently available for general usage.
21
+ * @remarks Cloud transcoder is not currently available for general usage.
22
22
  * If you would like to opt in, please contact our Sales team.
23
23
  *
24
24
  * @param apiSecret The API Secret used to authenticate this request.
@@ -32,7 +32,7 @@ export declare const getTranscoder: (apiSecret: string, transcoderId: string) =>
32
32
  *
33
33
  * @link https://docs.dolby.io/streaming-apis/reference/transcoder_deletetranscoder
34
34
  * @beta
35
- * @remarks Cloud transcoder usage is not currently available for general usage.
35
+ * @remarks Cloud transcoder is not currently available for general usage.
36
36
  * If you would like to opt in, please contact our Sales team.
37
37
  *
38
38
  * @param apiSecret The API Secret used to authenticate this request.
@@ -46,7 +46,7 @@ export declare const deleteTranscoder: (apiSecret: string, transcoderId: number)
46
46
  *
47
47
  * @link https://docs.dolby.io/streaming-apis/reference/transcoder_createtranscoder
48
48
  * @beta
49
- * @remarks Cloud transcoder usage is not currently available for general usage.
49
+ * @remarks Cloud transcoder is not currently available for general usage.
50
50
  * If you would like to opt in, please contact our Sales team.
51
51
  *
52
52
  * @param apiSecret The API Secret used to authenticate this request.
@@ -60,7 +60,7 @@ export declare const createTranscoder: (apiSecret: string, transcoder: CreateTra
60
60
  *
61
61
  * @link https://docs.dolby.io/streaming-apis/reference/transcoder_configuretranscoder
62
62
  * @beta
63
- * @remarks Cloud transcoder usage is not currently available for general usage.
63
+ * @remarks Cloud transcoder is not currently available for general usage.
64
64
  * If you would like to opt in, please contact our Sales team.
65
65
  *
66
66
  * @param apiSecret The API Secret used to authenticate this request.
@@ -75,7 +75,7 @@ export declare const updateTranscoder: (apiSecret: string, transcoderId: string,
75
75
  *
76
76
  * @link https://docs.dolby.io/streaming-apis/reference/transcoder_starttranscoder
77
77
  * @beta
78
- * @remarks Cloud transcoder usage is not currently available for general usage.
78
+ * @remarks Cloud transcoder is not currently available for general usage.
79
79
  * If you would like to opt in, please contact our Sales team.
80
80
  *
81
81
  * @param apiSecret The API Secret used to authenticate this request.
@@ -89,7 +89,7 @@ export declare const startTranscoder: (apiSecret: string, transcoderId: string)
89
89
  *
90
90
  * @link https://docs.dolby.io/streaming-apis/reference/transcoder_stoptranscoder
91
91
  * @beta
92
- * @remarks Cloud transcoder usage is not currently available for general usage.
92
+ * @remarks Cloud transcoder is not currently available for general usage.
93
93
  * If you would like to opt in, please contact our Sales team.
94
94
  *
95
95
  * @param apiSecret The API Secret used to authenticate this request.
@@ -104,7 +104,7 @@ export declare const stopTranscoder: (apiSecret: string, transcoderId: string) =
104
104
  *
105
105
  * @link https://docs.dolby.io/streaming-apis/reference/transcoder_listtranscoderinstances
106
106
  * @beta
107
- * @remarks Cloud transcoder usage is not currently available for general usage.
107
+ * @remarks Cloud transcoder is not currently available for general usage.
108
108
  * If you would like to opt in, please contact our Sales team
109
109
  *
110
110
  * @param apiSecret The API Secret used to authenticate this request.
@@ -118,7 +118,7 @@ export declare const listTranscoderInstances: (apiSecret: string, options: ListT
118
118
  *
119
119
  * @link https://docs.dolby.io/streaming-apis/reference/transcoder_gettranscoderinstance
120
120
  * @beta
121
- * @remarks Cloud transcoder usage is not currently available for general usage.
121
+ * @remarks Cloud transcoder is not currently available for general usage.
122
122
  * If you would like to opt in, please contact our Sales team.
123
123
  *
124
124
  * @param apiSecret The API Secret used to authenticate this request.
@@ -132,7 +132,7 @@ export declare const getTranscoderInstance: (apiSecret: string, transcoderInstan
132
132
  *
133
133
  * @link https://docs.dolby.io/streaming-apis/reference/transcoder_listtranscoderprofiles
134
134
  * @beta
135
- * @remarks Cloud transcoder usage is not currently available for general usage.
135
+ * @remarks Cloud transcoder is not currently available for general usage.
136
136
  * If you would like to opt in, please contact our Sales team.
137
137
  *
138
138
  * @param apiSecret The API Secret used to authenticate this request.
@@ -17,7 +17,7 @@ function _asyncToGenerator(n) { return function () { var t = this, e = arguments
17
17
  *
18
18
  * @link https://docs.dolby.io/streaming-apis/reference/transcoder_listtranscoders
19
19
  * @beta
20
- * @remarks Cloud transcoder usage is not currently available for general usage.
20
+ * @remarks Cloud transcoder is not currently available for general usage.
21
21
  * If you would like to opt in, please contact our Sales team.
22
22
  *
23
23
  * @param apiSecret The API Secret used to authenticate this request.
@@ -70,7 +70,7 @@ var listTranscoders = exports.listTranscoders = /*#__PURE__*/function () {
70
70
  *
71
71
  * @link https://docs.dolby.io/streaming-apis/reference/transcoder_gettranscoder
72
72
  * @beta
73
- * @remarks Cloud transcoder usage is not currently available for general usage.
73
+ * @remarks Cloud transcoder is not currently available for general usage.
74
74
  * If you would like to opt in, please contact our Sales team.
75
75
  *
76
76
  * @param apiSecret The API Secret used to authenticate this request.
@@ -112,7 +112,7 @@ var getTranscoder = exports.getTranscoder = /*#__PURE__*/function () {
112
112
  *
113
113
  * @link https://docs.dolby.io/streaming-apis/reference/transcoder_deletetranscoder
114
114
  * @beta
115
- * @remarks Cloud transcoder usage is not currently available for general usage.
115
+ * @remarks Cloud transcoder is not currently available for general usage.
116
116
  * If you would like to opt in, please contact our Sales team.
117
117
  *
118
118
  * @param apiSecret The API Secret used to authenticate this request.
@@ -154,7 +154,7 @@ var deleteTranscoder = exports.deleteTranscoder = /*#__PURE__*/function () {
154
154
  *
155
155
  * @link https://docs.dolby.io/streaming-apis/reference/transcoder_createtranscoder
156
156
  * @beta
157
- * @remarks Cloud transcoder usage is not currently available for general usage.
157
+ * @remarks Cloud transcoder is not currently available for general usage.
158
158
  * If you would like to opt in, please contact our Sales team.
159
159
  *
160
160
  * @param apiSecret The API Secret used to authenticate this request.
@@ -204,7 +204,7 @@ var createTranscoder = exports.createTranscoder = /*#__PURE__*/function () {
204
204
  *
205
205
  * @link https://docs.dolby.io/streaming-apis/reference/transcoder_configuretranscoder
206
206
  * @beta
207
- * @remarks Cloud transcoder usage is not currently available for general usage.
207
+ * @remarks Cloud transcoder is not currently available for general usage.
208
208
  * If you would like to opt in, please contact our Sales team.
209
209
  *
210
210
  * @param apiSecret The API Secret used to authenticate this request.
@@ -249,7 +249,7 @@ var updateTranscoder = exports.updateTranscoder = /*#__PURE__*/function () {
249
249
  *
250
250
  * @link https://docs.dolby.io/streaming-apis/reference/transcoder_starttranscoder
251
251
  * @beta
252
- * @remarks Cloud transcoder usage is not currently available for general usage.
252
+ * @remarks Cloud transcoder is not currently available for general usage.
253
253
  * If you would like to opt in, please contact our Sales team.
254
254
  *
255
255
  * @param apiSecret The API Secret used to authenticate this request.
@@ -291,7 +291,7 @@ var startTranscoder = exports.startTranscoder = /*#__PURE__*/function () {
291
291
  *
292
292
  * @link https://docs.dolby.io/streaming-apis/reference/transcoder_stoptranscoder
293
293
  * @beta
294
- * @remarks Cloud transcoder usage is not currently available for general usage.
294
+ * @remarks Cloud transcoder is not currently available for general usage.
295
295
  * If you would like to opt in, please contact our Sales team.
296
296
  *
297
297
  * @param apiSecret The API Secret used to authenticate this request.
@@ -334,7 +334,7 @@ var stopTranscoder = exports.stopTranscoder = /*#__PURE__*/function () {
334
334
  *
335
335
  * @link https://docs.dolby.io/streaming-apis/reference/transcoder_listtranscoderinstances
336
336
  * @beta
337
- * @remarks Cloud transcoder usage is not currently available for general usage.
337
+ * @remarks Cloud transcoder is not currently available for general usage.
338
338
  * If you would like to opt in, please contact our Sales team
339
339
  *
340
340
  * @param apiSecret The API Secret used to authenticate this request.
@@ -393,7 +393,7 @@ var listTranscoderInstances = exports.listTranscoderInstances = /*#__PURE__*/fun
393
393
  *
394
394
  * @link https://docs.dolby.io/streaming-apis/reference/transcoder_gettranscoderinstance
395
395
  * @beta
396
- * @remarks Cloud transcoder usage is not currently available for general usage.
396
+ * @remarks Cloud transcoder is not currently available for general usage.
397
397
  * If you would like to opt in, please contact our Sales team.
398
398
  *
399
399
  * @param apiSecret The API Secret used to authenticate this request.
@@ -435,7 +435,7 @@ var getTranscoderInstance = exports.getTranscoderInstance = /*#__PURE__*/functio
435
435
  *
436
436
  * @link https://docs.dolby.io/streaming-apis/reference/transcoder_listtranscoderprofiles
437
437
  * @beta
438
- * @remarks Cloud transcoder usage is not currently available for general usage.
438
+ * @remarks Cloud transcoder is not currently available for general usage.
439
439
  * If you would like to opt in, please contact our Sales team.
440
440
  *
441
441
  * @param apiSecret The API Secret used to authenticate this request.
@@ -3,11 +3,11 @@
3
3
  */
4
4
  export interface AccountGeoCascade {
5
5
  /**
6
- * Enable or Disable geo cascade.
6
+ * Enable or disable geo cascading.
7
7
  */
8
8
  isEnabled: boolean;
9
9
  /**
10
- * List of cluster IDs to geo cascade publish stream.
10
+ * List of cluster IDs to geo cascade a publish stream to.
11
11
  * This list cannot be empty when {@link isEnabled} is `true`.
12
12
  * This list is ignored when {@link isEnabled} is set to `false`.
13
13
  * @defaultValue Defaults to `["all"]` if unset.
@@ -15,7 +15,7 @@ export interface AccountGeoCascade {
15
15
  clusters?: string[];
16
16
  }
17
17
  /**
18
- * Represents the geo restrictions rules.
18
+ * Represents the geo restriction rules.
19
19
  */
20
20
  export interface GeoRestrictions {
21
21
  /** List of allowed countries. */
@@ -6,11 +6,11 @@ export interface Cluster {
6
6
  id: string;
7
7
  /** Display name of the cluster. */
8
8
  name: string;
9
- /** RTMP publish domain for cluster. */
9
+ /** RTMP publish domain for the cluster. */
10
10
  rtmp: string;
11
- /** SRT publish domain for cluster. */
11
+ /** SRT publish domain for the cluster. */
12
12
  srt: string;
13
- /** Location of this cluster. */
13
+ /** Location of the cluster. */
14
14
  location: {
15
15
  /** City of the cluster. */
16
16
  city: string;
@@ -19,13 +19,18 @@ export interface Cluster {
19
19
  /** Country of the cluster. */
20
20
  country: string;
21
21
  };
22
+ /** Features available in this cluster. */
23
+ features: {
24
+ /** Indicates whether the Transcoder feature is supported in the corresponding cluster. */
25
+ transcoding: boolean;
26
+ };
22
27
  }
23
28
  /**
24
29
  * Represents the response to a {@link read} or {@link update} request.
25
30
  */
26
31
  export interface ClusterResponse {
27
- /** Used as cluster when not explicitly specified during Token creation. */
32
+ /** Used as default cluster when not explicitly specified during Token creation. */
28
33
  defaultCluster: string;
29
- /** List of clusters available. */
34
+ /** List of available clusters. */
30
35
  availableClusters: Cluster[];
31
36
  }
@@ -31,22 +31,20 @@ export interface ListTranscodersProfilesSortOptions extends ListSortOptions<'Nam
31
31
  /** Represents a cloud transcoder. */
32
32
  export interface Transcoder {
33
33
  /** Identifier of the transcoder. */
34
- id: string;
35
- /** Millicast account identifier. */
36
- accountId: number;
34
+ transcoderId: string;
37
35
  /** Display name of the transcoder. */
38
36
  name: string;
39
37
  /** A string corresponding to the region that this transcoder is be deployed to. */
40
38
  cluster: string;
41
39
  /** DNS name of the transcoder. */
42
40
  dnsName: string;
43
- /** */
44
- profile: string;
41
+ /** Profile selected by user or derived from input height and frame rate. */
42
+ profile?: TranscoderProfile;
45
43
  /** Transcoder creation date. */
46
44
  createdOn: Date;
47
45
  /** Date when the transcoded was ended. */
48
46
  endedOn?: Date;
49
- /** */
47
+ /** Information on the most recent transcoder instance. */
50
48
  instance?: TranscoderInstance;
51
49
  /** Current status of the transcoder. */
52
50
  status: TranscoderStatus;
@@ -10,7 +10,7 @@ export interface Webhook {
10
10
  isFeedHooks: boolean;
11
11
  /** If `true` sends webhook events on recording `start/error/complete/deleted`. */
12
12
  isRecordingHooks: boolean;
13
- /** If `true` sends webhook events on transcoder instance updates. */
13
+ /** If `true` sends webhook events on thumbnail generation. */
14
14
  isThumbnailHooks: boolean;
15
15
  /** If `true` sends webhook events on transcoder instance updates. */
16
16
  isTranscoderHooks: boolean;
@@ -21,17 +21,17 @@ export interface Webhook {
21
21
  export interface UpdateWebhookRequest {
22
22
  /** Url to send webhook data to. */
23
23
  url?: string;
24
- /** If `true` will generate new signing secret for the webhook. */
24
+ /** Set to `true` to generate new signing secret for the webhook. */
25
25
  refreshSecret?: boolean;
26
- /** If `true` sends webhook events on feeds `start/stop`. */
26
+ /** Set to `true` to send webhook events on feeds `start/stop`. */
27
27
  isFeedHooks?: boolean;
28
- /** If `true` sends webhook events on recording `start/error/complete/deleted`. */
28
+ /** Set to `true` to send webhook events on recording `start/error/complete/deleted`. */
29
29
  isRecordingHooks?: boolean;
30
- /** If `true` sends webhook events on transcoder instance updates. */
30
+ /** Set to `true` to send webhook events on thumbnail generation. */
31
31
  isThumbnailHooks?: boolean;
32
- /** If `true` sends webhook events on transcoder instance updates. */
32
+ /** Set to `true` to send webhook events on transcoder instance updates. */
33
33
  isTranscoderHooks?: boolean;
34
- /** If `true` sends webhook events on clip `start/error/complete/deleted`. */
34
+ /** Set to `true` to send webhook events on clip `start/error/complete/deleted`. */
35
35
  isClipHooks?: boolean;
36
36
  }
37
37
  /** Represents a webhook listing request. */
@@ -47,22 +47,22 @@ export interface ListWebhooksRequest {
47
47
  export interface AddWebhookRequest {
48
48
  /** Url to send webhook data to. */
49
49
  url: string;
50
- /** If `true` sends webhook events on feeds `start/stop`. */
50
+ /** Set to `true` to send webhook events on feeds `start/stop`. */
51
51
  isFeedHooks: boolean;
52
- /** If `true` sends webhook events on recording `start/error/complete/deleted`. */
52
+ /** Set to `true` to send webhook events on recording `start/error/complete/deleted`. */
53
53
  isRecordingHooks: boolean;
54
54
  /**
55
- * If `true` sends webhook events on transcoder instance updates.
55
+ * Set to `true` to send webhook events on transcoder instance updates.
56
56
  * @defaultValue `false`.
57
57
  */
58
58
  isThumbnailHooks?: boolean;
59
59
  /**
60
- * If `true` sends webhook events on transcoder instance updates.
60
+ * Set to `true` to send webhook events on transcoder instance updates.
61
61
  * @defaultValue `false`.
62
62
  */
63
63
  isTranscoderHooks?: boolean;
64
64
  /**
65
- * If `true` sends webhook events on clip `start/error/complete/deleted`.
65
+ * Set to `true` to send webhook events on clip `start/error/complete/deleted`.
66
66
  * @defaultValue `false`.
67
67
  */
68
68
  isClipHooks?: boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dolbyio/dolbyio-rest-apis-client",
3
- "version": "5.0.0",
3
+ "version": "5.0.2",
4
4
  "description": "Node.JS wrapper for the Dolby.io REST APIs",
5
5
  "main": "dist/index.js",
6
6
  "scripts": {