@webex/contact-center 3.12.0-next.15 → 3.12.0-next.151

package/dist/services/config/index.js

@@ -37,40 +37,35 @@ class AgentConfigService {
    */
   async getAgentConfig(orgId, agentId) {
     try {
-      const userConfigPromise = this.getUserUsingCI(orgId, agentId);
-      const orgInfoPromise = this.getOrgInfo(orgId);
-      const orgSettingsPromise = this.getOrganizationSetting(orgId);
-      const tenantDataPromise = this.getTenantData(orgId);
-      const urlMappingPromise = this.getURLMapping(orgId);
-      const aiFeatureFlagsPromise = this.getAIFeatureFlags(orgId);
+      const orgConfigPromise = this.getOrgDesktopLoginConfig(orgId);
+      const userConfigPromise = this.getUserDesktopLoginConfig(orgId, agentId);
       const auxCodesPromise = this.getAllAuxCodes(orgId, _constants3.DEFAULT_PAGE_SIZE, [], _constants3.DEFAULT_AUXCODE_ATTRIBUTES);
-      const userConfigData = await userConfigPromise;
-      _loggerProxy.default.info(`Fetched user data, userId: ${userConfigData.ciUserId}`, {
+      const userConfig = await userConfigPromise;
+      const {
+        user: userData,
+        agentProfile: agentProfileData
+      } = userConfig;
+      _loggerProxy.default.info(`Fetched user data, userId: ${userData.ciUserId}`, {
         module: _constants2.CONFIG_FILE_NAME,
         method: _constants3.METHODS.GET_AGENT_CONFIG
       });
-      const agentProfilePromise = this.getDesktopProfileById(orgId, userConfigData.agentProfileId);
-      const siteInfoPromise = this.getSiteInfo(orgId, userConfigData.siteId);
-      const userDialPlanPromise = agentProfilePromise.then(agentProfileConfigData => agentProfileConfigData.dialPlanEnabled ? this.getDialPlanData(orgId) : []);
-      const userTeamPromise = userConfigData.teamIds ? this.getAllTeams(orgId, _constants3.DEFAULT_PAGE_SIZE, userConfigData.teamIds) : Promise.resolve([]);
-      const [agentProfileConfigData, siteInfo, userDialPlanData, userTeamData, orgInfo, orgSettingsData, tenantData, urlMappingData, aiFeatureFlagsData, auxCodesData] = await Promise.all([agentProfilePromise, siteInfoPromise, userDialPlanPromise, userTeamPromise, orgInfoPromise, orgSettingsPromise, tenantDataPromise, urlMappingPromise, aiFeatureFlagsPromise, auxCodesPromise]);
-      const multimediaProfileId = userConfigData.multimediaProfileId || userTeamData[0]?.multiMediaProfileId || siteInfo.multimediaProfileId;
+      const siteInfoPromise = this.getSiteInfo(orgId, userData.siteId);
+      const userTeamPromise = this.getAllTeams(orgId, _constants3.DEFAULT_PAGE_SIZE, userData.dbId);
+      const userDialPlanPromise = agentProfileData.dialPlanEnabled ? this.getDialPlanData(orgId) : Promise.resolve([]);
+      const [siteInfo, userDialPlanData, userTeamData, orgConfig, auxCodesData] = await Promise.all([siteInfoPromise, userDialPlanPromise, userTeamPromise, orgConfigPromise, auxCodesPromise]);
+      const multimediaProfileId = userTeamData[0]?.multiMediaProfileId || siteInfo.multimediaProfileId;
       _loggerProxy.default.info('Fetched all required data', {
         module: _constants2.CONFIG_FILE_NAME,
         method: _constants3.METHODS.GET_AGENT_CONFIG
       });
       const response = (0, _Util.parseAgentConfigs)({
-        userData: userConfigData,
+        orgConfig,
+        userData,
+        agentProfileData,
         teamData: userTeamData,
-        tenantData,
-        orgInfoData: orgInfo,
         auxCodes: auxCodesData,
-        orgSettingsData,
-        agentProfileData: agentProfileConfigData,
         dialPlanData: userDialPlanData,
-        urlMapping: urlMappingData,
-        multimediaProfileId,
-        aiFeatureFlags: aiFeatureFlagsData
+        multimediaProfileId
       });
       _loggerProxy.default.info('Parsing completed for agent-config', {
         module: _constants2.CONFIG_FILE_NAME,
@@ -91,21 +86,20 @@ class AgentConfigService {
   }
 
   /**
-   * Fetches the agent configuration data for the given orgId and agentId.
+   * Fetches the aggregated organization desktop-login configuration for the given orgId.
    * @ignore
-   * @param {string} orgId - organization ID for which the agent configuration is to be fetched.
-   * @param {string} agentId - agent ID for which the configuration is to be fetched.
-   * @returns {Promise<AgentResponse>} - A promise that resolves to the agent configuration response.
+   * @param {string} orgId - organization ID for which the configuration is to be fetched.
+   * @returns {Promise<OrgDesktopLoginResponse>} - A promise that resolves to the organization configuration.
    * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
    * @private
    */
-  async getUserUsingCI(orgId, agentId) {
-    _loggerProxy.default.info('Fetching user data using CI', {
+  async getOrgDesktopLoginConfig(orgId) {
+    _loggerProxy.default.info('Fetching organization desktop-login configuration', {
       module: _constants2.CONFIG_FILE_NAME,
-      method: _constants3.METHODS.GET_USER_USING_CI
+      method: _constants3.METHODS.GET_ORG_DESKTOP_LOGIN_CONFIG
     });
     try {
-      const resource = _constants3.endPointMap.userByCI(orgId, agentId);
+      const resource = _constants3.endPointMap.orgDesktopLogin(orgId);
       const response = await this.webexReq.request({
         service: _constants.WCC_API_GATEWAY,
         resource,
@@ -114,36 +108,36 @@ class AgentConfigService {
       if (response.statusCode !== 200) {
         throw new Error(`API call failed with ${response.statusCode}`);
       }
-      _loggerProxy.default.log('getUserUsingCI api success.', {
+      _loggerProxy.default.log('getOrgDesktopLoginConfig api success.', {
         module: _constants2.CONFIG_FILE_NAME,
-        method: _constants3.METHODS.GET_USER_USING_CI
+        method: _constants3.METHODS.GET_ORG_DESKTOP_LOGIN_CONFIG
       });
       return Promise.resolve(response.body);
     } catch (error) {
-      _loggerProxy.default.error(`getUserUsingCI API call failed with ${error}`, {
+      _loggerProxy.default.error(`getOrgDesktopLoginConfig API call failed with ${error}`, {
         module: _constants2.CONFIG_FILE_NAME,
-        method: _constants3.METHODS.GET_USER_USING_CI
+        method: _constants3.METHODS.GET_ORG_DESKTOP_LOGIN_CONFIG
       });
       throw error;
     }
   }
 
   /**
-   * Fetches the desktop profile data for the given orgId and desktopProfileId.
+   * Fetches the aggregated user desktop-login configuration for the given orgId and ciUserId.
    * @ignore
-   * @param {string} orgId - organization ID for which the desktop profile is to be fetched.
-   * @param {string} desktopProfileId - desktop profile ID for which the data is to be fetched.
-   * @returns {Promise<DesktopProfileResponse>} - A promise that resolves to the desktop profile response.
+   * @param {string} orgId - organization ID for which the configuration is to be fetched.
+   * @param {string} ciUserId - CI user ID of the agent whose configuration is to be fetched.
+   * @returns {Promise<UserDesktopLoginResponse>} - A promise that resolves to the user configuration.
    * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
    * @private
    */
-  async getDesktopProfileById(orgId, desktopProfileId) {
-    _loggerProxy.default.info('Fetching desktop profile', {
+  async getUserDesktopLoginConfig(orgId, ciUserId) {
+    _loggerProxy.default.info('Fetching user desktop-login configuration', {
       module: _constants2.CONFIG_FILE_NAME,
-      method: _constants3.METHODS.GET_DESKTOP_PROFILE_BY_ID
+      method: _constants3.METHODS.GET_USER_DESKTOP_LOGIN_CONFIG
     });
     try {
-      const resource = _constants3.endPointMap.desktopProfile(orgId, desktopProfileId);
+      const resource = _constants3.endPointMap.userDesktopLogin(orgId, ciUserId);
       const response = await this.webexReq.request({
         service: _constants.WCC_API_GATEWAY,
         resource,
@@ -152,15 +146,15 @@ class AgentConfigService {
       if (response.statusCode !== 200) {
         throw new Error(`API call failed with ${response.statusCode}`);
       }
-      _loggerProxy.default.log('getDesktopProfileById api success.', {
+      _loggerProxy.default.log('getUserDesktopLoginConfig api success.', {
         module: _constants2.CONFIG_FILE_NAME,
-        method: _constants3.METHODS.GET_DESKTOP_PROFILE_BY_ID
+        method: _constants3.METHODS.GET_USER_DESKTOP_LOGIN_CONFIG
       });
       return Promise.resolve(response.body);
     } catch (error) {
-      _loggerProxy.default.error(`getDesktopProfileById API call failed with ${error}`, {
+      _loggerProxy.default.error(`getUserDesktopLoginConfig API call failed with ${error}`, {
         module: _constants2.CONFIG_FILE_NAME,
-        method: _constants3.METHODS.GET_DESKTOP_PROFILE_BY_ID
+        method: _constants3.METHODS.GET_USER_DESKTOP_LOGIN_CONFIG
       });
       throw error;
     }
@@ -205,24 +199,23 @@ class AgentConfigService {
   }
 
   /**
-   * fetches the list of teams for the given orgId.
+   * fetches the list of teams the given user belongs to.
    * @ignore
    * @param {string} orgId - organization ID for which the teams are to be fetched.
    * @param {number} page - the page number to fetch.
    * @param {number} pageSize - the number of teams to fetch per page.
-   * @param {string[]} filter - optional filter criteria for the teams.
-   * @param {string[]} attributes - optional attributes to include in the response.
+   * @param {string} userDbId - database ID of the user whose teams are to be fetched.
    * @returns {Promise<ListTeamsResponse>} - A promise that resolves to the list of teams response.
    * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
    * @private
    */
-  async getListOfTeams(orgId, page, pageSize, filter) {
+  async getListOfTeams(orgId, page, pageSize, userDbId) {
     _loggerProxy.default.info('Fetching list of teams', {
       module: _constants2.CONFIG_FILE_NAME,
       method: _constants3.METHODS.GET_LIST_OF_TEAMS
     });
     try {
-      const resource = _constants3.endPointMap.listTeams(orgId, page, pageSize, filter);
+      const resource = _constants3.endPointMap.listTeams(orgId, page, pageSize, userDbId);
       const response = await this.webexReq.request({
         service: _constants.WCC_API_GATEWAY,
         resource,
@@ -246,26 +239,25 @@ class AgentConfigService {
   }
 
   /**
-   * Fetches all teams from all pages for the given orgId
+   * Fetches all teams the given user belongs to, from all pages
    * @ignore
    * @param {string} orgId - organization ID for which the teams are to be fetched.
    * @param {number} pageSize - the number of teams to fetch per page.
-   * @param {string[]} filter - optional filter criteria for the teams.
-   * @param {string[]} attributes - optional attributes to include in the response.
+   * @param {string} userDbId - database ID of the user whose teams are to be fetched.
    * @returns {Promise<TeamList[]>} - A promise that resolves to the list of teams.
    * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
    * @private
    */
-  async getAllTeams(orgId, pageSize, filter) {
+  async getAllTeams(orgId, pageSize, userDbId) {
     try {
       let allTeams = [];
       let page = _constants3.DEFAULT_PAGE;
-      const firstResponse = await this.getListOfTeams(orgId, page, pageSize, filter);
+      const firstResponse = await this.getListOfTeams(orgId, page, pageSize, userDbId);
       const totalPages = firstResponse.meta.totalPages;
       allTeams = allTeams.concat(firstResponse.data);
       const requests = [];
       for (page = _constants3.DEFAULT_PAGE + 1; page < totalPages; page += 1) {
-        requests.push(this.getListOfTeams(orgId, page, pageSize, filter));
+        requests.push(this.getListOfTeams(orgId, page, pageSize, userDbId));
       }
       const responses = await Promise.all(requests);
       for (const response of responses) {
@@ -359,190 +351,72 @@ class AgentConfigService {
   }
 
   /**
-   * Fetches the site data for the given orgId and siteId.
-   * @ignore
-   * @param {string} orgId - organization ID for which the site info is to be fetched.
-   * @param {string} siteId - site ID for which the data is to be fetched.
-   * @returns {Promise<SiteInfo>} - A promise that resolves to the site info response.
-   * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
-   * @private
+   * Retrieves the exact system-managed WellbeingBreak idle code.
+   * This query intentionally bypasses Desktop Profile filtering so the system code does not
+   * need to appear in the normal agent-selectable idle-code list.
+   * @param orgId - Organization identifier
+   * @returns The normalized WellbeingBreak entity
+   * @throws When the request fails or the exact system code is unavailable
+   * @internal
    */
-  async getSiteInfo(orgId, siteId) {
-    _loggerProxy.default.info('Fetching site information', {
+  async getWellbeingBreakIdleCode(orgId) {
+    _loggerProxy.default.info('Fetching WellbeingBreak system idle code', {
       module: _constants2.CONFIG_FILE_NAME,
-      method: _constants3.METHODS.GET_SITE_INFO
+      method: _constants3.METHODS.GET_WELLBEING_BREAK_IDLE_CODE
     });
     try {
-      const resource = _constants3.endPointMap.siteInfo(orgId, siteId);
-      const response = await this.webexReq.request({
-        service: _constants.WCC_API_GATEWAY,
-        resource,
-        method: _types.HTTP_METHODS.GET
-      });
-      if (response.statusCode !== 200) {
-        throw new Error(`API call failed with ${response.statusCode}`);
-      }
-      _loggerProxy.default.log('getSiteInfo api success.', {
-        module: _constants2.CONFIG_FILE_NAME,
-        method: _constants3.METHODS.GET_SITE_INFO
-      });
-      return Promise.resolve(response.body);
-    } catch (error) {
-      _loggerProxy.default.error(`getSiteInfo API call failed with ${error}`, {
-        module: _constants2.CONFIG_FILE_NAME,
-        method: _constants3.METHODS.GET_SITE_INFO
-      });
-      throw error;
-    }
-  }
-
-  /**
-   * Fetches the organization info for the given orgId.
-   * @ignore
-   * @param {string} orgId - organization ID for which the organization info is to be fetched.
-   * @returns {Promise<OrgInfo>} - A promise that resolves to the organization info response.
-   * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
-   * @private
-   */
-  async getOrgInfo(orgId) {
-    try {
-      const resource = _constants3.endPointMap.orgInfo(orgId);
-      const response = await this.webexReq.request({
-        service: _constants.WCC_API_GATEWAY,
-        resource,
-        method: _types.HTTP_METHODS.GET
-      });
-      if (response.statusCode !== 200) {
-        throw new Error(`API call failed with ${response.statusCode}`);
-      }
-      _loggerProxy.default.log('getOrgInfo api success.', {
-        module: _constants2.CONFIG_FILE_NAME,
-        method: _constants3.METHODS.GET_ORG_INFO
-      });
-      return Promise.resolve(response.body);
-    } catch (error) {
-      _loggerProxy.default.error(`getOrgInfo API call failed with ${error}`, {
-        module: _constants2.CONFIG_FILE_NAME,
-        method: _constants3.METHODS.GET_ORG_INFO
-      });
-      throw error;
-    }
-  }
-
-  /**
-   * Fetches the organization settings for the given orgId.
-   * @ignore
-   * @param {string} orgId - organization ID for which the organization settings are to be fetched.
-   * @returns {Promise<OrgSettings>} - A promise that resolves to the organization settings response.
-   * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
-   * @private
-   */
-  async getOrganizationSetting(orgId) {
-    try {
-      const resource = _constants3.endPointMap.orgSettings(orgId);
-      const response = await this.webexReq.request({
-        service: _constants.WCC_API_GATEWAY,
-        resource,
-        method: _types.HTTP_METHODS.GET
-      });
-      if (response.statusCode !== 200) {
-        throw new Error(`API call failed with ${response.statusCode}`);
-      }
-      _loggerProxy.default.log('getOrganizationSetting api success.', {
-        module: _constants2.CONFIG_FILE_NAME,
-        method: _constants3.METHODS.GET_ORGANIZATION_SETTING
-      });
-      return Promise.resolve(response.body.data[0]);
-    } catch (error) {
-      _loggerProxy.default.error(`getOrganizationSetting API call failed with ${error}`, {
-        module: _constants2.CONFIG_FILE_NAME,
-        method: _constants3.METHODS.GET_ORGANIZATION_SETTING
-      });
-      throw error;
-    }
-  }
-
-  /**
-   * Fetches the tenant data for the given orgId.
-   * @ignore
-   * @param {string} orgId - organization ID for which the tenant data is to be fetched.
-   * @returns {Promise<TenantData>} - A promise that resolves to the tenant data response.
-   * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
-   * @private
-   */
-  async getTenantData(orgId) {
-    try {
-      const resource = _constants3.endPointMap.tenantData(orgId);
-      const response = await this.webexReq.request({
-        service: _constants.WCC_API_GATEWAY,
-        resource,
-        method: _types.HTTP_METHODS.GET
-      });
-      if (response.statusCode !== 200) {
-        throw new Error(`API call failed with ${response.statusCode}`);
-      }
-      _loggerProxy.default.log('getTenantData api success.', {
-        module: _constants2.CONFIG_FILE_NAME,
-        method: _constants3.METHODS.GET_TENANT_DATA
-      });
-      return Promise.resolve(response.body.data[0]);
-    } catch (error) {
-      _loggerProxy.default.error(`getTenantData API call failed with ${error}`, {
-        module: _constants2.CONFIG_FILE_NAME,
-        method: _constants3.METHODS.GET_TENANT_DATA
-      });
-      throw error;
-    }
-  }
-
-  /**
-   * Fetches the URL mapping data for the given orgId.
-   * @ignore
-   * @param {string} orgId - organization ID for which the URL mapping is to be fetched.
-   * @returns {Promise<URLMapping[]>} - A promise that resolves to the URL mapping response.
-   * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
-   * @private
-   */
-  async getURLMapping(orgId) {
-    try {
-      const resource = _constants3.endPointMap.urlMapping(orgId);
-      const response = await this.webexReq.request({
-        service: _constants.WCC_API_GATEWAY,
-        resource,
-        method: _types.HTTP_METHODS.GET
-      });
-      if (response.statusCode !== 200) {
-        throw new Error(`API call failed with ${response.statusCode}`);
-      }
-      _loggerProxy.default.log('getURLMapping api success.', {
-        module: _constants2.CONFIG_FILE_NAME,
-        method: _constants3.METHODS.GET_URL_MAPPING
-      });
-      return Promise.resolve(response.body.data);
+      let page = _constants3.DEFAULT_PAGE;
+      let totalPages = 1;
+      do {
+        // Pagination is intentionally sequential so the lookup can stop as soon as the code is found.
+        // eslint-disable-next-line no-await-in-loop
+        const response = await this.webexReq.request({
+          service: _constants.WCC_API_GATEWAY,
+          resource: _constants3.endPointMap.systemIdleCodes(orgId, page, _constants3.DEFAULT_PAGE_SIZE),
+          method: _types.HTTP_METHODS.GET
+        });
+        if (response.statusCode !== 200) {
+          throw new Error(`API call failed with ${response.statusCode}`);
+        }
+        const result = response.body;
+        const wellbeingCode = result.data?.find(code => code.active === true && code.isSystemCode === true && code.name === _constants3.WELLBEING_BREAK_IDLE_CODE);
+        if (wellbeingCode) {
+          return {
+            id: wellbeingCode.id,
+            name: wellbeingCode.name,
+            isSystem: true,
+            isDefault: wellbeingCode.defaultCode
+          };
+        }
+        totalPages = result.meta?.totalPages ?? 1;
+        page += 1;
+      } while (page < totalPages);
+      throw new Error('WELLBEING_BREAK_IDLE_CODE_NOT_FOUND');
     } catch (error) {
-      _loggerProxy.default.error(`getURLMapping API call failed with ${error}`, {
+      _loggerProxy.default.error(`getWellbeingBreakIdleCode API call failed with ${error}`, {
         module: _constants2.CONFIG_FILE_NAME,
-        method: _constants3.METHODS.GET_URL_MAPPING
+        method: _constants3.METHODS.GET_WELLBEING_BREAK_IDLE_CODE
       });
       throw error;
     }
   }
 
   /**
-   * Fetches AI feature resources for the organization.
+   * Fetches the site data for the given orgId and siteId.
    * @ignore
-   * @param {string} orgId - organization ID for which AI feature resources are to be fetched.
-   * @returns {Promise<AIFeatureFlagsResponse>} - AI feature resources response.
+   * @param {string} orgId - organization ID for which the site info is to be fetched.
+   * @param {string} siteId - site ID for which the data is to be fetched.
+   * @returns {Promise<SiteInfo>} - A promise that resolves to the site info response.
    * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
    * @private
    */
-  async getAIFeatureFlags(orgId) {
-    _loggerProxy.default.info('Fetching AI feature resources', {
+  async getSiteInfo(orgId, siteId) {
+    _loggerProxy.default.info('Fetching site information', {
       module: _constants2.CONFIG_FILE_NAME,
-      method: _constants3.METHODS.GET_AI_FEATURE_FLAGS
+      method: _constants3.METHODS.GET_SITE_INFO
     });
     try {
-      const resource = _constants3.endPointMap.aiFeature(orgId);
+      const resource = _constants3.endPointMap.siteInfo(orgId, siteId);
       const response = await this.webexReq.request({
         service: _constants.WCC_API_GATEWAY,
         resource,
@@ -551,15 +425,15 @@ class AgentConfigService {
       if (response.statusCode !== 200) {
         throw new Error(`API call failed with ${response.statusCode}`);
       }
-      _loggerProxy.default.log('getAIFeatureFlags api success.', {
+      _loggerProxy.default.log('getSiteInfo api success.', {
         module: _constants2.CONFIG_FILE_NAME,
-        method: _constants3.METHODS.GET_AI_FEATURE_FLAGS
+        method: _constants3.METHODS.GET_SITE_INFO
       });
       return Promise.resolve(response.body);
     } catch (error) {
-      _loggerProxy.default.error(`getAIFeatureFlags API call failed with ${error}`, {
+      _loggerProxy.default.error(`getSiteInfo API call failed with ${error}`, {
         module: _constants2.CONFIG_FILE_NAME,
-        method: _constants3.METHODS.GET_AI_FEATURE_FLAGS
+        method: _constants3.METHODS.GET_SITE_INFO
       });
       throw error;
     }