purecloud-platform-client-v2 249.0.0 → 250.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 +34 -3
- package/dist/node/purecloud-platform-client-v2.js +20042 -5569
- package/dist/web-amd/purecloud-platform-client-v2.js +20042 -5569
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +11159 -5369
- package/dist/web-cjs/purecloud-platform-client-v2.js +11159 -5369
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +10600 -2242
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +26 -2
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +136 -40
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +130 -39
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +18 -6
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +29 -9
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +86 -26
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +917 -224
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +754 -226
- package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +36 -11
- package/src/purecloud-platform-client-v2/api/AuditApi.js +38 -12
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +302 -91
- package/src/purecloud-platform-client-v2/api/BackgroundAssistantApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/BillingApi.js +41 -13
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +180 -53
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +11 -4
- package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +187 -56
- package/src/purecloud-platform-client-v2/api/ChatApi.js +223 -65
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +124 -37
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +165 -51
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1992 -578
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +22 -7
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +39 -12
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +4 -2
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +28 -9
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +35 -11
- package/src/purecloud-platform-client-v2/api/EventsApi.js +22 -7
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +700 -206
- package/src/purecloud-platform-client-v2/api/FaxApi.js +49 -15
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +42 -13
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +419 -125
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +21 -7
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +29 -9
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +106 -32
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +103 -31
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +267 -77
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +20 -7
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +461 -139
- package/src/purecloud-platform-client-v2/api/IntentsApi.js +93 -28
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +872 -120
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +618 -185
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +221 -66
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +53 -16
- package/src/purecloud-platform-client-v2/api/LearningApi.js +199 -60
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +51 -16
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +45 -14
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +34 -11
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +84 -25
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +28 -9
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +41 -13
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +72 -22
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +58 -18
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +21 -7
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +122 -36
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +297 -87
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1066 -312
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +162 -48
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +41 -13
- package/src/purecloud-platform-client-v2/api/QualityApi.js +409 -121
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +351 -108
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +113 -34
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +964 -284
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +123 -39
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +50 -17
- package/src/purecloud-platform-client-v2/api/SearchApi.js +147 -44
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +87 -26
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +208 -67
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +389 -114
- package/src/purecloud-platform-client-v2/api/StationsApi.js +18 -6
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +13 -5
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +473 -138
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +55 -17
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +80 -24
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +751 -220
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +25 -8
- package/src/purecloud-platform-client-v2/api/TokensApi.js +35 -11
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +78 -23
- package/src/purecloud-platform-client-v2/api/UsageApi.js +62 -19
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +27 -9
- package/src/purecloud-platform-client-v2/api/UsersApi.js +717 -228
- package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +52 -16
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +25 -8
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +154 -46
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +126 -37
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +120 -36
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +25 -8
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +36 -11
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +2475 -577
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5,7 +5,7 @@ class AssistantCopilotVariationsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* AssistantCopilotVariations service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/AssistantCopilotVariationsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 250.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -25,8 +25,12 @@ class AssistantCopilotVariationsApi {
|
|
|
25
25
|
*
|
|
26
26
|
* @param {String} assistantId Assistant ID
|
|
27
27
|
* @param {String} variationId Variation ID
|
|
28
|
+
* @param {Object} opts Optional parameters
|
|
29
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
28
30
|
*/
|
|
29
|
-
deleteAssistantVariation(assistantId, variationId) {
|
|
31
|
+
deleteAssistantVariation(assistantId, variationId, opts) {
|
|
32
|
+
opts = opts || {};
|
|
33
|
+
|
|
30
34
|
// verify the required parameter 'assistantId' is set
|
|
31
35
|
if (assistantId === undefined || assistantId === null || assistantId === '') {
|
|
32
36
|
throw 'Missing the required parameter "assistantId" when calling deleteAssistantVariation';
|
|
@@ -46,7 +50,8 @@ class AssistantCopilotVariationsApi {
|
|
|
46
50
|
null,
|
|
47
51
|
['PureCloud OAuth'],
|
|
48
52
|
['application/json'],
|
|
49
|
-
['application/json']
|
|
53
|
+
['application/json'],
|
|
54
|
+
opts['customHeaders']
|
|
50
55
|
);
|
|
51
56
|
}
|
|
52
57
|
|
|
@@ -55,8 +60,12 @@ class AssistantCopilotVariationsApi {
|
|
|
55
60
|
*
|
|
56
61
|
* @param {String} assistantId Assistant ID
|
|
57
62
|
* @param {String} variationId Variation ID
|
|
63
|
+
* @param {Object} opts Optional parameters
|
|
64
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
58
65
|
*/
|
|
59
|
-
getAssistantVariation(assistantId, variationId) {
|
|
66
|
+
getAssistantVariation(assistantId, variationId, opts) {
|
|
67
|
+
opts = opts || {};
|
|
68
|
+
|
|
60
69
|
// verify the required parameter 'assistantId' is set
|
|
61
70
|
if (assistantId === undefined || assistantId === null || assistantId === '') {
|
|
62
71
|
throw 'Missing the required parameter "assistantId" when calling getAssistantVariation';
|
|
@@ -76,7 +85,8 @@ class AssistantCopilotVariationsApi {
|
|
|
76
85
|
null,
|
|
77
86
|
['PureCloud OAuth'],
|
|
78
87
|
['application/json'],
|
|
79
|
-
['application/json']
|
|
88
|
+
['application/json'],
|
|
89
|
+
opts['customHeaders']
|
|
80
90
|
);
|
|
81
91
|
}
|
|
82
92
|
|
|
@@ -84,8 +94,12 @@ class AssistantCopilotVariationsApi {
|
|
|
84
94
|
* Get variations of an assistant copilot
|
|
85
95
|
*
|
|
86
96
|
* @param {String} assistantId Assistant ID
|
|
97
|
+
* @param {Object} opts Optional parameters
|
|
98
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
87
99
|
*/
|
|
88
|
-
getAssistantVariations(assistantId) {
|
|
100
|
+
getAssistantVariations(assistantId, opts) {
|
|
101
|
+
opts = opts || {};
|
|
102
|
+
|
|
89
103
|
// verify the required parameter 'assistantId' is set
|
|
90
104
|
if (assistantId === undefined || assistantId === null || assistantId === '') {
|
|
91
105
|
throw 'Missing the required parameter "assistantId" when calling getAssistantVariations';
|
|
@@ -101,7 +115,8 @@ class AssistantCopilotVariationsApi {
|
|
|
101
115
|
null,
|
|
102
116
|
['PureCloud OAuth'],
|
|
103
117
|
['application/json'],
|
|
104
|
-
['application/json']
|
|
118
|
+
['application/json'],
|
|
119
|
+
opts['customHeaders']
|
|
105
120
|
);
|
|
106
121
|
}
|
|
107
122
|
|
|
@@ -110,8 +125,12 @@ class AssistantCopilotVariationsApi {
|
|
|
110
125
|
*
|
|
111
126
|
* @param {String} assistantId Assistant ID
|
|
112
127
|
* @param {Object} body
|
|
128
|
+
* @param {Object} opts Optional parameters
|
|
129
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
113
130
|
*/
|
|
114
|
-
postAssistantVariations(assistantId, body) {
|
|
131
|
+
postAssistantVariations(assistantId, body, opts) {
|
|
132
|
+
opts = opts || {};
|
|
133
|
+
|
|
115
134
|
// verify the required parameter 'assistantId' is set
|
|
116
135
|
if (assistantId === undefined || assistantId === null || assistantId === '') {
|
|
117
136
|
throw 'Missing the required parameter "assistantId" when calling postAssistantVariations';
|
|
@@ -131,7 +150,8 @@ class AssistantCopilotVariationsApi {
|
|
|
131
150
|
body,
|
|
132
151
|
['PureCloud OAuth'],
|
|
133
152
|
['application/json'],
|
|
134
|
-
['application/json']
|
|
153
|
+
['application/json'],
|
|
154
|
+
opts['customHeaders']
|
|
135
155
|
);
|
|
136
156
|
}
|
|
137
157
|
|
|
@@ -141,8 +161,12 @@ class AssistantCopilotVariationsApi {
|
|
|
141
161
|
* @param {String} assistantId Assistant ID
|
|
142
162
|
* @param {String} variationId Variation ID
|
|
143
163
|
* @param {Object} body
|
|
164
|
+
* @param {Object} opts Optional parameters
|
|
165
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
144
166
|
*/
|
|
145
|
-
putAssistantVariation(assistantId, variationId, body) {
|
|
167
|
+
putAssistantVariation(assistantId, variationId, body, opts) {
|
|
168
|
+
opts = opts || {};
|
|
169
|
+
|
|
146
170
|
// verify the required parameter 'assistantId' is set
|
|
147
171
|
if (assistantId === undefined || assistantId === null || assistantId === '') {
|
|
148
172
|
throw 'Missing the required parameter "assistantId" when calling putAssistantVariation';
|
|
@@ -166,7 +190,8 @@ class AssistantCopilotVariationsApi {
|
|
|
166
190
|
body,
|
|
167
191
|
['PureCloud OAuth'],
|
|
168
192
|
['application/json'],
|
|
169
|
-
['application/json']
|
|
193
|
+
['application/json'],
|
|
194
|
+
opts['customHeaders']
|
|
170
195
|
);
|
|
171
196
|
}
|
|
172
197
|
|
|
@@ -5,7 +5,7 @@ class AuditApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Audit service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 250.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -23,8 +23,12 @@ class AuditApi {
|
|
|
23
23
|
/**
|
|
24
24
|
* Get service mapping information used in realtime audits.
|
|
25
25
|
*
|
|
26
|
+
* @param {Object} opts Optional parameters
|
|
27
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
26
28
|
*/
|
|
27
|
-
getAuditsQueryRealtimeServicemapping() {
|
|
29
|
+
getAuditsQueryRealtimeServicemapping(opts) {
|
|
30
|
+
opts = opts || {};
|
|
31
|
+
|
|
28
32
|
|
|
29
33
|
return this.apiClient.callApi(
|
|
30
34
|
'/api/v2/audits/query/realtime/servicemapping',
|
|
@@ -36,15 +40,20 @@ class AuditApi {
|
|
|
36
40
|
null,
|
|
37
41
|
['PureCloud OAuth'],
|
|
38
42
|
['application/json'],
|
|
39
|
-
['application/json']
|
|
43
|
+
['application/json'],
|
|
44
|
+
opts['customHeaders']
|
|
40
45
|
);
|
|
41
46
|
}
|
|
42
47
|
|
|
43
48
|
/**
|
|
44
49
|
* Get service mapping information used in audits.
|
|
45
50
|
*
|
|
51
|
+
* @param {Object} opts Optional parameters
|
|
52
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
46
53
|
*/
|
|
47
|
-
getAuditsQueryServicemapping() {
|
|
54
|
+
getAuditsQueryServicemapping(opts) {
|
|
55
|
+
opts = opts || {};
|
|
56
|
+
|
|
48
57
|
|
|
49
58
|
return this.apiClient.callApi(
|
|
50
59
|
'/api/v2/audits/query/servicemapping',
|
|
@@ -56,7 +65,8 @@ class AuditApi {
|
|
|
56
65
|
null,
|
|
57
66
|
['PureCloud OAuth'],
|
|
58
67
|
['application/json'],
|
|
59
|
-
['application/json']
|
|
68
|
+
['application/json'],
|
|
69
|
+
opts['customHeaders']
|
|
60
70
|
);
|
|
61
71
|
}
|
|
62
72
|
|
|
@@ -64,8 +74,12 @@ class AuditApi {
|
|
|
64
74
|
* Get status of audit query execution
|
|
65
75
|
*
|
|
66
76
|
* @param {String} transactionId Transaction ID
|
|
77
|
+
* @param {Object} opts Optional parameters
|
|
78
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
67
79
|
*/
|
|
68
|
-
getAuditsQueryTransactionId(transactionId) {
|
|
80
|
+
getAuditsQueryTransactionId(transactionId, opts) {
|
|
81
|
+
opts = opts || {};
|
|
82
|
+
|
|
69
83
|
// verify the required parameter 'transactionId' is set
|
|
70
84
|
if (transactionId === undefined || transactionId === null || transactionId === '') {
|
|
71
85
|
throw 'Missing the required parameter "transactionId" when calling getAuditsQueryTransactionId';
|
|
@@ -81,7 +95,8 @@ class AuditApi {
|
|
|
81
95
|
null,
|
|
82
96
|
['PureCloud OAuth'],
|
|
83
97
|
['application/json'],
|
|
84
|
-
['application/json']
|
|
98
|
+
['application/json'],
|
|
99
|
+
opts['customHeaders']
|
|
85
100
|
);
|
|
86
101
|
}
|
|
87
102
|
|
|
@@ -94,6 +109,7 @@ class AuditApi {
|
|
|
94
109
|
* @param {Number} opts.pageSize Indicates maximum number of results in response. Default page size is 25 results. The maximum page size is 500. (default to 25)
|
|
95
110
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
96
111
|
* @param {Boolean} opts.allowRedirect Result sets with large amounts of data will respond with a download url
|
|
112
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
97
113
|
*/
|
|
98
114
|
getAuditsQueryTransactionIdResults(transactionId, opts) {
|
|
99
115
|
opts = opts || {};
|
|
@@ -113,7 +129,8 @@ class AuditApi {
|
|
|
113
129
|
null,
|
|
114
130
|
['PureCloud OAuth'],
|
|
115
131
|
['application/json'],
|
|
116
|
-
['application/json']
|
|
132
|
+
['application/json'],
|
|
133
|
+
opts['customHeaders']
|
|
117
134
|
);
|
|
118
135
|
}
|
|
119
136
|
|
|
@@ -121,8 +138,12 @@ class AuditApi {
|
|
|
121
138
|
* Create audit query execution
|
|
122
139
|
* Use /api/v2/audits/query/servicemapping endpoint for a list of valid values
|
|
123
140
|
* @param {Object} body query
|
|
141
|
+
* @param {Object} opts Optional parameters
|
|
142
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
124
143
|
*/
|
|
125
|
-
postAuditsQuery(body) {
|
|
144
|
+
postAuditsQuery(body, opts) {
|
|
145
|
+
opts = opts || {};
|
|
146
|
+
|
|
126
147
|
// verify the required parameter 'body' is set
|
|
127
148
|
if (body === undefined || body === null) {
|
|
128
149
|
throw 'Missing the required parameter "body" when calling postAuditsQuery';
|
|
@@ -138,7 +159,8 @@ class AuditApi {
|
|
|
138
159
|
body,
|
|
139
160
|
['PureCloud OAuth'],
|
|
140
161
|
['application/json'],
|
|
141
|
-
['application/json']
|
|
162
|
+
['application/json'],
|
|
163
|
+
opts['customHeaders']
|
|
142
164
|
);
|
|
143
165
|
}
|
|
144
166
|
|
|
@@ -148,6 +170,7 @@ class AuditApi {
|
|
|
148
170
|
* @param {Object} body query
|
|
149
171
|
* @param {Object} opts Optional parameters
|
|
150
172
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
173
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
151
174
|
*/
|
|
152
175
|
postAuditsQueryRealtime(body, opts) {
|
|
153
176
|
opts = opts || {};
|
|
@@ -167,7 +190,8 @@ class AuditApi {
|
|
|
167
190
|
body,
|
|
168
191
|
['PureCloud OAuth'],
|
|
169
192
|
['application/json'],
|
|
170
|
-
['application/json']
|
|
193
|
+
['application/json'],
|
|
194
|
+
opts['customHeaders']
|
|
171
195
|
);
|
|
172
196
|
}
|
|
173
197
|
|
|
@@ -177,6 +201,7 @@ class AuditApi {
|
|
|
177
201
|
* @param {Object} body query
|
|
178
202
|
* @param {Object} opts Optional parameters
|
|
179
203
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
204
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
180
205
|
*/
|
|
181
206
|
postAuditsQueryRealtimeRelated(body, opts) {
|
|
182
207
|
opts = opts || {};
|
|
@@ -196,7 +221,8 @@ class AuditApi {
|
|
|
196
221
|
body,
|
|
197
222
|
['PureCloud OAuth'],
|
|
198
223
|
['application/json'],
|
|
199
|
-
['application/json']
|
|
224
|
+
['application/json'],
|
|
225
|
+
opts['customHeaders']
|
|
200
226
|
);
|
|
201
227
|
}
|
|
202
228
|
|