@wxcc-desktop/sdk 1.3.16 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +54 -29
- package/dist/index.js +1 -1
- package/dist/types/jsapi/config-jsapi.d.ts +41 -1
- package/package.json +1 -1
|
@@ -5,7 +5,28 @@ declare type Listeners = {
|
|
|
5
5
|
cleaned: () => void;
|
|
6
6
|
};
|
|
7
7
|
declare type Events = keyof Listeners;
|
|
8
|
+
declare type ConfigType = {
|
|
9
|
+
/**
|
|
10
|
+
* Name of the widget
|
|
11
|
+
*/
|
|
12
|
+
widgetName: string;
|
|
13
|
+
/**
|
|
14
|
+
* Name of the widget provider/owner/customer
|
|
15
|
+
*/
|
|
16
|
+
widgetProvider: string;
|
|
17
|
+
};
|
|
18
|
+
declare type CrmConnectorProvider = {
|
|
19
|
+
/**
|
|
20
|
+
* Name of the CRM provider, e.g. "salesforce", "microsoft-dynamics", "oracle", "sap", "zendesk", "freshdesk", "freshservice", "freshsales", "hubspot", "pipedrive"
|
|
21
|
+
*/
|
|
22
|
+
crmPlatform?: string;
|
|
23
|
+
/**
|
|
24
|
+
* Name of the CRM connector provider, e.g. "cisco"
|
|
25
|
+
*/
|
|
26
|
+
crmConnectorProvider?: string;
|
|
27
|
+
};
|
|
8
28
|
export declare class ConfigJsApi {
|
|
29
|
+
private initEventType;
|
|
9
30
|
private readonly emitter;
|
|
10
31
|
private readonly logger;
|
|
11
32
|
private agentxSERVICE?;
|
|
@@ -16,7 +37,26 @@ export declare class ConfigJsApi {
|
|
|
16
37
|
});
|
|
17
38
|
private checkService;
|
|
18
39
|
private emit;
|
|
19
|
-
|
|
40
|
+
/**
|
|
41
|
+
* initialize wxcc-desktop js sdk
|
|
42
|
+
* @param config
|
|
43
|
+
* @example
|
|
44
|
+
* ``
|
|
45
|
+
* Desktop.config.init({widgetName: "widgetName", widgetProvider: "widgetProvider"});
|
|
46
|
+
* `ts
|
|
47
|
+
*/
|
|
48
|
+
init(config: ConfigType): Promise<void>;
|
|
49
|
+
/**
|
|
50
|
+
* Register CRM Connector
|
|
51
|
+
* @param provider
|
|
52
|
+
* @example
|
|
53
|
+
* ``
|
|
54
|
+
* Desktop.config.init({widgetName: "widgetName", widgetProvider: "widgetProvider"});
|
|
55
|
+
* config.registerCrmConnector({ crmConnectorProvider: "Cisco", crmPlatform: "SFDC"});
|
|
56
|
+
* `ts
|
|
57
|
+
*/
|
|
58
|
+
registerCrmConnector(provider: CrmConnectorProvider): void;
|
|
59
|
+
private publishEvent;
|
|
20
60
|
cleanup(): void;
|
|
21
61
|
get clientLocale(): string;
|
|
22
62
|
addEventListener<T extends Events>(eventName: T, listener: Listeners[T]): void;
|