@webex/contact-center 3.11.0 → 3.12.0

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>;
+}