@webex/contact-center 3.12.0-next.149 → 3.12.0-next.150

package/src/services/config/types.ts

@@ -257,7 +257,7 @@ export type WebSocketEvent = {
 };
 
 /**
- * Represents the response from getUserUsingCI method.
+ * Agent identity carried by the `user` section of the user desktop-login aggregate.
  */
 export type AgentResponse = {
   /**
@@ -290,16 +290,6 @@ export type AgentResponse = {
    */
   email: string;
 
-  /**
-   * Team IDs assigned to the agent.
-   */
-  teamIds: string[];
-
-  /**
-   * Multimedia profile ID associated with the agent.
-   */
-  multimediaProfileId: string;
-
   /**
    * Skill profile ID of the agent.
    */
@@ -311,9 +301,10 @@ export type AgentResponse = {
   siteId: string;
 
   /**
-   * Database ID of the agent.
+   * Database ID of the agent, distinct from `ciUserId`. Passed as `userDbId` to the team lookup,
+   * which sends it as the backend's `filter=userId==` value.
    */
-  dbId?: string;
+  dbId: string;
 
   /**
    * The default dialed number of the agent.
@@ -323,36 +314,12 @@ export type AgentResponse = {
 };
 
 /**
- * Represents the response from getDesktopProfileById method.
+ * Desktop Profile settings carried by the `agentProfile` section of the user desktop-login
+ * aggregate.
  */
-export type DesktopProfileResponse = {
-  /**
-   * Unique identifier of the agent profile configuration.
-   */
-  id: string;
-
-  /**
-   * Display name for the agent profile.
-   */
-  name: string;
-
+export type AgentProfile = {
   /**
-   * Description of the agent profile.
-   */
-  description: string;
-
-  /**
-   * Parent entity type for the profile (for example ORGANIZATION).
-   */
-  parentType: string;
-
-  /**
-   * Indicates whether screen pop is enabled.
-   */
-  screenPopup: boolean;
-
-  /**
-   * Represents the voice options of an agent.
+   * Represents the voice options of an agent. The order is nondeterministic; treat as a set.
    */
   loginVoiceOptions: LoginOption[];
 
@@ -366,16 +333,6 @@ export type DesktopProfileResponse = {
    */
   accessIdleCode: string;
 
-  /**
-   * Wrap-up codes list that the agents can select when they wrap up a contact.
-   */
-  wrapUpCodes: string[];
-
-  /**
-   * Idle codes list that the agents can select in Agent Desktop.
-   */
-  idleCodes: string[];
-
   /**
    * Dial plan enabled for the agent.
    */
@@ -394,12 +351,7 @@ export type DesktopProfileResponse = {
   /**
    * Whether the agent personal greeting is enabled.
    */
-  agentPersonalGreeting: boolean;
-
-  /**
-   * Auto answer allowed.
-   */
-  autoAnswer: boolean;
+  agentPersonalGreeting?: boolean;
 
   /**
    * Auto wrap-up after seconds.
@@ -421,31 +373,16 @@ export type DesktopProfileResponse = {
    */
   accessQueue: CollaborationAccess;
 
-  /**
-   * Queue identifiers available to the agent when access is SPECIFIC.
-   */
-  queues: string[];
-
   /**
    * Access control for entry points assigned to the agent.
    */
   accessEntryPoint: CollaborationAccess;
 
-  /**
-   * Entry point identifiers available to the agent when access is SPECIFIC.
-   */
-  entryPoints: string[];
-
   /**
    * Access control for buddy teams assigned to the agent.
    */
   accessBuddyTeam: CollaborationAccess;
 
-  /**
-   * Buddy team identifiers available to the agent when access is SPECIFIC.
-   */
-  buddyTeams: string[];
-
   /**
    * Outdial enabled for the agent.
    */
@@ -461,6 +398,11 @@ export type DesktopProfileResponse = {
    */
   outdialANIId: string;
 
+  /**
+   * Whether the agent can schedule and manage callbacks.
+   */
+  scheduleAndManageCallBack?: boolean;
+
   /**
    * Consult to queue allowed.
    */
@@ -469,19 +411,14 @@ export type DesktopProfileResponse = {
   /**
    * Address book ID of the agent.
    */
-  addressBookId: string;
+  addressBookId?: string;
 
   /**
    * Viewable statistics of the agent.
    */
   viewableStatistics: {
-    id: string;
     agentStats: boolean;
-    accessQueueStats: string;
-    contactServiceQueues: string[];
-    loggedInTeamStats: boolean;
-    accessTeamStats: string;
-    teams: string[];
+    aiAgentPerformance?: boolean;
   };
 
   /**
@@ -489,16 +426,6 @@ export type DesktopProfileResponse = {
    */
   agentDNValidation: string;
 
-  /**
-   * Additional DN validation criteria configured for the agent.
-   */
-  agentDNValidationCriterions: string[];
-
-  /**
-   * Dial plans of the agent.
-   */
-  dialPlans: string[];
-
   /**
    * Timeout desktop inactivity custom enabled.
    */
@@ -507,52 +434,7 @@ export type DesktopProfileResponse = {
   /**
    * Timeout desktop inactivity minutes.
    */
-  timeoutDesktopInactivityMins: number;
-
-  /**
-   * Show user details in Microsoft enabled or not.
-   */
-  showUserDetailsMS: boolean;
-
-  /**
-   * State synchronization in Microsoft enabled or not.
-   */
-  stateSynchronizationMS: boolean;
-
-  /**
-   * Show user details in Webex enabled or not.
-   */
-  showUserDetailsWebex: boolean;
-
-  /**
-   * State synchronization in Webex enabled or not.
-   */
-  stateSynchronizationWebex: boolean;
-
-  /**
-   * Threshold rules configured for the agent profile.
-   */
-  thresholdRules: Array<Record<string, string | number>>;
-
-  /**
-   * Whether the agent profile is currently active.
-   */
-  active: boolean;
-
-  /**
-   * Whether this profile is the system default.
-   */
-  systemDefault: boolean;
-
-  /**
-   * Timestamp when the profile was created.
-   */
-  createdTime: number;
-
-  /**
-   * Timestamp when the profile was last updated.
-   */
-  lastUpdatedTime: number;
+  timeoutDesktopInactivityMins?: number;
 };
 
 /**
@@ -712,7 +594,8 @@ export type ListTeamsResponse = {
 };
 
 /**
- * Basic organization information in the contact center system
+ * Basic organization information carried by the `organization` section of the org desktop-login
+ * aggregate.
  * @private
  * @ignore
  */
@@ -721,12 +604,11 @@ export type OrgInfo = {
   tenantId: string;
   /** Organization timezone */
   timezone: string;
-  /** Current environment (e.g., 'produs1', 'intgus1') */
-  environment: string;
 };
 
 /**
- * Organization-wide feature settings and configurations
+ * Organization-wide feature settings carried by the `organizationSetting` section of the org
+ * desktop-login aggregate.
  * @private
  */
 export type OrgSettings = {
@@ -758,12 +640,13 @@ export type SiteInfo = {
 };
 
 /**
- * Tenant-level configuration data and settings
+ * Tenant-level configuration carried by the `tenantConfiguration` section of the org
+ * desktop-login aggregate.
  * @private
  */
 export type TenantData = {
-  /** Desktop inactivity timeout in minutes */
-  timeoutDesktopInactivityMins: number;
+  /** Desktop inactivity timeout in minutes. Omitted when the timeout is not enabled. */
+  timeoutDesktopInactivityMins?: number;
   /** Whether default DN is enforced */
   forceDefaultDn: boolean;
   /** Regex pattern for default DN validation */
@@ -787,16 +670,46 @@ export type TenantData = {
 };
 
 /**
- * URL mapping configuration for external integrations
+ * URL mappings carried by the `urlMappings` section of the org desktop-login aggregate, keyed by
+ * mapping name. The aggregate returns `{}` when the organization has no Acqueon configuration.
  * @public
  */
-export type URLMapping = {
-  id: string;
-  name: string;
-  url: string;
-  links: string[]; // Assuming 'links' is an array of strings, adjust if necessary
-  createdTime: number; // Assuming timestamps are represented as numbers
-  lastUpdatedTime: number;
+export type OrgUrlMappings = {
+  /** Acqueon API endpoint URL */
+  ACQUEON_API_URL?: string;
+  /** Acqueon console URL */
+  ACQUEON_CONSOLE_URL?: string;
+};
+
+/**
+ * Organization-level Microsoft Teams integration configuration carried by the `microsoftConfig`
+ * section of the org desktop-login aggregate. The whole section is absent when the organization
+ * has no Microsoft integration.
+ * @public
+ */
+export type MicrosoftConfig = {
+  /** Whether to show user details in Teams */
+  showUserDetails?: boolean;
+  /** Whether to sync agent state with Teams */
+  stateSynchronization?: boolean;
+  /** Whether the integration is enabled organization-wide */
+  active?: boolean;
+  /** Idle codes mapped to Teams presence states */
+  idleCodes?: Record<string, string>;
+};
+
+/**
+ * Organization-level Webex integration configuration carried by the `webexConfig` section of the
+ * org desktop-login aggregate.
+ * @public
+ */
+export type WebexConfig = {
+  /** Whether to show user details in Webex */
+  showUserDetails?: boolean;
+  /** Whether to sync agent state with Webex */
+  stateSynchronization?: boolean;
+  /** Idle codes mapped to Webex presence states */
+  idleCodes?: Record<string, string>;
 };
 
 /**
@@ -894,6 +807,8 @@ export type DialPlanEntity = {
   strippedChars: string;
   /** Name of the dial plan */
   name: string;
+  /** Whether the dial plan is active */
+  active: boolean;
 };
 
 /**
@@ -1001,19 +916,6 @@ export type WrapupData = {
   };
 };
 
-/**
- * Team configuration information
- * @public
- */
-export type Team = {
-  /** Unique team identifier */
-  teamId: string;
-  /** Team display name */
-  teamName: string;
-  /** Optional desktop layout configuration identifier */
-  desktopLayoutId?: string;
-};
-
 /**
  * Basic queue configuration information
  * @public
@@ -1037,11 +939,12 @@ export type URLMappings = {
 };
 
 /**
- * AI feature resource row returned by /v2/ai-feature API.
+ * AI feature flags carried by the `aiFeature` section of the org desktop-login aggregate.
  * @public
  */
 export type AIFeatureFlags = {
-  id: string;
+  /** Not carried by the aggregate; retained for responses that still supply a record id. */
+  id?: string;
   realtimeTranscripts?: {
     enable?: boolean;
     agentInclusionType?: string;
@@ -1066,27 +969,42 @@ export type AIFeatureFlags = {
     queuesInclusionType?: string;
     surveyDataSource?: string;
   };
-  links?: string[];
-  createdTime?: number;
-  lastUpdatedTime?: number;
 };
 
 /**
- * Response type for list AI feature resources API.
+ * Aggregated organization configuration returned by `organization/{orgId}/desktop-login`.
+ * Replaces the separate organization, organization-setting, tenant-configuration,
+ * org-url-mapping and ai-feature calls.
  * @public
  */
-export type AIFeatureFlagsResponse = {
-  meta?: {
-    orgid?: string;
-    page?: number;
-    pageSize?: number;
-    totalPages?: number;
-    totalRecords?: number;
-    links?: {
-      self?: string;
-    };
-  };
-  data: AIFeatureFlags[];
+export type OrgDesktopLoginResponse = {
+  /** Organization identity and timezone */
+  organization: OrgInfo;
+  /** Organization-wide feature settings */
+  organizationSetting: OrgSettings;
+  /** Tenant-level configuration */
+  tenantConfiguration: TenantData;
+  /** External integration URLs, keyed by mapping name */
+  urlMappings?: OrgUrlMappings;
+  /** AI feature flags */
+  aiFeature?: AIFeatureFlags;
+  /** Microsoft Teams integration configuration; absent when not configured */
+  microsoftConfig?: MicrosoftConfig;
+  /** Webex integration configuration */
+  webexConfig?: WebexConfig;
+};
+
+/**
+ * Aggregated user configuration returned by
+ * `organization/{orgId}/v2/user/by-ci-user-id/{ciUserId}/desktop-login`.
+ * Replaces the separate user and agent-profile calls.
+ * @public
+ */
+export type UserDesktopLoginResponse = {
+  /** Agent identity */
+  user: AgentResponse;
+  /** Desktop Profile settings for the agent */
+  agentProfile: AgentProfile;
 };
 
 /**
@@ -1109,8 +1027,8 @@ export type Profile = {
     /** Whether to sync agent state with Webex */
     stateSynchronizationWebex?: boolean;
   };
-  /** List of teams the agent belongs to */
-  teams: Team[];
+  /** List of teams the agent belongs to, as returned by the team API */
+  teams: TeamList[];
   /** Agent's default dial number */
   defaultDn: string;
   dn?: string;
@@ -1226,8 +1144,6 @@ export type Profile = {
   isAnalyzerEnabled?: boolean;
   /** Tenant timezone */
   tenantTimezone?: string;
-  /** Current environment (e.g., 'produs1', 'intgus1') */
-  environment?: string;
   /** Available voice login options */
   loginVoiceOptions?: LoginOption[];
   /** Current login device type */

package/test/unit/spec/index.ts

@@ -23,6 +23,7 @@ const EXPECTED_ROOT_EXPORTS = Object.freeze([
   'AgentContact',
   'AgentEvents',
   'AgentLogin',
+  'AgentProfile',
   'AgentProfileUpdate',
   'AgentResponse',
   'AgentState',
@@ -46,7 +47,6 @@ const EXPECTED_ROOT_EXPORTS = Object.freeze([
   'ContactServiceQueueSearchParams',
   'ContactServiceQueuesResponse',
   'CreateUserPreferenceRequest',
-  'DesktopProfileResponse',
   'DeviceType',
   'DeviceTypeUpdateSuccess',
   'DialPlan',
@@ -71,9 +71,12 @@ const EXPECTED_ROOT_EXPORTS = Object.freeze([
   'LoginOption',
   'Logout',
   'LogoutSuccess',
+  'MicrosoftConfig',
   'MultimediaProfileResponse',
+  'OrgDesktopLoginResponse',
   'OrgInfo',
   'OrgSettings',
+  'OrgUrlMappings',
   'Profile',
   'ReloginSuccess',
   'RespondToWellnessBreakParams',
@@ -98,10 +101,10 @@ const EXPECTED_ROOT_EXPORTS = Object.freeze([
   'TeamList',
   'TenantData',
   'TransferPayLoad',
-  'URLMapping',
   'UpdateDeviceTypeResponse',
   'UpdateUserPreferenceRequest',
   'UploadLogsResponse',
+  'UserDesktopLoginResponse',
   'UserPreference',
   'UserPreferenceData',
   'UserStationLogin',
@@ -109,6 +112,7 @@ const EXPECTED_ROOT_EXPORTS = Object.freeze([
   'WELLNESS_BREAK_USER_ACTIONS',
   'WRAP_UP_CODE',
   'WebSocketEvent',
+  'WebexConfig',
   'WebexSDK',
   'WellnessBreakEvent',
   'WellnessBreakNotificationAction',