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

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/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.6.0";
+var version = "3.6.1";
 exports.version = version;

package/package.json

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