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 BackgroundAssistantApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* BackgroundAssistant service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/BackgroundAssistantApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 250.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -25,6 +25,7 @@ class BackgroundAssistantApi {
|
|
|
25
25
|
*
|
|
26
26
|
* @param {Object} opts Optional parameters
|
|
27
27
|
* @param {Object} opts.body
|
|
28
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
28
29
|
* postBackgroundassistantToken is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
29
30
|
*/
|
|
30
31
|
postBackgroundassistantToken(opts) {
|
|
@@ -41,7 +42,8 @@ class BackgroundAssistantApi {
|
|
|
41
42
|
opts['body'],
|
|
42
43
|
['PureCloud OAuth'],
|
|
43
44
|
['application/json'],
|
|
44
|
-
['application/json']
|
|
45
|
+
['application/json'],
|
|
46
|
+
opts['customHeaders']
|
|
45
47
|
);
|
|
46
48
|
}
|
|
47
49
|
|
|
@@ -50,6 +52,7 @@ class BackgroundAssistantApi {
|
|
|
50
52
|
*
|
|
51
53
|
* @param {Object} opts Optional parameters
|
|
52
54
|
* @param {Object} opts.body
|
|
55
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
53
56
|
*/
|
|
54
57
|
postScreenrecordingToken(opts) {
|
|
55
58
|
opts = opts || {};
|
|
@@ -65,7 +68,8 @@ class BackgroundAssistantApi {
|
|
|
65
68
|
opts['body'],
|
|
66
69
|
['PureCloud OAuth'],
|
|
67
70
|
['application/json'],
|
|
68
|
-
['application/json']
|
|
71
|
+
['application/json'],
|
|
72
|
+
opts['customHeaders']
|
|
69
73
|
);
|
|
70
74
|
}
|
|
71
75
|
|
|
@@ -5,7 +5,7 @@ class BillingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Billing service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 250.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -24,9 +24,13 @@ class BillingApi {
|
|
|
24
24
|
* Get billing contract
|
|
25
25
|
* Retrieve a single contract from the system.
|
|
26
26
|
* @param {String} contractId The contract number.
|
|
27
|
+
* @param {Object} opts Optional parameters
|
|
28
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27
29
|
* getBillingContract is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
28
30
|
*/
|
|
29
|
-
getBillingContract(contractId) {
|
|
31
|
+
getBillingContract(contractId, opts) {
|
|
32
|
+
opts = opts || {};
|
|
33
|
+
|
|
30
34
|
// verify the required parameter 'contractId' is set
|
|
31
35
|
if (contractId === undefined || contractId === null || contractId === '') {
|
|
32
36
|
throw 'Missing the required parameter "contractId" when calling getBillingContract';
|
|
@@ -42,7 +46,8 @@ class BillingApi {
|
|
|
42
46
|
null,
|
|
43
47
|
['PureCloud OAuth'],
|
|
44
48
|
['application/json'],
|
|
45
|
-
['application/json']
|
|
49
|
+
['application/json'],
|
|
50
|
+
opts['customHeaders']
|
|
46
51
|
);
|
|
47
52
|
}
|
|
48
53
|
|
|
@@ -51,9 +56,13 @@ class BillingApi {
|
|
|
51
56
|
* Fetch the billing information for a given Organization by billing period.
|
|
52
57
|
* @param {String} contractId The contract number.
|
|
53
58
|
* @param {String} billingPeriodId The Billing Period Id for the Org.
|
|
59
|
+
* @param {Object} opts Optional parameters
|
|
60
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
54
61
|
* getBillingContractBillingperiod is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
55
62
|
*/
|
|
56
|
-
getBillingContractBillingperiod(contractId, billingPeriodId) {
|
|
63
|
+
getBillingContractBillingperiod(contractId, billingPeriodId, opts) {
|
|
64
|
+
opts = opts || {};
|
|
65
|
+
|
|
57
66
|
// verify the required parameter 'contractId' is set
|
|
58
67
|
if (contractId === undefined || contractId === null || contractId === '') {
|
|
59
68
|
throw 'Missing the required parameter "contractId" when calling getBillingContractBillingperiod';
|
|
@@ -73,7 +82,8 @@ class BillingApi {
|
|
|
73
82
|
null,
|
|
74
83
|
['PureCloud OAuth'],
|
|
75
84
|
['application/json'],
|
|
76
|
-
['application/json']
|
|
85
|
+
['application/json'],
|
|
86
|
+
opts['customHeaders']
|
|
77
87
|
);
|
|
78
88
|
}
|
|
79
89
|
|
|
@@ -88,6 +98,7 @@ class BillingApi {
|
|
|
88
98
|
* @param {String} opts.dateEnd End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
89
99
|
* @param {Object} opts.status Filter by the status of contracts
|
|
90
100
|
* @param {String} opts.externalNumber Filter by the unique external number.
|
|
101
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
91
102
|
* getBillingContracts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
92
103
|
*/
|
|
93
104
|
getBillingContracts(opts) {
|
|
@@ -104,7 +115,8 @@ class BillingApi {
|
|
|
104
115
|
null,
|
|
105
116
|
['PureCloud OAuth'],
|
|
106
117
|
['application/json'],
|
|
107
|
-
['application/json']
|
|
118
|
+
['application/json'],
|
|
119
|
+
opts['customHeaders']
|
|
108
120
|
);
|
|
109
121
|
}
|
|
110
122
|
|
|
@@ -112,9 +124,13 @@ class BillingApi {
|
|
|
112
124
|
* Get invoice document
|
|
113
125
|
* Fetch the document for a specific invoice.
|
|
114
126
|
* @param {String} invoiceId invoiceId
|
|
127
|
+
* @param {Object} opts Optional parameters
|
|
128
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
115
129
|
* getBillingContractsInvoiceDocument is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
116
130
|
*/
|
|
117
|
-
getBillingContractsInvoiceDocument(invoiceId) {
|
|
131
|
+
getBillingContractsInvoiceDocument(invoiceId, opts) {
|
|
132
|
+
opts = opts || {};
|
|
133
|
+
|
|
118
134
|
// verify the required parameter 'invoiceId' is set
|
|
119
135
|
if (invoiceId === undefined || invoiceId === null || invoiceId === '') {
|
|
120
136
|
throw 'Missing the required parameter "invoiceId" when calling getBillingContractsInvoiceDocument';
|
|
@@ -130,7 +146,8 @@ class BillingApi {
|
|
|
130
146
|
null,
|
|
131
147
|
['PureCloud OAuth'],
|
|
132
148
|
['application/json'],
|
|
133
|
-
['application/json']
|
|
149
|
+
['application/json'],
|
|
150
|
+
opts['customHeaders']
|
|
134
151
|
);
|
|
135
152
|
}
|
|
136
153
|
|
|
@@ -142,6 +159,7 @@ class BillingApi {
|
|
|
142
159
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
143
160
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
144
161
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
162
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
145
163
|
* getBillingContractsInvoiceLines is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
146
164
|
*/
|
|
147
165
|
getBillingContractsInvoiceLines(invoiceId, opts) {
|
|
@@ -162,7 +180,8 @@ class BillingApi {
|
|
|
162
180
|
null,
|
|
163
181
|
['PureCloud OAuth'],
|
|
164
182
|
['application/json'],
|
|
165
|
-
['application/json']
|
|
183
|
+
['application/json'],
|
|
184
|
+
opts['customHeaders']
|
|
166
185
|
);
|
|
167
186
|
}
|
|
168
187
|
|
|
@@ -176,6 +195,7 @@ class BillingApi {
|
|
|
176
195
|
* @param {String} opts.dateStart Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
177
196
|
* @param {String} opts.dateEnd End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
178
197
|
* @param {Object} opts.paymentStatus Payment Status
|
|
198
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
179
199
|
* getBillingContractsInvoices is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
180
200
|
*/
|
|
181
201
|
getBillingContractsInvoices(opts) {
|
|
@@ -192,7 +212,8 @@ class BillingApi {
|
|
|
192
212
|
null,
|
|
193
213
|
['PureCloud OAuth'],
|
|
194
214
|
['application/json'],
|
|
195
|
-
['application/json']
|
|
215
|
+
['application/json'],
|
|
216
|
+
opts['customHeaders']
|
|
196
217
|
);
|
|
197
218
|
}
|
|
198
219
|
|
|
@@ -201,8 +222,12 @@ class BillingApi {
|
|
|
201
222
|
* Report is of the billable usages (e.g. licenses and devices utilized) for a given period. If responses status is InProgress, wait a few seconds, then try the same request again.
|
|
202
223
|
* @param {Date} startDate The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
203
224
|
* @param {Date} endDate The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
225
|
+
* @param {Object} opts Optional parameters
|
|
226
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
204
227
|
*/
|
|
205
|
-
getBillingReportsBillableusage(startDate, endDate) {
|
|
228
|
+
getBillingReportsBillableusage(startDate, endDate, opts) {
|
|
229
|
+
opts = opts || {};
|
|
230
|
+
|
|
206
231
|
// verify the required parameter 'startDate' is set
|
|
207
232
|
if (startDate === undefined || startDate === null) {
|
|
208
233
|
throw 'Missing the required parameter "startDate" when calling getBillingReportsBillableusage';
|
|
@@ -222,7 +247,8 @@ class BillingApi {
|
|
|
222
247
|
null,
|
|
223
248
|
['PureCloud OAuth'],
|
|
224
249
|
['application/json'],
|
|
225
|
-
['application/json']
|
|
250
|
+
['application/json'],
|
|
251
|
+
opts['customHeaders']
|
|
226
252
|
);
|
|
227
253
|
}
|
|
228
254
|
|
|
@@ -232,6 +258,7 @@ class BillingApi {
|
|
|
232
258
|
* @param {String} trustorOrgId The organization ID of the trustor (customer) organization.
|
|
233
259
|
* @param {Object} opts Optional parameters
|
|
234
260
|
* @param {Number} opts.billingPeriodIndex 0 for active period (overview data may change until period closes). 1 for prior completed billing period. 2 for two billing cycles prior, and so on. (default to 0)
|
|
261
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
235
262
|
*/
|
|
236
263
|
getBillingTrusteebillingoverviewTrustorOrgId(trustorOrgId, opts) {
|
|
237
264
|
opts = opts || {};
|
|
@@ -251,7 +278,8 @@ class BillingApi {
|
|
|
251
278
|
null,
|
|
252
279
|
['PureCloud OAuth'],
|
|
253
280
|
['application/json'],
|
|
254
|
-
['application/json']
|
|
281
|
+
['application/json'],
|
|
282
|
+
opts['customHeaders']
|
|
255
283
|
);
|
|
256
284
|
}
|
|
257
285
|
|