@dolbyio/dolbyio-rest-apis-client 3.5.5 → 3.6.1

package/README.md

@@ -1,6 +1,6 @@
 [![Build Package](https://github.com/DolbyIO/dolbyio-rest-apis-client-node/actions/workflows/build-package.yml/badge.svg)](https://github.com/DolbyIO/dolbyio-rest-apis-client-node/actions/workflows/build-package.yml)
 [![Publish Package](https://github.com/DolbyIO/dolbyio-rest-apis-client-node/actions/workflows/publish-package.yml/badge.svg)](https://github.com/DolbyIO/dolbyio-rest-apis-client-node/actions/workflows/publish-package.yml)
-![npm](https://img.shields.io/npm/v/@dolbyio/dolbyio-rest-apis-client)
+[![npm](https://img.shields.io/npm/v/@dolbyio/dolbyio-rest-apis-client)](https://www.npmjs.com/package/@dolbyio/dolbyio-rest-apis-client)
 [![License](https://img.shields.io/github/license/DolbyIO/dolbyio-rest-apis-client-node)](LICENSE)
 
 # Dolby.io REST APIs Client for Node.JS
@@ -30,6 +30,20 @@ const jwt = await dolbyio.authentication.getApiAccessToken(APP_KEY, APP_SECRET);
 console.log(`Access Token: ${jwt.access_token}`);
 ```
 
+To request a particular scope for this access token:
+
+```javascript
+const dolbyio = require('@dolbyio/dolbyio-rest-apis-client');
+
+const APP_KEY = 'YOUR_APP_KEY';
+const APP_SECRET = 'YOUR_APP_SECRET';
+
+const jwt = await dolbyio.authentication.getApiAccessToken(APP_KEY, APP_SECRET, 3600, ['comms:client_access_token:create']);
+
+console.log(`Access Token: ${jwt.access_token}`);
+console.log(`Scope: ${jwt.scope}`);
+```
+
 ## Communications Examples
 
 ### Authenticate
@@ -42,9 +56,16 @@ const dolbyio = require('@dolbyio/dolbyio-rest-apis-client');
 const APP_KEY = 'YOUR_APP_KEY';
 const APP_SECRET = 'YOUR_APP_SECRET';
 
-const at = await dolbyio.communications.authentication.getClientAccessToken(APP_KEY, APP_SECRET);
+// Request an API Token
+const api_token = await dolbyio.authentication.getApiAccessToken(APP_KEY, APP_SECRET, 3600, ['comms:client_access_token:create']);
 
-console.log(`Access Token: ${at.access_token}`);
+// Request the Client Access Token
+const cat = await dolbyio.communications.authentication.getClientAccessTokenV2({
+    accessToken: api_token,
+    sessionScope: ['*'],
+});
+
+console.log(`Client Access Token: ${cat.access_token}`);
 ```
 
 ### Create a conference
@@ -71,8 +92,8 @@ const options = {
     ],
 };
 
-// Request an Access Token
-const jwt = await dolbyio.authentication.getApiAccessToken(APP_KEY, APP_SECRET);
+// Request an API Token
+const jwt = await dolbyio.authentication.getApiAccessToken(APP_KEY, APP_SECRET, 3600, ['comms:conf:create']);
 
 // Create the conference
 const conference = await dolbyio.communications.conference.createConference(jwt, options);
@@ -193,7 +214,7 @@ At this stage, the file has been processed and written to the temporary storage
 // Local path where to download the file to
 const enhancedFilePath = '/path/to/enhanced_file.mp4';
 
-await dolbyio.io.downloadFile(jwt, outputUrl, enhancedFilePath);
+await dolbyio.media.io.downloadFile(jwt, outputUrl, enhancedFilePath);
 ```
 
 ## Build this project

package/dist/authentication.d.ts

@@ -9,8 +9,21 @@ import JwtToken from './types/jwtToken';
  *
  * @param appKey Your Dolby.io App Key.
  * @param appSecret Your Dolby.io App Secret.
- * @param expiresIn API token expiration time in seconds. The maximum value is 86,400, indicating 24 hours. If no value is specified, the default is 1800, indicating 30 minutes.
+ * @param expiresIn API token expiration time in seconds. If no value is specified, the default is 1800, indicating 30 minutes. The maximum value is 86,400, indicating 24 hours.
+ * @param scope A list of case-sensitive strings allowing you to control what scope of access the API token should have. If not specified, the API token will possess unrestricted access to all resources and actions. The API supports the following scopes:
+ * * `comms:client_access_token:create`: Allows requesting a client access token.
+ * * `comms:conf:create`: Allows creating a new conference.
+ * * `comms:conf:admin`: Allows administrating a conference, including actions such as Invite, Kick, Send Message, Set Spatial Listener's Audio, and Update Permissions.
+ * * `comms:conf:destroy`: Allows terminating a live conference.
+ * * `comms:monitor:delete`: Allows deleting data from the Monitor API, for example, deleting recordings.
+ * * `comms:monitor:read`: Allows reading data through the Monitor API.
+ * * `comms:monitor:download`: Allows generating download URLs for data (e.g. recording) through the Monitor API.
+ * * `comms:stream:write`: Allows starting and stopping RTMP or Real-Time streaming.
+ * * `comms:remix:write`: Allows remixing recordings.
+ * * `comms:remix:read`: Allows reading the remix status.
+ * * `comms:record:write`: Allows starting and stopping recordings.
+ * Incorrect values are omitted. If you want to give the token access to all Communications REST APIs, you can use a wildcard, such as comms:*
  *
  * @returns A {@link JwtToken} object through a {@link Promise}.
  */
-export declare const getApiAccessToken: (appKey: string, appSecret: string, expiresIn?: number) => Promise<JwtToken>;
+export declare const getApiAccessToken: (appKey: string, appSecret: string, expiresIn?: number, scope?: string[]) => Promise<JwtToken>;

package/dist/authentication.js

@@ -20,19 +20,37 @@ function _asyncToGenerator(fn) { return function () { var self = this, args = ar
  *
  * @param appKey Your Dolby.io App Key.
  * @param appSecret Your Dolby.io App Secret.
- * @param expiresIn API token expiration time in seconds. The maximum value is 86,400, indicating 24 hours. If no value is specified, the default is 1800, indicating 30 minutes.
+ * @param expiresIn API token expiration time in seconds. If no value is specified, the default is 1800, indicating 30 minutes. The maximum value is 86,400, indicating 24 hours.
+ * @param scope A list of case-sensitive strings allowing you to control what scope of access the API token should have. If not specified, the API token will possess unrestricted access to all resources and actions. The API supports the following scopes:
+ * * `comms:client_access_token:create`: Allows requesting a client access token.
+ * * `comms:conf:create`: Allows creating a new conference.
+ * * `comms:conf:admin`: Allows administrating a conference, including actions such as Invite, Kick, Send Message, Set Spatial Listener's Audio, and Update Permissions.
+ * * `comms:conf:destroy`: Allows terminating a live conference.
+ * * `comms:monitor:delete`: Allows deleting data from the Monitor API, for example, deleting recordings.
+ * * `comms:monitor:read`: Allows reading data through the Monitor API.
+ * * `comms:monitor:download`: Allows generating download URLs for data (e.g. recording) through the Monitor API.
+ * * `comms:stream:write`: Allows starting and stopping RTMP or Real-Time streaming.
+ * * `comms:remix:write`: Allows remixing recordings.
+ * * `comms:remix:read`: Allows reading the remix status.
+ * * `comms:record:write`: Allows starting and stopping recordings.
+ * Incorrect values are omitted. If you want to give the token access to all Communications REST APIs, you can use a wildcard, such as comms:*
  *
  * @returns A {@link JwtToken} object through a {@link Promise}.
  */
 var getApiAccessToken = /*#__PURE__*/function () {
-  var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(appKey, appSecret, expiresIn) {
+  var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(appKey, appSecret, expiresIn, scope) {
     var body, authz, options, response;
     return _regeneratorRuntime().wrap(function _callee$(_context) {
       while (1) switch (_context.prev = _context.next) {
         case 0:
-          body = 'grant_type=client_credentials';
+          body = new URLSearchParams({
+            grant_type: 'client_credentials'
+          });
           if (expiresIn) {
-            body += "&expires_in=".concat(expiresIn);
+            body.append('expires_in', expiresIn.toFixed(0));
+          }
+          if (scope !== null && scope !== void 0 && scope.length) {
+            body.append('scope', scope.join(' '));
           }
           authz = Buffer.from("".concat(appKey, ":").concat(appSecret)).toString('base64');
           options = {
@@ -43,20 +61,20 @@ var getApiAccessToken = /*#__PURE__*/function () {
               'Cache-Control': 'no-cache',
               Authorization: "Basic ".concat(authz)
             },
-            body: body
+            body: body.toString()
           };
-          _context.next = 6;
+          _context.next = 7;
           return (0, _httpHelpers.sendPost)(options);
-        case 6:
+        case 7:
           response = _context.sent;
           return _context.abrupt("return", response);
-        case 8:
+        case 9:
         case "end":
           return _context.stop();
       }
     }, _callee);
   }));
-  return function getApiAccessToken(_x, _x2, _x3) {
+  return function getApiAccessToken(_x, _x2, _x3, _x4) {
     return _ref.apply(this, arguments);
   };
 }();

package/dist/communications/authentication.d.ts

@@ -1,13 +1,28 @@
 import JwtToken from '../types/jwtToken';
+import { GetClientAccessTokenOptions } from './types/authentication';
 /**
  * Gets a client access token to authenticate a session.
  *
- * @link https://docs.dolby.io/communications-apis/reference/get-client-access-token
+ * @link https://docs.dolby.io/communications-apis/reference/get-client-access-token-v1
  *
  * @param appKey Your Dolby.io App Key.
  * @param appSecret Your Dolby.io App Secret.
- * @param expiresIn Access token expiration time in seconds. The maximum value is 2,592,000, indicating 30 days. If no value is specified, the default is 3,600, indicating one hour.
+ * @param expiresIn Access token expiration time in seconds. If no value is specified, the default is 3,600, indicating one hour. The maximum value is 86,400, indicating 24 hours.
  *
  * @returns A {@link JwtToken} object through a {@link Promise}.
+ *
+ * @deprecated This function is now deprecated and will be removed in the next release of this SDK. Please start using {@link getClientAccessTokenV2} instead.
  */
 export declare const getClientAccessToken: (appKey: string, appSecret: string, expiresIn?: number) => Promise<JwtToken>;
+/**
+ * Generates a client access token.
+ *
+ * This API returns a client access token that your backend can request on behalf of a client to initialize the Dolby.io SDK in a secure way.
+ *
+ * @link https://docs.dolby.io/communications-apis/reference/get-client-access-token
+ *
+ * @param options Options to generate a client access token.
+ *
+ * @returns A {@link JwtToken} object through a {@link Promise}.
+ */
+export declare const getClientAccessTokenV2: (options: GetClientAccessTokenOptions) => Promise<JwtToken>;

package/dist/communications/authentication.js

@@ -4,7 +4,7 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getClientAccessToken = void 0;
+exports.getClientAccessTokenV2 = exports.getClientAccessToken = void 0;
 var _httpHelpers = require("../internal/httpHelpers");
 var _urls = require("./internal/urls");
 function _regeneratorRuntime() { "use strict"; /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */ _regeneratorRuntime = function _regeneratorRuntime() { return exports; }; var exports = {}, Op = Object.prototype, hasOwn = Op.hasOwnProperty, defineProperty = Object.defineProperty || function (obj, key, desc) { obj[key] = desc.value; }, $Symbol = "function" == typeof Symbol ? Symbol : {}, iteratorSymbol = $Symbol.iterator || "@@iterator", asyncIteratorSymbol = $Symbol.asyncIterator || "@@asyncIterator", toStringTagSymbol = $Symbol.toStringTag || "@@toStringTag"; function define(obj, key, value) { return Object.defineProperty(obj, key, { value: value, enumerable: !0, configurable: !0, writable: !0 }), obj[key]; } try { define({}, ""); } catch (err) { define = function define(obj, key, value) { return obj[key] = value; }; } function wrap(innerFn, outerFn, self, tryLocsList) { var protoGenerator = outerFn && outerFn.prototype instanceof Generator ? outerFn : Generator, generator = Object.create(protoGenerator.prototype), context = new Context(tryLocsList || []); return defineProperty(generator, "_invoke", { value: makeInvokeMethod(innerFn, self, context) }), generator; } function tryCatch(fn, obj, arg) { try { return { type: "normal", arg: fn.call(obj, arg) }; } catch (err) { return { type: "throw", arg: err }; } } exports.wrap = wrap; var ContinueSentinel = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} var IteratorPrototype = {}; define(IteratorPrototype, iteratorSymbol, function () { return this; }); var getProto = Object.getPrototypeOf, NativeIteratorPrototype = getProto && getProto(getProto(values([]))); NativeIteratorPrototype && NativeIteratorPrototype !== Op && hasOwn.call(NativeIteratorPrototype, iteratorSymbol) && (IteratorPrototype = NativeIteratorPrototype); var Gp = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(IteratorPrototype); function defineIteratorMethods(prototype) { ["next", "throw", "return"].forEach(function (method) { define(prototype, method, function (arg) { return this._invoke(method, arg); }); }); } function AsyncIterator(generator, PromiseImpl) { function invoke(method, arg, resolve, reject) { var record = tryCatch(generator[method], generator, arg); if ("throw" !== record.type) { var result = record.arg, value = result.value; return value && "object" == _typeof(value) && hasOwn.call(value, "__await") ? PromiseImpl.resolve(value.__await).then(function (value) { invoke("next", value, resolve, reject); }, function (err) { invoke("throw", err, resolve, reject); }) : PromiseImpl.resolve(value).then(function (unwrapped) { result.value = unwrapped, resolve(result); }, function (error) { return invoke("throw", error, resolve, reject); }); } reject(record.arg); } var previousPromise; defineProperty(this, "_invoke", { value: function value(method, arg) { function callInvokeWithMethodAndArg() { return new PromiseImpl(function (resolve, reject) { invoke(method, arg, resolve, reject); }); } return previousPromise = previousPromise ? previousPromise.then(callInvokeWithMethodAndArg, callInvokeWithMethodAndArg) : callInvokeWithMethodAndArg(); } }); } function makeInvokeMethod(innerFn, self, context) { var state = "suspendedStart"; return function (method, arg) { if ("executing" === state) throw new Error("Generator is already running"); if ("completed" === state) { if ("throw" === method) throw arg; return doneResult(); } for (context.method = method, context.arg = arg;;) { var delegate = context.delegate; if (delegate) { var delegateResult = maybeInvokeDelegate(delegate, context); if (delegateResult) { if (delegateResult === ContinueSentinel) continue; return delegateResult; } } if ("next" === context.method) context.sent = context._sent = context.arg;else if ("throw" === context.method) { if ("suspendedStart" === state) throw state = "completed", context.arg; context.dispatchException(context.arg); } else "return" === context.method && context.abrupt("return", context.arg); state = "executing"; var record = tryCatch(innerFn, self, context); if ("normal" === record.type) { if (state = context.done ? "completed" : "suspendedYield", record.arg === ContinueSentinel) continue; return { value: record.arg, done: context.done }; } "throw" === record.type && (state = "completed", context.method = "throw", context.arg = record.arg); } }; } function maybeInvokeDelegate(delegate, context) { var methodName = context.method, method = delegate.iterator[methodName]; if (undefined === method) return context.delegate = null, "throw" === methodName && delegate.iterator["return"] && (context.method = "return", context.arg = undefined, maybeInvokeDelegate(delegate, context), "throw" === context.method) || "return" !== methodName && (context.method = "throw", context.arg = new TypeError("The iterator does not provide a '" + methodName + "' method")), ContinueSentinel; var record = tryCatch(method, delegate.iterator, context.arg); if ("throw" === record.type) return context.method = "throw", context.arg = record.arg, context.delegate = null, ContinueSentinel; var info = record.arg; return info ? info.done ? (context[delegate.resultName] = info.value, context.next = delegate.nextLoc, "return" !== context.method && (context.method = "next", context.arg = undefined), context.delegate = null, ContinueSentinel) : info : (context.method = "throw", context.arg = new TypeError("iterator result is not an object"), context.delegate = null, ContinueSentinel); } function pushTryEntry(locs) { var entry = { tryLoc: locs[0] }; 1 in locs && (entry.catchLoc = locs[1]), 2 in locs && (entry.finallyLoc = locs[2], entry.afterLoc = locs[3]), this.tryEntries.push(entry); } function resetTryEntry(entry) { var record = entry.completion || {}; record.type = "normal", delete record.arg, entry.completion = record; } function Context(tryLocsList) { this.tryEntries = [{ tryLoc: "root" }], tryLocsList.forEach(pushTryEntry, this), this.reset(!0); } function values(iterable) { if (iterable) { var iteratorMethod = iterable[iteratorSymbol]; if (iteratorMethod) return iteratorMethod.call(iterable); if ("function" == typeof iterable.next) return iterable; if (!isNaN(iterable.length)) { var i = -1, next = function next() { for (; ++i < iterable.length;) if (hasOwn.call(iterable, i)) return next.value = iterable[i], next.done = !1, next; return next.value = undefined, next.done = !0, next; }; return next.next = next; } } return { next: doneResult }; } function doneResult() { return { value: undefined, done: !0 }; } return GeneratorFunction.prototype = GeneratorFunctionPrototype, defineProperty(Gp, "constructor", { value: GeneratorFunctionPrototype, configurable: !0 }), defineProperty(GeneratorFunctionPrototype, "constructor", { value: GeneratorFunction, configurable: !0 }), GeneratorFunction.displayName = define(GeneratorFunctionPrototype, toStringTagSymbol, "GeneratorFunction"), exports.isGeneratorFunction = function (genFun) { var ctor = "function" == typeof genFun && genFun.constructor; return !!ctor && (ctor === GeneratorFunction || "GeneratorFunction" === (ctor.displayName || ctor.name)); }, exports.mark = function (genFun) { return Object.setPrototypeOf ? Object.setPrototypeOf(genFun, GeneratorFunctionPrototype) : (genFun.__proto__ = GeneratorFunctionPrototype, define(genFun, toStringTagSymbol, "GeneratorFunction")), genFun.prototype = Object.create(Gp), genFun; }, exports.awrap = function (arg) { return { __await: arg }; }, defineIteratorMethods(AsyncIterator.prototype), define(AsyncIterator.prototype, asyncIteratorSymbol, function () { return this; }), exports.AsyncIterator = AsyncIterator, exports.async = function (innerFn, outerFn, self, tryLocsList, PromiseImpl) { void 0 === PromiseImpl && (PromiseImpl = Promise); var iter = new AsyncIterator(wrap(innerFn, outerFn, self, tryLocsList), PromiseImpl); return exports.isGeneratorFunction(outerFn) ? iter : iter.next().then(function (result) { return result.done ? result.value : iter.next(); }); }, defineIteratorMethods(Gp), define(Gp, toStringTagSymbol, "Generator"), define(Gp, iteratorSymbol, function () { return this; }), define(Gp, "toString", function () { return "[object Generator]"; }), exports.keys = function (val) { var object = Object(val), keys = []; for (var key in object) keys.push(key); return keys.reverse(), function next() { for (; keys.length;) { var key = keys.pop(); if (key in object) return next.value = key, next.done = !1, next; } return next.done = !0, next; }; }, exports.values = values, Context.prototype = { constructor: Context, reset: function reset(skipTempReset) { if (this.prev = 0, this.next = 0, this.sent = this._sent = undefined, this.done = !1, this.delegate = null, this.method = "next", this.arg = undefined, this.tryEntries.forEach(resetTryEntry), !skipTempReset) for (var name in this) "t" === name.charAt(0) && hasOwn.call(this, name) && !isNaN(+name.slice(1)) && (this[name] = undefined); }, stop: function stop() { this.done = !0; var rootRecord = this.tryEntries[0].completion; if ("throw" === rootRecord.type) throw rootRecord.arg; return this.rval; }, dispatchException: function dispatchException(exception) { if (this.done) throw exception; var context = this; function handle(loc, caught) { return record.type = "throw", record.arg = exception, context.next = loc, caught && (context.method = "next", context.arg = undefined), !!caught; } for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i], record = entry.completion; if ("root" === entry.tryLoc) return handle("end"); if (entry.tryLoc <= this.prev) { var hasCatch = hasOwn.call(entry, "catchLoc"), hasFinally = hasOwn.call(entry, "finallyLoc"); if (hasCatch && hasFinally) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } else if (hasCatch) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); } else { if (!hasFinally) throw new Error("try statement without catch or finally"); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } } } }, abrupt: function abrupt(type, arg) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc <= this.prev && hasOwn.call(entry, "finallyLoc") && this.prev < entry.finallyLoc) { var finallyEntry = entry; break; } } finallyEntry && ("break" === type || "continue" === type) && finallyEntry.tryLoc <= arg && arg <= finallyEntry.finallyLoc && (finallyEntry = null); var record = finallyEntry ? finallyEntry.completion : {}; return record.type = type, record.arg = arg, finallyEntry ? (this.method = "next", this.next = finallyEntry.finallyLoc, ContinueSentinel) : this.complete(record); }, complete: function complete(record, afterLoc) { if ("throw" === record.type) throw record.arg; return "break" === record.type || "continue" === record.type ? this.next = record.arg : "return" === record.type ? (this.rval = this.arg = record.arg, this.method = "return", this.next = "end") : "normal" === record.type && afterLoc && (this.next = afterLoc), ContinueSentinel; }, finish: function finish(finallyLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.finallyLoc === finallyLoc) return this.complete(entry.completion, entry.afterLoc), resetTryEntry(entry), ContinueSentinel; } }, "catch": function _catch(tryLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc === tryLoc) { var record = entry.completion; if ("throw" === record.type) { var thrown = record.arg; resetTryEntry(entry); } return thrown; } } throw new Error("illegal catch attempt"); }, delegateYield: function delegateYield(iterable, resultName, nextLoc) { return this.delegate = { iterator: values(iterable), resultName: resultName, nextLoc: nextLoc }, "next" === this.method && (this.arg = undefined), ContinueSentinel; } }, exports; }
@@ -13,13 +13,15 @@ function _asyncToGenerator(fn) { return function () { var self = this, args = ar
 /**
  * Gets a client access token to authenticate a session.
  *
- * @link https://docs.dolby.io/communications-apis/reference/get-client-access-token
+ * @link https://docs.dolby.io/communications-apis/reference/get-client-access-token-v1
  *
  * @param appKey Your Dolby.io App Key.
  * @param appSecret Your Dolby.io App Secret.
- * @param expiresIn Access token expiration time in seconds. The maximum value is 2,592,000, indicating 30 days. If no value is specified, the default is 3,600, indicating one hour.
+ * @param expiresIn Access token expiration time in seconds. If no value is specified, the default is 3,600, indicating one hour. The maximum value is 86,400, indicating 24 hours.
  *
  * @returns A {@link JwtToken} object through a {@link Promise}.
+ * 
+ * @deprecated This function is now deprecated and will be removed in the next release of this SDK. Please start using {@link getClientAccessTokenV2} instead.
  */
 var getClientAccessToken = /*#__PURE__*/function () {
   var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(appKey, appSecret, expiresIn) {
@@ -27,9 +29,11 @@ var getClientAccessToken = /*#__PURE__*/function () {
     return _regeneratorRuntime().wrap(function _callee$(_context) {
       while (1) switch (_context.prev = _context.next) {
         case 0:
-          body = 'grant_type=client_credentials';
+          body = new URLSearchParams({
+            grant_type: 'client_credentials'
+          });
           if (expiresIn) {
-            body += "&expires_in=".concat(expiresIn);
+            body.append('expires_in', expiresIn.toFixed(0));
           }
           authz = Buffer.from("".concat(appKey, ":").concat(appSecret)).toString('base64');
           options = {
@@ -40,7 +44,7 @@ var getClientAccessToken = /*#__PURE__*/function () {
               'Cache-Control': 'no-cache',
               Authorization: "Basic ".concat(authz)
             },
-            body: body
+            body: body.toString()
           };
           _context.next = 6;
           return (0, _httpHelpers.sendPost)(options);
@@ -57,4 +61,54 @@ var getClientAccessToken = /*#__PURE__*/function () {
     return _ref.apply(this, arguments);
   };
 }();
-exports.getClientAccessToken = getClientAccessToken;
+
+/**
+ * Generates a client access token.
+ * 
+ * This API returns a client access token that your backend can request on behalf of a client to initialize the Dolby.io SDK in a secure way.
+ *
+ * @link https://docs.dolby.io/communications-apis/reference/get-client-access-token
+ *
+ * @param options Options to generate a client access token.
+ *
+ * @returns A {@link JwtToken} object through a {@link Promise}.
+ */
+exports.getClientAccessToken = getClientAccessToken;
+var getClientAccessTokenV2 = /*#__PURE__*/function () {
+  var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2(options) {
+    var body, postOptions, response;
+    return _regeneratorRuntime().wrap(function _callee2$(_context2) {
+      while (1) switch (_context2.prev = _context2.next) {
+        case 0:
+          body = {
+            sessionScope: options.sessionScope.join(' ')
+          };
+          if (options.externalId) body['externalId'] = options.externalId;
+          if (options.expiresIn) body['expiresIn'] = options.expiresIn;
+          postOptions = {
+            hostname: _urls.COMMS_HOSTNAME,
+            path: '/v2/client-access-token',
+            headers: {
+              'Cache-Control': 'no-cache',
+              Accept: 'application/json',
+              'Content-Type': 'application/json',
+              Authorization: "".concat(options.accessToken.token_type, " ").concat(options.accessToken.access_token)
+            },
+            body: JSON.stringify(body)
+          };
+          _context2.next = 6;
+          return (0, _httpHelpers.sendPost)(postOptions);
+        case 6:
+          response = _context2.sent;
+          return _context2.abrupt("return", response);
+        case 8:
+        case "end":
+          return _context2.stop();
+      }
+    }, _callee2);
+  }));
+  return function getClientAccessTokenV2(_x4) {
+    return _ref2.apply(this, arguments);
+  };
+}();
+exports.getClientAccessTokenV2 = getClientAccessTokenV2;

package/dist/communications/conference.d.ts

@@ -1,4 +1,4 @@
-import { CreateConferenceOptions, Conference, UserTokens } from './types/conference';
+import { CreateConferenceOptions, Conference, UserTokens, ListParticipantsResponse } from './types/conference';
 import { SpatialEnvironment, SpatialListener, SpatialUsers } from './types/spatialAudio';
 import JwtToken from '../types/jwtToken';
 import Participant from './types/participant';
@@ -73,6 +73,17 @@ export declare const setSpatialListenersAudio: (accessToken: JwtToken, conferenc
  * @returns The list of user tokens for each participants.
  */
 export declare const updatePermissions: (accessToken: JwtToken, conferenceId: string, participants: Array<Participant>) => Promise<UserTokens>;
+/**
+ * Returns the current participant list.
+ *
+ * @link https://docs.dolby.io/communications-apis/reference/return-participant-list
+ *
+ * @param accessToken Access token to use for authentication.
+ * @param conferenceId Identifier of the conference.
+ *
+ * @returns The list of participants in the conference.
+ */
+export declare const participants: (accessToken: JwtToken, conferenceId: string) => Promise<ListParticipantsResponse>;
 /**
  * Terminates an ongoing conference and removes all remaining participants from the conference.
  *

package/dist/communications/conference.js

@@ -4,7 +4,7 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.updatePermissions = exports.terminate = exports.setSpatialListenersAudio = exports.sendMessage = exports.kick = exports.invite = exports.createConference = void 0;
+exports.updatePermissions = exports.terminate = exports.setSpatialListenersAudio = exports.sendMessage = exports.participants = exports.kick = exports.invite = exports.createConference = void 0;
 var _httpHelpers = require("../internal/httpHelpers");
 var _urls = require("./internal/urls");
 var _rtcpMode = require("./types/rtcpMode");
@@ -333,23 +333,25 @@ var updatePermissions = /*#__PURE__*/function () {
 }();
 
 /**
- * Terminates an ongoing conference and removes all remaining participants from the conference.
+ * Returns the current participant list.
  *
- * @link https://docs.dolby.io/communications-apis/reference/terminate-conference
+ * @link https://docs.dolby.io/communications-apis/reference/return-participant-list
  *
  * @param accessToken Access token to use for authentication.
  * @param conferenceId Identifier of the conference.
+ *
+ * @returns The list of participants in the conference.
  */
 exports.updatePermissions = updatePermissions;
-var terminate = /*#__PURE__*/function () {
+var participants = /*#__PURE__*/function () {
   var _ref7 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee7(accessToken, conferenceId) {
-    var options;
+    var requestOptions, response;
     return _regeneratorRuntime().wrap(function _callee7$(_context7) {
       while (1) switch (_context7.prev = _context7.next) {
         case 0:
-          options = {
+          requestOptions = {
             hostname: _urls.COMMS_HOSTNAME,
-            path: "/v2/conferences/".concat(conferenceId),
+            path: "/v2/conferences/".concat(conferenceId, "/participants"),
             headers: {
               Accept: 'application/json',
               'Content-Type': 'application/json',
@@ -357,15 +359,55 @@ var terminate = /*#__PURE__*/function () {
             }
           };
           _context7.next = 3;
-          return (0, _httpHelpers.sendDelete)(options);
+          return (0, _httpHelpers.sendGet)(requestOptions);
         case 3:
+          response = _context7.sent;
+          return _context7.abrupt("return", response);
+        case 5:
         case "end":
           return _context7.stop();
       }
     }, _callee7);
   }));
-  return function terminate(_x22, _x23) {
+  return function participants(_x22, _x23) {
     return _ref7.apply(this, arguments);
   };
 }();
+
+/**
+ * Terminates an ongoing conference and removes all remaining participants from the conference.
+ *
+ * @link https://docs.dolby.io/communications-apis/reference/terminate-conference
+ *
+ * @param accessToken Access token to use for authentication.
+ * @param conferenceId Identifier of the conference.
+ */
+exports.participants = participants;
+var terminate = /*#__PURE__*/function () {
+  var _ref8 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee8(accessToken, conferenceId) {
+    var options;
+    return _regeneratorRuntime().wrap(function _callee8$(_context8) {
+      while (1) switch (_context8.prev = _context8.next) {
+        case 0:
+          options = {
+            hostname: _urls.COMMS_HOSTNAME,
+            path: "/v2/conferences/".concat(conferenceId),
+            headers: {
+              Accept: 'application/json',
+              'Content-Type': 'application/json',
+              Authorization: "".concat(accessToken.token_type, " ").concat(accessToken.access_token)
+            }
+          };
+          _context8.next = 3;
+          return (0, _httpHelpers.sendDelete)(options);
+        case 3:
+        case "end":
+          return _context8.stop();
+      }
+    }, _callee8);
+  }));
+  return function terminate(_x24, _x25) {
+    return _ref8.apply(this, arguments);
+  };
+}();
 exports.terminate = terminate;

package/dist/communications/types/authentication.d.ts

@@ -0,0 +1,25 @@
+import JwtToken from '../../types/jwtToken';
+export interface GetClientAccessTokenOptions {
+    /**
+     * Access token to use for authentication.
+     */
+    accessToken: JwtToken;
+    /**
+     * Access token expiration time in seconds.
+     * The maximum value is 86,400, indicating 24 hours.
+     * If no value is specified, the default is 3,600, indicating one hour.
+     */
+    expiresIn?: number;
+    /** The unique identifier of the participant who requests the token. */
+    externalId?: string;
+    /**
+     * A list of case-sensitive strings allowing you to control what scope of access the client access token should have.
+     * The API supports the following scopes:
+     * * `conf:create`: Allows creating a new conference.
+     * * `notifications:set`: Allows the client to subscribe to events.
+     * * `file:convert`: Allows converting files.
+     * * `session:update`: Allows updating the participant's name and avatar URL.
+     * Incorrect values are omitted. If you want to give the token access to all scopes, you can use a wildcard, such as *.
+     */
+    sessionScope: string[];
+}

package/dist/communications/types/authentication.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dist/communications/types/conference.d.ts

@@ -52,3 +52,25 @@ export interface Conference {
     /** The conference access token of the conference participants. */
     usersTokens: UserTokens;
 }
+export interface Participants {
+    /** The participant ID, in UUID (Universally Unique Identifier) format. The Dolby.io Communications APIs platform automatically generates an ID for each participant connected to the conference. */
+    userId: string;
+    /** The external ID of the participant. */
+    externalId: string;
+    /** The name of the participant. */
+    name: string;
+    /** The URL of the participant's avatar. */
+    avatarUrl: string;
+    /** The last external IP used by the participant in the conference. */
+    ipAddress: string;
+    /** The participant's user agent. */
+    userAgent: string;
+    /** The timestamp of the last time when the participant joined the conference. */
+    lastJoinTimestamp: number;
+    /** The number of times the participant joined the conference. */
+    nbSession: number;
+}
+export interface ListParticipantsResponse {
+    /** The ID of the created conference. */
+    participants: Participants[];
+}

package/dist/index.js

@@ -15,5 +15,5 @@ var streaming = _interopRequireWildcard(require("./streaming"));
 exports.streaming = streaming;
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-var version = "3.5.5";
+var version = "3.6.1";
 exports.version = version;

package/dist/types/jwtToken.d.ts

@@ -2,4 +2,5 @@ export default interface JwtToken {
     access_token: string;
     expires_in: number;
     token_type: string;
+    scope?: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dolbyio/dolbyio-rest-apis-client",
-    "version": "3.5.5",
+    "version": "3.6.1",
     "description": "Node.JS wrapper for the dolby.io REST APIs",
     "main": "dist/index.js",
     "scripts": {