ULMS-2213 Added methods for reading and updating groups (Conference)

foxford · Jan 25, 2023 · b76ad74 · b76ad74
1 parent 36b3239
commit b76ad74
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 3 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@ulms/api-clients",
-  "version": "5.11.0",
+  "version": "5.12.0",
   "description": "JavaScript API clients for ULMS platform",
   "keywords": [],
   "homepage": "https://github.com/foxford/ulms-api-clients-js#readme",

diff --git a/src/conference.js b/src/conference.js
@@ -24,6 +24,7 @@ class Conference extends Service {
    * Conference events enum
    * @returns {{
    *  AGENT_WRITER_CONFIG_UPDATE: string,
+   *  GROUP_UPDATE: string,
    *  ROOM_CLOSE: string,
    *  ROOM_ENTER: string,
    *  ROOM_LEAVE: string,
@@ -35,6 +36,7 @@ class Conference extends Service {
   static get events() {
     return {
       AGENT_WRITER_CONFIG_UPDATE: 'agent_writer_config.update',
+      GROUP_UPDATE: 'group.update',
       ROOM_CLOSE: 'room.close',
       ROOM_ENTER: 'room.enter',
       ROOM_LEAVE: 'room.leave',

diff --git a/src/http-conference.js b/src/http-conference.js
@@ -27,6 +27,14 @@ import BasicClient from './basic-client'
  * @property {number} offset
  */
 
+/**
+ * Group configuration
+ * @name GroupConfig
+ * @type {object}
+ * @property {number} number
+ * @property {string[]} agents
+ */
+
 /**
  * Extended parameters to filter listing requests of rtc streams
  * @name RtcStreamFilterParameters
@@ -36,11 +44,19 @@ import BasicClient from './basic-client'
  * @property {[number | null, number | null]} time
  */
 
+/**
+ * Filter parameters for groups read requests
+ * @name GroupsFilterParameters
+ * @type {object}
+ * @property {number} within_group
+ */
+
 class HTTPConference extends BasicClient {
   /**
    * Conference events enum
    * @returns {{
    *  AGENT_WRITER_CONFIG_UPDATE: string,
+   *  GROUP_UPDATE: string,
    *  ROOM_CLOSE: string,
    *  ROOM_ENTER: string,
    *  ROOM_LEAVE: string,
@@ -52,6 +68,7 @@ class HTTPConference extends BasicClient {
   static get events() {
     return {
       AGENT_WRITER_CONFIG_UPDATE: 'agent_writer_config.update',
+      GROUP_UPDATE: 'group.update',
       ROOM_CLOSE: 'room.close',
       ROOM_ENTER: 'room.enter',
       ROOM_LEAVE: 'room.leave',
@@ -252,6 +269,16 @@ class HTTPConference extends BasicClient {
     return this.get(this.url(`/rooms/${roomId}/configs/writer`))
   }
 
+  /**
+   * Read Groups
+   * @param roomId
+   * @param {GroupsFilterParameters|Object} filterParameters
+   * @returns {Promise}
+   */
+  readGroups(roomId, filterParameters) {
+    return this.get(this.url(`/rooms/${roomId}/groups`, filterParameters))
+  }
+
   /**
    * Update AgentReaderConfig
    * @param roomId
@@ -275,6 +302,16 @@ class HTTPConference extends BasicClient {
 
     return this.post(this.url(`/rooms/${roomId}/configs/writer`), payload)
   }
+
+  /**
+   * Update Groups
+   * @param roomId
+   * @param {GroupConfig[]} payload
+   * @returns {Promise}
+   */
+  updateGroups(roomId, payload) {
+    return this.post(this.url(`/rooms/${roomId}/groups`), payload)
+  }
 }
 
 export default HTTPConference