@webex/contact-center 3.11.0 → 3.12.0-auth-prejoin-fetch.1

package/dist/types/services/config/constants.d.ts

@@ -0,0 +1,273 @@
+export declare const DEFAULT_PAGE = 0;
+/** Desktop Profile access levels for collaboration destination categories. */
+export declare const COLLABORATION_ACCESS: {
+    readonly ALL: "ALL";
+    readonly SPECIFIC: "SPECIFIC";
+    readonly NONE: "NONE";
+};
+/**
+ * Default page size for paginated API requests.
+ * @type {number}
+ * @public
+ * @example
+ * const pageSize = DEFAULT_PAGE_SIZE; // 100
+ * @ignore
+ */
+export declare const DEFAULT_PAGE_SIZE = 100;
+/**
+ * Agent state ID for 'Available'.
+ * @type {string}
+ * @public
+ * @ignore
+ */
+export declare const AGENT_STATE_AVAILABLE_ID = "0";
+/**
+ * Agent state label for 'Available'.
+ * @type {string}
+ * @public
+ * @ignore
+ */
+export declare const AGENT_STATE_AVAILABLE = "Available";
+/**
+ * Description for the 'Available' agent state.
+ * @type {string}
+ * @public
+ * @ignore
+ */
+export declare const AGENT_STATE_AVAILABLE_DESCRIPTION = "Agent is available to receive calls";
+/**
+ * Default attributes for auxiliary code API requests.
+ * @type {string[]}
+ * @public
+ * @ignore
+ */
+export declare const DEFAULT_AUXCODE_ATTRIBUTES: string[];
+export declare const METHODS: {
+    GET_AGENT_CONFIG: string;
+    GET_USER_USING_CI: string;
+    GET_DESKTOP_PROFILE_BY_ID: string;
+    GET_MULTIMEDIA_PROFILE_BY_ID: string;
+    GET_LIST_OF_TEAMS: string;
+    GET_ALL_TEAMS: string;
+    GET_LIST_OF_AUX_CODES: string;
+    GET_ALL_AUX_CODES: string;
+    GET_SITE_INFO: string;
+    GET_ORG_INFO: string;
+    GET_ORGANIZATION_SETTING: string;
+    GET_TENANT_DATA: string;
+    GET_URL_MAPPING: string;
+    GET_DIAL_PLAN_DATA: string;
+    GET_AI_FEATURE_FLAGS: string;
+    GET_QUEUES: string;
+    PARSE_AGENT_CONFIGS: string;
+    GET_URL_MAPPING_UTIL: string;
+    GET_MSFT_CONFIG: string;
+    GET_WEBEX_CONFIG: string;
+    GET_DEFAULT_AGENT_DN: string;
+    GET_FILTERED_DIALPLAN_ENTRIES: string;
+    GET_FILTER_AUX_CODES: string;
+    GET_DEFAULT_WRAP_UP_CODE: string;
+};
+/**
+ * Maps API endpoint names to functions that generate endpoint URLs for various organization resources.
+ * @public
+ * @example
+ * const url = endPointMap.userByCI('org123', 'agent456');
+ */
+export declare const endPointMap: {
+    /**
+     * Gets the endpoint for a user by CI user ID.
+     * @param orgId - Organization ID.
+     * @param agentId - Agent ID.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.userByCI('org123', 'agent456');
+     * @ignore
+     */
+    userByCI: (orgId: string, agentId: string) => string;
+    /**
+     * Gets the endpoint for a desktop profile.
+     * @param orgId - Organization ID.
+     * @param desktopProfileId - Desktop profile ID.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.desktopProfile('org123', 'profile789');
+     * @ignore
+     */
+    desktopProfile: (orgId: string, desktopProfileId: string) => string;
+    /**
+     * Gets the endpoint for a multimedia profile.
+     * @param orgId - Organization ID.
+     * @param multimediaProfileId - Multimedia profile ID.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.multimediaProfile('org123', 'multi456');
+     * @ignore
+     */
+    multimediaProfile: (orgId: string, multimediaProfileId: string) => string;
+    /**
+     * Gets the endpoint for listing teams with optional filters.
+     * @param orgId - Organization ID.
+     * @param page - Page number.
+     * @param pageSize - Page size.
+     * @param filter - Array of team IDs to filter.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.listTeams('org123', 0, 100, ['team1', 'team2']);
+     * @ignore
+     */
+    listTeams: (orgId: string, page: number, pageSize: number, filter: string[]) => string;
+    /**
+     * Gets the endpoint for listing auxiliary codes with optional filters and attributes.
+     * @param orgId - Organization ID.
+     * @param page - Page number.
+     * @param pageSize - Page size.
+     * @param filter - Array of auxiliary code IDs to filter.
+     * @param attributes - Array of attribute names to include.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.listAuxCodes('org123', 0, 100, ['aux1'], ['id', 'name']);
+     * @ignore
+     */
+    listAuxCodes: (orgId: string, page: number, pageSize: number, filter: string[], attributes: string[]) => string;
+    /**
+     * Gets the endpoint for organization info.
+     * @param orgId - Organization ID.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.orgInfo('org123');
+     * @ignore
+     */
+    orgInfo: (orgId: string) => string;
+    /**
+     * Gets the endpoint for organization settings.
+     * @param orgId - Organization ID.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.orgSettings('org123');
+     * @ignore
+     */
+    orgSettings: (orgId: string) => string;
+    /**
+     * Gets the endpoint for site info.
+     * @param orgId - Organization ID.
+     * @param siteId - Site ID.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.siteInfo('org123', 'site456');
+     * @ignore
+     */
+    siteInfo: (orgId: string, siteId: string) => string;
+    /**
+     * Gets the endpoint for tenant configuration data.
+     * @param orgId - Organization ID.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.tenantData('org123');
+     * @ignore
+     */
+    tenantData: (orgId: string) => string;
+    /**
+     * Gets the endpoint for organization URL mapping.
+     * @param orgId - Organization ID.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.urlMapping('org123');
+     * @ignore
+     */
+    urlMapping: (orgId: string) => string;
+    /**
+     * Gets the endpoint for dial plan.
+     * @param orgId - Organization ID.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.dialPlan('org123');
+     * @ignore
+     */
+    dialPlan: (orgId: string) => string;
+    /**
+     * Gets the endpoint for listing AI feature flags.
+     * @param orgId - Organization ID.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.aiFeatureFlags('org123');
+     * @ignore
+     */
+    aiFeature: (orgId: string) => string;
+    /**
+     * Gets the endpoint for the queue list with custom query parameters.
+     * @param orgId - Organization ID.
+     * @param queryParams - Query parameters string.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.queueList('org123', 'page=0&pageSize=10');
+     * @ignore
+     */
+    queueList: (orgId: string, queryParams: string) => string;
+    /**
+     * Gets the desktop-profile-filtered dial-number mappings used by entry-point destination lists.
+     * @param orgId - Organization ID.
+     * @param queryParams - Query parameters string.
+     * @returns The endpoint URL string.
+     * @ignore
+     */
+    entryPointDialNumberList: (orgId: string, queryParams: string) => string;
+    /**
+     * Gets the endpoint for address book entries with custom query parameters.
+     * @param orgId - Organization ID.
+     * @param addressBookId - Address book ID.
+     * @param queryParams - Query parameters string.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.addressBookEntries('org123', 'book456', 'page=0&pageSize=10');
+     * @ignore
+     */
+    addressBookEntries: (orgId: string, addressBookId: string, queryParams: string) => string;
+    /**
+     * Gets the endpoint for outdial ANI entries with custom query parameters.
+     * @param orgId - Organization ID.
+     * @param outdialANI - Outdial ANI ID.
+     * @param queryParams - Query parameters string.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.outdialAniEntries('org123', 'ani456', 'page=0&pageSize=10');
+     * @ignore
+     */
+    outdialAniEntries: (orgId: string, outdialANI: string, queryParams: string) => string;
+    /**
+     * Gets the endpoint for user preference by user ID.
+     * @param orgId - Organization ID.
+     * @param userId - User ID.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.userPreference('org123', 'user456');
+     * @ignore
+     */
+    userPreference: (orgId: string, userId: string) => string;
+    /**
+     * Gets the endpoint for creating user preference.
+     * @param orgId - Organization ID.
+     * @returns The endpoint URL string.
+     * @public
+     * @example
+     * const url = endPointMap.userPreferenceCreate('org123');
+     * @ignore
+     */
+    userPreferenceCreate: (orgId: string) => string;
+};

package/dist/types/services/config/index.d.ts

@@ -0,0 +1,177 @@
+/**
+ * @packageDocumentation
+ * @module AgentConfigService
+ */
+import { DesktopProfileResponse, ListAuxCodesResponse, AgentResponse, TenantData, OrgInfo, OrgSettings, URLMapping, TeamList, DialPlanEntity, Profile, ListTeamsResponse, AuxCode, MultimediaProfileResponse, SiteInfo, OutdialAniEntriesResponse, OutdialAniParams, AIFeatureFlagsResponse } from './types';
+/**
+ * The AgentConfigService class provides methods to fetch agent configuration data.
+ * @private
+ * @ignore
+ */
+export default class AgentConfigService {
+    private webexReq;
+    constructor();
+    /**
+     * Fetches the agent configuration data for the given orgId and agentId.
+     * @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<Profile>} - A promise that resolves to the agent configuration profile.
+     * @throws {Error} - Throws an error if any API call fails or if the response status is not 200.
+     * @public
+     */
+    getAgentConfig(orgId: string, agentId: string): Promise<Profile>;
+    /**
+     * Fetches the agent configuration data for the given orgId and agentId.
+     * @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.
+     * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
+     * @private
+     */
+    getUserUsingCI(orgId: string, agentId: string): Promise<AgentResponse>;
+    /**
+     * Fetches the desktop profile data for the given orgId and desktopProfileId.
+     * @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.
+     * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
+     * @private
+     */
+    getDesktopProfileById(orgId: string, desktopProfileId: string): Promise<DesktopProfileResponse>;
+    /**
+     * Fetches the multimedia profile data for the given orgId and multimediaProfileId.
+     * @ignore
+     * @param {string} orgId - organization ID for which the multimedia profile is to be fetched.
+     * @param {string} multimediaProfileId - multimedia profile ID for which the data is to be fetched.
+     * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
+     * @returns {Promise<MultimediaProfileResponse>} - A promise that resolves to the multimedia profile response.
+     * @private
+     */
+    getMultimediaProfileById(orgId: string, multimediaProfileId: string): Promise<MultimediaProfileResponse>;
+    /**
+     * fetches the list of teams for the given orgId.
+     * @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.
+     * @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
+     */
+    getListOfTeams(orgId: string, page: number, pageSize: number, filter: string[]): Promise<ListTeamsResponse>;
+    /**
+     * Fetches all teams from all pages for the given orgId
+     * @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.
+     * @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
+     */
+    getAllTeams(orgId: string, pageSize: number, filter: string[]): Promise<TeamList[]>;
+    /**
+     *  fetches the list of aux codes for the given orgId.
+     * @ignore
+     * @param {string} orgId - organization ID for which the aux codes are to be fetched.
+     * @param {number} page - the page number to fetch.
+     * @param {number} pageSize - the number of aux codes to fetch per page.
+     * @param {string[]} filter - optional filter criteria for the aux codes.
+     * @param {string[]} attributes - optional attributes to include in the response.
+     * @returns {Promise<ListAuxCodesResponse>} - A promise that resolves to the list of aux codes response.
+     * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
+     * @private
+     */
+    getListOfAuxCodes(orgId: string, page: number, pageSize: number, filter: string[], attributes: string[]): Promise<ListAuxCodesResponse>;
+    /**
+     * Fetches all aux codes from all pages for the given orgId
+     * @ignore
+     * @param {string} orgId - organization ID for which the aux codes are to be fetched.
+     * @param {number} pageSize - the number of aux codes to fetch per page.
+     * @param {string[]} filter - optional filter criteria for the aux codes.
+     * @param {string[]} attributes - optional attributes to include in the response.
+     * @returns {Promise<AuxCode[]>} - A promise that resolves to the list of aux codes.
+     * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
+     * @private
+     */
+    getAllAuxCodes(orgId: string, pageSize: number, filter: string[], attributes: string[]): Promise<AuxCode[]>;
+    /**
+     * 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
+     */
+    getSiteInfo(orgId: string, siteId: string): Promise<SiteInfo>;
+    /**
+     * 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
+     */
+    getOrgInfo(orgId: string): Promise<OrgInfo>;
+    /**
+     * 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
+     */
+    getOrganizationSetting(orgId: string): Promise<OrgSettings>;
+    /**
+     * 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
+     */
+    getTenantData(orgId: string): Promise<TenantData>;
+    /**
+     * 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
+     */
+    getURLMapping(orgId: string): Promise<URLMapping[]>;
+    /**
+     * Fetches AI feature resources for the organization.
+     * @ignore
+     * @param {string} orgId - organization ID for which AI feature resources are to be fetched.
+     * @returns {Promise<AIFeatureFlagsResponse>} - AI feature resources response.
+     * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
+     * @private
+     */
+    getAIFeatureFlags(orgId: string): Promise<AIFeatureFlagsResponse>;
+    /**
+     * Fetches the dial plan data for the given orgId.
+     * @ignore
+     * @param {string} orgId - organization ID for which the dial plan data is to be fetched.
+     * @returns {Promise<DialPlanEntity[]>} - A promise that resolves to the dial plan data response.
+     * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
+     * @private
+     */
+    getDialPlanData(orgId: string): Promise<DialPlanEntity[]>;
+    /**
+     * Fetches outdial ANI (Automatic Number Identification) entries for the given orgId and outdial ANI ID.
+     * @ignore
+     * @param {string} orgId - organization ID for which the outdial ANI entries are to be fetched.
+     * @param {OutdialAniParams} params - parameters object containing outdialANI and optional pagination/filtering options
+     * @returns {Promise<OutdialAniEntriesResponse>} - A promise that resolves to the outdial ANI entries response.
+     * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
+     * @private
+     */
+    getOutdialAniEntries(orgId: string, params: OutdialAniParams): Promise<OutdialAniEntriesResponse>;
+}