purecloud-platform-client-v2 168.2.0 → 169.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 +2 -35
- package/dist/node/purecloud-platform-client-v2.js +233 -84
- package/dist/web-amd/purecloud-platform-client-v2.js +233 -84
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +233 -84
- package/dist/web-cjs/purecloud-platform-client-v2.js +233 -84
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +143 -14
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +23 -3
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +11 -6
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +56 -7
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +2 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +25 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +51 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -399,7 +399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
399
399
|
|
|
400
400
|
/**
|
|
401
401
|
* @module purecloud-platform-client-v2/ApiClient
|
|
402
|
-
* @version
|
|
402
|
+
* @version 169.0.0
|
|
403
403
|
*/
|
|
404
404
|
class ApiClient {
|
|
405
405
|
/**
|
|
@@ -1485,7 +1485,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1485
1485
|
/**
|
|
1486
1486
|
* Alerting service.
|
|
1487
1487
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1488
|
-
* @version
|
|
1488
|
+
* @version 169.0.0
|
|
1489
1489
|
*/
|
|
1490
1490
|
|
|
1491
1491
|
/**
|
|
@@ -1799,7 +1799,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1799
1799
|
/**
|
|
1800
1800
|
* Analytics service.
|
|
1801
1801
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1802
|
-
* @version
|
|
1802
|
+
* @version 169.0.0
|
|
1803
1803
|
*/
|
|
1804
1804
|
|
|
1805
1805
|
/**
|
|
@@ -3053,7 +3053,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3053
3053
|
/**
|
|
3054
3054
|
* Architect service.
|
|
3055
3055
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
3056
|
-
* @version
|
|
3056
|
+
* @version 169.0.0
|
|
3057
3057
|
*/
|
|
3058
3058
|
|
|
3059
3059
|
/**
|
|
@@ -6101,7 +6101,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6101
6101
|
/**
|
|
6102
6102
|
* Audit service.
|
|
6103
6103
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
6104
|
-
* @version
|
|
6104
|
+
* @version 169.0.0
|
|
6105
6105
|
*/
|
|
6106
6106
|
|
|
6107
6107
|
/**
|
|
@@ -6272,7 +6272,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6272
6272
|
/**
|
|
6273
6273
|
* Authorization service.
|
|
6274
6274
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6275
|
-
* @version
|
|
6275
|
+
* @version 169.0.0
|
|
6276
6276
|
*/
|
|
6277
6277
|
|
|
6278
6278
|
/**
|
|
@@ -7503,7 +7503,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7503
7503
|
/**
|
|
7504
7504
|
* Billing service.
|
|
7505
7505
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7506
|
-
* @version
|
|
7506
|
+
* @version 169.0.0
|
|
7507
7507
|
*/
|
|
7508
7508
|
|
|
7509
7509
|
/**
|
|
@@ -7583,7 +7583,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7583
7583
|
/**
|
|
7584
7584
|
* CarrierServices service.
|
|
7585
7585
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
7586
|
-
* @version
|
|
7586
|
+
* @version 169.0.0
|
|
7587
7587
|
*/
|
|
7588
7588
|
|
|
7589
7589
|
/**
|
|
@@ -7653,7 +7653,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7653
7653
|
/**
|
|
7654
7654
|
* Chat service.
|
|
7655
7655
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7656
|
-
* @version
|
|
7656
|
+
* @version 169.0.0
|
|
7657
7657
|
*/
|
|
7658
7658
|
|
|
7659
7659
|
/**
|
|
@@ -7817,7 +7817,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7817
7817
|
/**
|
|
7818
7818
|
* Coaching service.
|
|
7819
7819
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7820
|
-
* @version
|
|
7820
|
+
* @version 169.0.0
|
|
7821
7821
|
*/
|
|
7822
7822
|
|
|
7823
7823
|
/**
|
|
@@ -8394,7 +8394,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8394
8394
|
/**
|
|
8395
8395
|
* ContentManagement service.
|
|
8396
8396
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8397
|
-
* @version
|
|
8397
|
+
* @version 169.0.0
|
|
8398
8398
|
*/
|
|
8399
8399
|
|
|
8400
8400
|
/**
|
|
@@ -9535,7 +9535,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9535
9535
|
/**
|
|
9536
9536
|
* Conversations service.
|
|
9537
9537
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9538
|
-
* @version
|
|
9538
|
+
* @version 169.0.0
|
|
9539
9539
|
*/
|
|
9540
9540
|
|
|
9541
9541
|
/**
|
|
@@ -14740,7 +14740,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14740
14740
|
|
|
14741
14741
|
/**
|
|
14742
14742
|
* Send an agentless outbound message
|
|
14743
|
-
* Send an agentless (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope.
|
|
14743
|
+
* Send an agentless (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. If there is already a connected conversation between the fromAddress and toAddress specified, the useExistingActiveConversation param can be used to barge in to the ongoing conversation.
|
|
14744
14744
|
* @param {Object} body Create agentless outbound messaging request
|
|
14745
14745
|
*/
|
|
14746
14746
|
postConversationsMessagesAgentless(body) {
|
|
@@ -15626,7 +15626,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15626
15626
|
/**
|
|
15627
15627
|
* DataExtensions service.
|
|
15628
15628
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
15629
|
-
* @version
|
|
15629
|
+
* @version 169.0.0
|
|
15630
15630
|
*/
|
|
15631
15631
|
|
|
15632
15632
|
/**
|
|
@@ -15712,7 +15712,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15712
15712
|
/**
|
|
15713
15713
|
* Downloads service.
|
|
15714
15714
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
15715
|
-
* @version
|
|
15715
|
+
* @version 169.0.0
|
|
15716
15716
|
*/
|
|
15717
15717
|
|
|
15718
15718
|
/**
|
|
@@ -15764,7 +15764,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15764
15764
|
/**
|
|
15765
15765
|
* Events service.
|
|
15766
15766
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
15767
|
-
* @version
|
|
15767
|
+
* @version 169.0.0
|
|
15768
15768
|
*/
|
|
15769
15769
|
|
|
15770
15770
|
/**
|
|
@@ -15860,7 +15860,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15860
15860
|
/**
|
|
15861
15861
|
* ExternalContacts service.
|
|
15862
15862
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
15863
|
-
* @version
|
|
15863
|
+
* @version 169.0.0
|
|
15864
15864
|
*/
|
|
15865
15865
|
|
|
15866
15866
|
/**
|
|
@@ -17818,7 +17818,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17818
17818
|
/**
|
|
17819
17819
|
* Fax service.
|
|
17820
17820
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
17821
|
-
* @version
|
|
17821
|
+
* @version 169.0.0
|
|
17822
17822
|
*/
|
|
17823
17823
|
|
|
17824
17824
|
/**
|
|
@@ -17989,7 +17989,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17989
17989
|
/**
|
|
17990
17990
|
* Flows service.
|
|
17991
17991
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
17992
|
-
* @version
|
|
17992
|
+
* @version 169.0.0
|
|
17993
17993
|
*/
|
|
17994
17994
|
|
|
17995
17995
|
/**
|
|
@@ -18060,7 +18060,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18060
18060
|
/**
|
|
18061
18061
|
* Gamification service.
|
|
18062
18062
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
18063
|
-
* @version
|
|
18063
|
+
* @version 169.0.0
|
|
18064
18064
|
*/
|
|
18065
18065
|
|
|
18066
18066
|
/**
|
|
@@ -20146,7 +20146,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20146
20146
|
/**
|
|
20147
20147
|
* GeneralDataProtectionRegulation service.
|
|
20148
20148
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
20149
|
-
* @version
|
|
20149
|
+
* @version 169.0.0
|
|
20150
20150
|
*/
|
|
20151
20151
|
|
|
20152
20152
|
/**
|
|
@@ -20276,7 +20276,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20276
20276
|
/**
|
|
20277
20277
|
* Geolocation service.
|
|
20278
20278
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
20279
|
-
* @version
|
|
20279
|
+
* @version 169.0.0
|
|
20280
20280
|
*/
|
|
20281
20281
|
|
|
20282
20282
|
/**
|
|
@@ -20407,7 +20407,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20407
20407
|
/**
|
|
20408
20408
|
* Greetings service.
|
|
20409
20409
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
20410
|
-
* @version
|
|
20410
|
+
* @version 169.0.0
|
|
20411
20411
|
*/
|
|
20412
20412
|
|
|
20413
20413
|
/**
|
|
@@ -20862,7 +20862,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20862
20862
|
/**
|
|
20863
20863
|
* Groups service.
|
|
20864
20864
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
20865
|
-
* @version
|
|
20865
|
+
* @version 169.0.0
|
|
20866
20866
|
*/
|
|
20867
20867
|
|
|
20868
20868
|
/**
|
|
@@ -21271,7 +21271,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21271
21271
|
/**
|
|
21272
21272
|
* IdentityProvider service.
|
|
21273
21273
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
21274
|
-
* @version
|
|
21274
|
+
* @version 169.0.0
|
|
21275
21275
|
*/
|
|
21276
21276
|
|
|
21277
21277
|
/**
|
|
@@ -22027,7 +22027,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22027
22027
|
/**
|
|
22028
22028
|
* InfrastructureAsCode service.
|
|
22029
22029
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
22030
|
-
* @version
|
|
22030
|
+
* @version 169.0.0
|
|
22031
22031
|
*/
|
|
22032
22032
|
|
|
22033
22033
|
/**
|
|
@@ -22194,7 +22194,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22194
22194
|
/**
|
|
22195
22195
|
* Integrations service.
|
|
22196
22196
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
22197
|
-
* @version
|
|
22197
|
+
* @version 169.0.0
|
|
22198
22198
|
*/
|
|
22199
22199
|
|
|
22200
22200
|
/**
|
|
@@ -23794,7 +23794,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23794
23794
|
/**
|
|
23795
23795
|
* Journey service.
|
|
23796
23796
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
23797
|
-
* @version
|
|
23797
|
+
* @version 169.0.0
|
|
23798
23798
|
*/
|
|
23799
23799
|
|
|
23800
23800
|
/**
|
|
@@ -24674,7 +24674,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24674
24674
|
/**
|
|
24675
24675
|
* Knowledge service.
|
|
24676
24676
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
24677
|
-
* @version
|
|
24677
|
+
* @version 169.0.0
|
|
24678
24678
|
*/
|
|
24679
24679
|
|
|
24680
24680
|
/**
|
|
@@ -24905,6 +24905,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24905
24905
|
* @param {String} categoryId Category ID
|
|
24906
24906
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24907
24907
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
24908
|
+
* @deprecated
|
|
24908
24909
|
*/
|
|
24909
24910
|
deleteKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode) {
|
|
24910
24911
|
// verify the required parameter 'categoryId' is set
|
|
@@ -24940,6 +24941,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24940
24941
|
* @param {String} documentId Document ID
|
|
24941
24942
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24942
24943
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
24944
|
+
* @deprecated
|
|
24943
24945
|
*/
|
|
24944
24946
|
deleteKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode) {
|
|
24945
24947
|
// verify the required parameter 'documentId' is set
|
|
@@ -24975,6 +24977,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24975
24977
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
24976
24978
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
24977
24979
|
* @param {String} importId Import ID
|
|
24980
|
+
* @deprecated
|
|
24978
24981
|
*/
|
|
24979
24982
|
deleteKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId) {
|
|
24980
24983
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -25633,6 +25636,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25633
25636
|
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
25634
25637
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
25635
25638
|
* @param {String} opts.name Filter to return the categories that starts with the given category name.
|
|
25639
|
+
* @deprecated
|
|
25636
25640
|
*/
|
|
25637
25641
|
getKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, opts) {
|
|
25638
25642
|
opts = opts || {};
|
|
@@ -25666,6 +25670,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25666
25670
|
* @param {String} categoryId Category ID
|
|
25667
25671
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25668
25672
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
25673
|
+
* @deprecated
|
|
25669
25674
|
*/
|
|
25670
25675
|
getKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode) {
|
|
25671
25676
|
// verify the required parameter 'categoryId' is set
|
|
@@ -25701,6 +25706,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25701
25706
|
* @param {String} documentId Document ID
|
|
25702
25707
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25703
25708
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
25709
|
+
* @deprecated
|
|
25704
25710
|
*/
|
|
25705
25711
|
getKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode) {
|
|
25706
25712
|
// verify the required parameter 'documentId' is set
|
|
@@ -25745,6 +25751,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25745
25751
|
* @param {Object} opts.sortBy Sort by.
|
|
25746
25752
|
* @param {Object} opts.sortOrder Sort Order.
|
|
25747
25753
|
* @param {Array.<String>} opts.documentIds Comma-separated list of document identifiers to fetch by.
|
|
25754
|
+
* @deprecated
|
|
25748
25755
|
*/
|
|
25749
25756
|
getKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, opts) {
|
|
25750
25757
|
opts = opts || {};
|
|
@@ -25778,6 +25785,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25778
25785
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25779
25786
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
25780
25787
|
* @param {String} importId Import ID
|
|
25788
|
+
* @deprecated
|
|
25781
25789
|
*/
|
|
25782
25790
|
getKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId) {
|
|
25783
25791
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -25813,6 +25821,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25813
25821
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
25814
25822
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
25815
25823
|
* @param {String} trainingId Training ID
|
|
25824
|
+
* @deprecated
|
|
25816
25825
|
*/
|
|
25817
25826
|
getKnowledgeKnowledgebaseLanguageTraining(knowledgeBaseId, languageCode, trainingId) {
|
|
25818
25827
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -25853,6 +25862,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25853
25862
|
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
25854
25863
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
25855
25864
|
* @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
|
|
25865
|
+
* @deprecated
|
|
25856
25866
|
*/
|
|
25857
25867
|
getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode, opts) {
|
|
25858
25868
|
opts = opts || {};
|
|
@@ -25988,8 +25998,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25988
25998
|
* @param {Object} opts Optional parameters
|
|
25989
25999
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
25990
26000
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
25991
|
-
* @param {String} opts.limit Number of entities to return. Maximum of
|
|
25992
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of
|
|
26001
|
+
* @param {String} opts.limit Number of entities to return. Maximum of 100. Deprecated in favour of pageSize
|
|
26002
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
25993
26003
|
* @param {String} opts.name Filter by Name.
|
|
25994
26004
|
* @param {Object} opts.coreLanguage Filter by core language.
|
|
25995
26005
|
* @param {Boolean} opts.published Filter by published status.
|
|
@@ -26300,6 +26310,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26300
26310
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
26301
26311
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
26302
26312
|
* @param {Object} body
|
|
26313
|
+
* @deprecated
|
|
26303
26314
|
*/
|
|
26304
26315
|
patchKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode, body) {
|
|
26305
26316
|
// verify the required parameter 'categoryId' is set
|
|
@@ -26340,6 +26351,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26340
26351
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
26341
26352
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
26342
26353
|
* @param {Object} body
|
|
26354
|
+
* @deprecated
|
|
26343
26355
|
*/
|
|
26344
26356
|
patchKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode, body) {
|
|
26345
26357
|
// verify the required parameter 'documentId' is set
|
|
@@ -26379,6 +26391,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26379
26391
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
26380
26392
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
26381
26393
|
* @param {Array.<Object>} body
|
|
26394
|
+
* @deprecated
|
|
26382
26395
|
*/
|
|
26383
26396
|
patchKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body) {
|
|
26384
26397
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -26415,6 +26428,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26415
26428
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
26416
26429
|
* @param {String} importId Import ID
|
|
26417
26430
|
* @param {Object} body
|
|
26431
|
+
* @deprecated
|
|
26418
26432
|
*/
|
|
26419
26433
|
patchKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId, body) {
|
|
26420
26434
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -26882,6 +26896,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26882
26896
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
26883
26897
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
26884
26898
|
* @param {Object} body
|
|
26899
|
+
* @deprecated
|
|
26885
26900
|
*/
|
|
26886
26901
|
postKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, body) {
|
|
26887
26902
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -26917,6 +26932,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26917
26932
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
26918
26933
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
26919
26934
|
* @param {Object} body
|
|
26935
|
+
* @deprecated
|
|
26920
26936
|
*/
|
|
26921
26937
|
postKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body) {
|
|
26922
26938
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -26952,6 +26968,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26952
26968
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
26953
26969
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
26954
26970
|
* @param {Object} body
|
|
26971
|
+
* @deprecated
|
|
26955
26972
|
*/
|
|
26956
26973
|
postKnowledgeKnowledgebaseLanguageDocumentsImports(knowledgeBaseId, languageCode, body) {
|
|
26957
26974
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -26987,6 +27004,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26987
27004
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
26988
27005
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
26989
27006
|
* @param {String} trainingId Training ID
|
|
27007
|
+
* @deprecated
|
|
26990
27008
|
*/
|
|
26991
27009
|
postKnowledgeKnowledgebaseLanguageTrainingPromote(knowledgeBaseId, languageCode, trainingId) {
|
|
26992
27010
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -27021,6 +27039,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27021
27039
|
*
|
|
27022
27040
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
27023
27041
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
27042
|
+
* @deprecated
|
|
27024
27043
|
*/
|
|
27025
27044
|
postKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode) {
|
|
27026
27045
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
@@ -27052,6 +27071,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27052
27071
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
27053
27072
|
* @param {Object} opts Optional parameters
|
|
27054
27073
|
* @param {Object} opts.body
|
|
27074
|
+
* @deprecated
|
|
27055
27075
|
*/
|
|
27056
27076
|
postKnowledgeKnowledgebaseSearch(knowledgeBaseId, opts) {
|
|
27057
27077
|
opts = opts || {};
|
|
@@ -27106,7 +27126,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27106
27126
|
/**
|
|
27107
27127
|
* LanguageUnderstanding service.
|
|
27108
27128
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
27109
|
-
* @version
|
|
27129
|
+
* @version 169.0.0
|
|
27110
27130
|
*/
|
|
27111
27131
|
|
|
27112
27132
|
/**
|
|
@@ -28119,7 +28139,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28119
28139
|
/**
|
|
28120
28140
|
* Languages service.
|
|
28121
28141
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
28122
|
-
* @version
|
|
28142
|
+
* @version 169.0.0
|
|
28123
28143
|
*/
|
|
28124
28144
|
|
|
28125
28145
|
/**
|
|
@@ -28341,7 +28361,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28341
28361
|
/**
|
|
28342
28362
|
* Learning service.
|
|
28343
28363
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
28344
|
-
* @version
|
|
28364
|
+
* @version 169.0.0
|
|
28345
28365
|
*/
|
|
28346
28366
|
|
|
28347
28367
|
/**
|
|
@@ -29156,7 +29176,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29156
29176
|
/**
|
|
29157
29177
|
* License service.
|
|
29158
29178
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
29159
|
-
* @version
|
|
29179
|
+
* @version 169.0.0
|
|
29160
29180
|
*/
|
|
29161
29181
|
|
|
29162
29182
|
/**
|
|
@@ -29394,7 +29414,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29394
29414
|
/**
|
|
29395
29415
|
* Locations service.
|
|
29396
29416
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
29397
|
-
* @version
|
|
29417
|
+
* @version 169.0.0
|
|
29398
29418
|
*/
|
|
29399
29419
|
|
|
29400
29420
|
/**
|
|
@@ -29630,7 +29650,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29630
29650
|
/**
|
|
29631
29651
|
* Messaging service.
|
|
29632
29652
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
29633
|
-
* @version
|
|
29653
|
+
* @version 169.0.0
|
|
29634
29654
|
*/
|
|
29635
29655
|
|
|
29636
29656
|
/**
|
|
@@ -29647,8 +29667,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29647
29667
|
|
|
29648
29668
|
/**
|
|
29649
29669
|
* Delete a supported content profile
|
|
29650
|
-
*
|
|
29670
|
+
* Deprecated - use DELETE /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
|
|
29651
29671
|
* @param {String} supportedContentId Supported Content ID
|
|
29672
|
+
* @deprecated
|
|
29652
29673
|
*/
|
|
29653
29674
|
deleteMessagingSupportedcontentSupportedContentId(supportedContentId) {
|
|
29654
29675
|
// verify the required parameter 'supportedContentId' is set
|
|
@@ -29672,10 +29693,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29672
29693
|
|
|
29673
29694
|
/**
|
|
29674
29695
|
* Get a list of Supported Content profiles
|
|
29675
|
-
*
|
|
29696
|
+
* Deprecated - use GET /api/v2/conversations/messaging/supportedcontent as replacement
|
|
29676
29697
|
* @param {Object} opts Optional parameters
|
|
29677
29698
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
29678
29699
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
29700
|
+
* @deprecated
|
|
29679
29701
|
*/
|
|
29680
29702
|
getMessagingSupportedcontent(opts) {
|
|
29681
29703
|
opts = opts || {};
|
|
@@ -29697,8 +29719,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29697
29719
|
|
|
29698
29720
|
/**
|
|
29699
29721
|
* Get a supported content profile
|
|
29700
|
-
*
|
|
29722
|
+
* Deprecated - use GET /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
|
|
29701
29723
|
* @param {String} supportedContentId Supported Content ID
|
|
29724
|
+
* @deprecated
|
|
29702
29725
|
*/
|
|
29703
29726
|
getMessagingSupportedcontentSupportedContentId(supportedContentId) {
|
|
29704
29727
|
// verify the required parameter 'supportedContentId' is set
|
|
@@ -29722,9 +29745,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29722
29745
|
|
|
29723
29746
|
/**
|
|
29724
29747
|
* Update a supported content profile
|
|
29725
|
-
*
|
|
29748
|
+
* Deprecated - use PATCH /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
|
|
29726
29749
|
* @param {String} supportedContentId Supported Content ID
|
|
29727
29750
|
* @param {Object} body SupportedContent
|
|
29751
|
+
* @deprecated
|
|
29728
29752
|
*/
|
|
29729
29753
|
patchMessagingSupportedcontentSupportedContentId(supportedContentId, body) {
|
|
29730
29754
|
// verify the required parameter 'supportedContentId' is set
|
|
@@ -29752,8 +29776,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29752
29776
|
|
|
29753
29777
|
/**
|
|
29754
29778
|
* Create a Supported Content profile
|
|
29755
|
-
*
|
|
29779
|
+
* Deprecated - use POST /api/v2/conversations/messaging/supportedcontent as replacement
|
|
29756
29780
|
* @param {Object} body SupportedContent
|
|
29781
|
+
* @deprecated
|
|
29757
29782
|
*/
|
|
29758
29783
|
postMessagingSupportedcontent(body) {
|
|
29759
29784
|
// verify the required parameter 'body' is set
|
|
@@ -29781,7 +29806,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29781
29806
|
/**
|
|
29782
29807
|
* MobileDevices service.
|
|
29783
29808
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
29784
|
-
* @version
|
|
29809
|
+
* @version 169.0.0
|
|
29785
29810
|
*/
|
|
29786
29811
|
|
|
29787
29812
|
/**
|
|
@@ -29932,7 +29957,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29932
29957
|
/**
|
|
29933
29958
|
* Notifications service.
|
|
29934
29959
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
29935
|
-
* @version
|
|
29960
|
+
* @version 169.0.0
|
|
29936
29961
|
*/
|
|
29937
29962
|
|
|
29938
29963
|
/**
|
|
@@ -30165,7 +30190,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30165
30190
|
/**
|
|
30166
30191
|
* OAuth service.
|
|
30167
30192
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
30168
|
-
* @version
|
|
30193
|
+
* @version 169.0.0
|
|
30169
30194
|
*/
|
|
30170
30195
|
|
|
30171
30196
|
/**
|
|
@@ -30531,7 +30556,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30531
30556
|
/**
|
|
30532
30557
|
* Objects service.
|
|
30533
30558
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
30534
|
-
* @version
|
|
30559
|
+
* @version 169.0.0
|
|
30535
30560
|
*/
|
|
30536
30561
|
|
|
30537
30562
|
/**
|
|
@@ -30802,7 +30827,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30802
30827
|
/**
|
|
30803
30828
|
* Organization service.
|
|
30804
30829
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
30805
|
-
* @version
|
|
30830
|
+
* @version 169.0.0
|
|
30806
30831
|
*/
|
|
30807
30832
|
|
|
30808
30833
|
/**
|
|
@@ -30844,9 +30869,30 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30844
30869
|
}
|
|
30845
30870
|
|
|
30846
30871
|
/**
|
|
30847
|
-
*
|
|
30872
|
+
* Gets the organization's settings
|
|
30848
30873
|
*
|
|
30849
30874
|
*/
|
|
30875
|
+
getOrganizationsAuthenticationSettings() {
|
|
30876
|
+
|
|
30877
|
+
return this.apiClient.callApi(
|
|
30878
|
+
'/api/v2/organizations/authentication/settings',
|
|
30879
|
+
'GET',
|
|
30880
|
+
{ },
|
|
30881
|
+
{ },
|
|
30882
|
+
{ },
|
|
30883
|
+
{ },
|
|
30884
|
+
null,
|
|
30885
|
+
['PureCloud OAuth'],
|
|
30886
|
+
['application/json'],
|
|
30887
|
+
['application/json']
|
|
30888
|
+
);
|
|
30889
|
+
}
|
|
30890
|
+
|
|
30891
|
+
/**
|
|
30892
|
+
* Get the list of domains that will be allowed to embed PureCloud applications
|
|
30893
|
+
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
30894
|
+
* @deprecated
|
|
30895
|
+
*/
|
|
30850
30896
|
getOrganizationsEmbeddedintegration() {
|
|
30851
30897
|
|
|
30852
30898
|
return this.apiClient.callApi(
|
|
@@ -30865,7 +30911,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30865
30911
|
|
|
30866
30912
|
/**
|
|
30867
30913
|
* Get organization IP address whitelist settings
|
|
30868
|
-
*
|
|
30914
|
+
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
30915
|
+
* @deprecated
|
|
30869
30916
|
*/
|
|
30870
30917
|
getOrganizationsIpaddressauthentication() {
|
|
30871
30918
|
|
|
@@ -31052,7 +31099,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31052
31099
|
}
|
|
31053
31100
|
|
|
31054
31101
|
/**
|
|
31055
|
-
*
|
|
31102
|
+
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
31056
31103
|
*
|
|
31057
31104
|
* @deprecated
|
|
31058
31105
|
*/
|
|
@@ -31072,6 +31119,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31072
31119
|
);
|
|
31073
31120
|
}
|
|
31074
31121
|
|
|
31122
|
+
/**
|
|
31123
|
+
* Update the organization's settings
|
|
31124
|
+
*
|
|
31125
|
+
* @param {Object} body Org settings
|
|
31126
|
+
*/
|
|
31127
|
+
patchOrganizationsAuthenticationSettings(body) {
|
|
31128
|
+
// verify the required parameter 'body' is set
|
|
31129
|
+
if (body === undefined || body === null) {
|
|
31130
|
+
throw 'Missing the required parameter "body" when calling patchOrganizationsAuthenticationSettings';
|
|
31131
|
+
}
|
|
31132
|
+
|
|
31133
|
+
return this.apiClient.callApi(
|
|
31134
|
+
'/api/v2/organizations/authentication/settings',
|
|
31135
|
+
'PATCH',
|
|
31136
|
+
{ },
|
|
31137
|
+
{ },
|
|
31138
|
+
{ },
|
|
31139
|
+
{ },
|
|
31140
|
+
body,
|
|
31141
|
+
['PureCloud OAuth'],
|
|
31142
|
+
['application/json'],
|
|
31143
|
+
['application/json']
|
|
31144
|
+
);
|
|
31145
|
+
}
|
|
31146
|
+
|
|
31075
31147
|
/**
|
|
31076
31148
|
* Update organization
|
|
31077
31149
|
*
|
|
@@ -31104,8 +31176,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31104
31176
|
|
|
31105
31177
|
/**
|
|
31106
31178
|
* Update the list of domains that will be allowed to embed PureCloud applications
|
|
31107
|
-
*
|
|
31179
|
+
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
31108
31180
|
* @param {Object} body Whitelist settings
|
|
31181
|
+
* @deprecated
|
|
31109
31182
|
*/
|
|
31110
31183
|
putOrganizationsEmbeddedintegration(body) {
|
|
31111
31184
|
// verify the required parameter 'body' is set
|
|
@@ -31129,8 +31202,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31129
31202
|
|
|
31130
31203
|
/**
|
|
31131
31204
|
* Update organization IP address whitelist settings
|
|
31132
|
-
*
|
|
31205
|
+
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
31133
31206
|
* @param {Object} body IP address Whitelist settings
|
|
31207
|
+
* @deprecated
|
|
31134
31208
|
*/
|
|
31135
31209
|
putOrganizationsIpaddressauthentication(body) {
|
|
31136
31210
|
// verify the required parameter 'body' is set
|
|
@@ -31177,7 +31251,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31177
31251
|
}
|
|
31178
31252
|
|
|
31179
31253
|
/**
|
|
31180
|
-
*
|
|
31254
|
+
* This route is deprecated, please use /api/v2/organizations/authentication/settings instead
|
|
31181
31255
|
*
|
|
31182
31256
|
* @param {Object} body Whitelist settings
|
|
31183
31257
|
* @deprecated
|
|
@@ -31208,7 +31282,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31208
31282
|
/**
|
|
31209
31283
|
* OrganizationAuthorization service.
|
|
31210
31284
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
31211
|
-
* @version
|
|
31285
|
+
* @version 169.0.0
|
|
31212
31286
|
*/
|
|
31213
31287
|
|
|
31214
31288
|
/**
|
|
@@ -32503,7 +32577,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32503
32577
|
/**
|
|
32504
32578
|
* Outbound service.
|
|
32505
32579
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
32506
|
-
* @version
|
|
32580
|
+
* @version 169.0.0
|
|
32507
32581
|
*/
|
|
32508
32582
|
|
|
32509
32583
|
/**
|
|
@@ -36125,7 +36199,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36125
36199
|
/**
|
|
36126
36200
|
* Presence service.
|
|
36127
36201
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
36128
|
-
* @version
|
|
36202
|
+
* @version 169.0.0
|
|
36129
36203
|
*/
|
|
36130
36204
|
|
|
36131
36205
|
/**
|
|
@@ -36676,7 +36750,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36676
36750
|
/**
|
|
36677
36751
|
* ProcessAutomation service.
|
|
36678
36752
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
36679
|
-
* @version
|
|
36753
|
+
* @version 169.0.0
|
|
36680
36754
|
*/
|
|
36681
36755
|
|
|
36682
36756
|
/**
|
|
@@ -36915,7 +36989,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36915
36989
|
/**
|
|
36916
36990
|
* Quality service.
|
|
36917
36991
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
36918
|
-
* @version
|
|
36992
|
+
* @version 169.0.0
|
|
36919
36993
|
*/
|
|
36920
36994
|
|
|
36921
36995
|
/**
|
|
@@ -38503,7 +38577,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38503
38577
|
/**
|
|
38504
38578
|
* Recording service.
|
|
38505
38579
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
38506
|
-
* @version
|
|
38580
|
+
* @version 169.0.0
|
|
38507
38581
|
*/
|
|
38508
38582
|
|
|
38509
38583
|
/**
|
|
@@ -40140,7 +40214,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40140
40214
|
/**
|
|
40141
40215
|
* ResponseManagement service.
|
|
40142
40216
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
40143
|
-
* @version
|
|
40217
|
+
* @version 169.0.0
|
|
40144
40218
|
*/
|
|
40145
40219
|
|
|
40146
40220
|
/**
|
|
@@ -40625,7 +40699,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40625
40699
|
/**
|
|
40626
40700
|
* Routing service.
|
|
40627
40701
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
40628
|
-
* @version
|
|
40702
|
+
* @version 169.0.0
|
|
40629
40703
|
*/
|
|
40630
40704
|
|
|
40631
40705
|
/**
|
|
@@ -44139,7 +44213,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44139
44213
|
/**
|
|
44140
44214
|
* SCIM service.
|
|
44141
44215
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
44142
|
-
* @version
|
|
44216
|
+
* @version 169.0.0
|
|
44143
44217
|
*/
|
|
44144
44218
|
|
|
44145
44219
|
/**
|
|
@@ -45016,7 +45090,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45016
45090
|
/**
|
|
45017
45091
|
* Scripts service.
|
|
45018
45092
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
45019
|
-
* @version
|
|
45093
|
+
* @version 169.0.0
|
|
45020
45094
|
*/
|
|
45021
45095
|
|
|
45022
45096
|
/**
|
|
@@ -45435,7 +45509,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45435
45509
|
/**
|
|
45436
45510
|
* Search service.
|
|
45437
45511
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
45438
|
-
* @version
|
|
45512
|
+
* @version 169.0.0
|
|
45439
45513
|
*/
|
|
45440
45514
|
|
|
45441
45515
|
/**
|
|
@@ -45808,6 +45882,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45808
45882
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
45809
45883
|
* @param {Object} opts Optional parameters
|
|
45810
45884
|
* @param {Object} opts.body
|
|
45885
|
+
* @deprecated
|
|
45811
45886
|
*/
|
|
45812
45887
|
postKnowledgeKnowledgebaseSearch(knowledgeBaseId, opts) {
|
|
45813
45888
|
opts = opts || {};
|
|
@@ -46045,7 +46120,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46045
46120
|
/**
|
|
46046
46121
|
* SpeechTextAnalytics service.
|
|
46047
46122
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
46048
|
-
* @version
|
|
46123
|
+
* @version 169.0.0
|
|
46049
46124
|
*/
|
|
46050
46125
|
|
|
46051
46126
|
/**
|
|
@@ -46598,6 +46673,30 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46598
46673
|
);
|
|
46599
46674
|
}
|
|
46600
46675
|
|
|
46676
|
+
/**
|
|
46677
|
+
* Get the list of general topics from the org and the system with their current status
|
|
46678
|
+
*
|
|
46679
|
+
* @param {Object} opts Optional parameters
|
|
46680
|
+
* @param {Object} opts.dialect The dialect of the general topics, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard
|
|
46681
|
+
*/
|
|
46682
|
+
getSpeechandtextanalyticsTopicsGeneralStatus(opts) {
|
|
46683
|
+
opts = opts || {};
|
|
46684
|
+
|
|
46685
|
+
|
|
46686
|
+
return this.apiClient.callApi(
|
|
46687
|
+
'/api/v2/speechandtextanalytics/topics/general/status',
|
|
46688
|
+
'GET',
|
|
46689
|
+
{ },
|
|
46690
|
+
{ 'dialect': opts['dialect'] },
|
|
46691
|
+
{ },
|
|
46692
|
+
{ },
|
|
46693
|
+
null,
|
|
46694
|
+
['PureCloud OAuth'],
|
|
46695
|
+
['application/json'],
|
|
46696
|
+
['application/json']
|
|
46697
|
+
);
|
|
46698
|
+
}
|
|
46699
|
+
|
|
46601
46700
|
/**
|
|
46602
46701
|
* Get a Speech and Text Analytics publish topics job by id
|
|
46603
46702
|
*
|
|
@@ -46974,7 +47073,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46974
47073
|
/**
|
|
46975
47074
|
* Stations service.
|
|
46976
47075
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
46977
|
-
* @version
|
|
47076
|
+
* @version 169.0.0
|
|
46978
47077
|
*/
|
|
46979
47078
|
|
|
46980
47079
|
/**
|
|
@@ -47076,7 +47175,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47076
47175
|
/**
|
|
47077
47176
|
* Suggest service.
|
|
47078
47177
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
47079
|
-
* @version
|
|
47178
|
+
* @version 169.0.0
|
|
47080
47179
|
*/
|
|
47081
47180
|
|
|
47082
47181
|
/**
|
|
@@ -47215,7 +47314,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47215
47314
|
/**
|
|
47216
47315
|
* Teams service.
|
|
47217
47316
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
47218
|
-
* @version
|
|
47317
|
+
* @version 169.0.0
|
|
47219
47318
|
*/
|
|
47220
47319
|
|
|
47221
47320
|
/**
|
|
@@ -47486,7 +47585,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47486
47585
|
/**
|
|
47487
47586
|
* Telephony service.
|
|
47488
47587
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
47489
|
-
* @version
|
|
47588
|
+
* @version 169.0.0
|
|
47490
47589
|
*/
|
|
47491
47590
|
|
|
47492
47591
|
/**
|
|
@@ -47614,7 +47713,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47614
47713
|
/**
|
|
47615
47714
|
* TelephonyProvidersEdge service.
|
|
47616
47715
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
47617
|
-
* @version
|
|
47716
|
+
* @version 169.0.0
|
|
47618
47717
|
*/
|
|
47619
47718
|
|
|
47620
47719
|
/**
|
|
@@ -50815,7 +50914,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50815
50914
|
/**
|
|
50816
50915
|
* Textbots service.
|
|
50817
50916
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
50818
|
-
* @version
|
|
50917
|
+
* @version 169.0.0
|
|
50819
50918
|
*/
|
|
50820
50919
|
|
|
50821
50920
|
/**
|
|
@@ -50943,7 +51042,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50943
51042
|
/**
|
|
50944
51043
|
* Tokens service.
|
|
50945
51044
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
50946
|
-
* @version
|
|
51045
|
+
* @version 169.0.0
|
|
50947
51046
|
*/
|
|
50948
51047
|
|
|
50949
51048
|
/**
|
|
@@ -51049,7 +51148,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51049
51148
|
/**
|
|
51050
51149
|
* Uploads service.
|
|
51051
51150
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
51052
|
-
* @version
|
|
51151
|
+
* @version 169.0.0
|
|
51053
51152
|
*/
|
|
51054
51153
|
|
|
51055
51154
|
/**
|
|
@@ -51225,7 +51324,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51225
51324
|
/**
|
|
51226
51325
|
* Usage service.
|
|
51227
51326
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
51228
|
-
* @version
|
|
51327
|
+
* @version 169.0.0
|
|
51229
51328
|
*/
|
|
51230
51329
|
|
|
51231
51330
|
/**
|
|
@@ -51324,6 +51423,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51324
51423
|
);
|
|
51325
51424
|
}
|
|
51326
51425
|
|
|
51426
|
+
/**
|
|
51427
|
+
* Get the results of a usage search
|
|
51428
|
+
*
|
|
51429
|
+
* @param {String} executionId ID of the search execution
|
|
51430
|
+
*/
|
|
51431
|
+
getUsageSimplesearchExecutionIdResults(executionId) {
|
|
51432
|
+
// verify the required parameter 'executionId' is set
|
|
51433
|
+
if (executionId === undefined || executionId === null) {
|
|
51434
|
+
throw 'Missing the required parameter "executionId" when calling getUsageSimplesearchExecutionIdResults';
|
|
51435
|
+
}
|
|
51436
|
+
|
|
51437
|
+
return this.apiClient.callApi(
|
|
51438
|
+
'/api/v2/usage/simplesearch/{executionId}/results',
|
|
51439
|
+
'GET',
|
|
51440
|
+
{ 'executionId': executionId },
|
|
51441
|
+
{ },
|
|
51442
|
+
{ },
|
|
51443
|
+
{ },
|
|
51444
|
+
null,
|
|
51445
|
+
['PureCloud OAuth'],
|
|
51446
|
+
['application/json'],
|
|
51447
|
+
['application/json']
|
|
51448
|
+
);
|
|
51449
|
+
}
|
|
51450
|
+
|
|
51327
51451
|
/**
|
|
51328
51452
|
* Query for OAuth client API usage
|
|
51329
51453
|
* After calling this method, you will then need to poll for the query results based on the returned execution Id
|
|
@@ -51379,13 +51503,38 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51379
51503
|
);
|
|
51380
51504
|
}
|
|
51381
51505
|
|
|
51506
|
+
/**
|
|
51507
|
+
* Search organization API Usage -
|
|
51508
|
+
* After calling this method, you will then need to poll for the query results based on the returned execution Id
|
|
51509
|
+
* @param {Object} body SimpleSearch
|
|
51510
|
+
*/
|
|
51511
|
+
postUsageSimplesearch(body) {
|
|
51512
|
+
// verify the required parameter 'body' is set
|
|
51513
|
+
if (body === undefined || body === null) {
|
|
51514
|
+
throw 'Missing the required parameter "body" when calling postUsageSimplesearch';
|
|
51515
|
+
}
|
|
51516
|
+
|
|
51517
|
+
return this.apiClient.callApi(
|
|
51518
|
+
'/api/v2/usage/simplesearch',
|
|
51519
|
+
'POST',
|
|
51520
|
+
{ },
|
|
51521
|
+
{ },
|
|
51522
|
+
{ },
|
|
51523
|
+
{ },
|
|
51524
|
+
body,
|
|
51525
|
+
['PureCloud OAuth'],
|
|
51526
|
+
['application/json'],
|
|
51527
|
+
['application/json']
|
|
51528
|
+
);
|
|
51529
|
+
}
|
|
51530
|
+
|
|
51382
51531
|
}
|
|
51383
51532
|
|
|
51384
51533
|
class UserRecordingsApi {
|
|
51385
51534
|
/**
|
|
51386
51535
|
* UserRecordings service.
|
|
51387
51536
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
51388
|
-
* @version
|
|
51537
|
+
* @version 169.0.0
|
|
51389
51538
|
*/
|
|
51390
51539
|
|
|
51391
51540
|
/**
|
|
@@ -51570,7 +51719,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51570
51719
|
/**
|
|
51571
51720
|
* Users service.
|
|
51572
51721
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
51573
|
-
* @version
|
|
51722
|
+
* @version 169.0.0
|
|
51574
51723
|
*/
|
|
51575
51724
|
|
|
51576
51725
|
/**
|
|
@@ -53966,7 +54115,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53966
54115
|
/**
|
|
53967
54116
|
* Utilities service.
|
|
53968
54117
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
53969
|
-
* @version
|
|
54118
|
+
* @version 169.0.0
|
|
53970
54119
|
*/
|
|
53971
54120
|
|
|
53972
54121
|
/**
|
|
@@ -54077,7 +54226,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54077
54226
|
/**
|
|
54078
54227
|
* Voicemail service.
|
|
54079
54228
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
54080
|
-
* @version
|
|
54229
|
+
* @version 169.0.0
|
|
54081
54230
|
*/
|
|
54082
54231
|
|
|
54083
54232
|
/**
|
|
@@ -54744,7 +54893,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54744
54893
|
/**
|
|
54745
54894
|
* WebChat service.
|
|
54746
54895
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
54747
|
-
* @version
|
|
54896
|
+
* @version 169.0.0
|
|
54748
54897
|
*/
|
|
54749
54898
|
|
|
54750
54899
|
/**
|
|
@@ -55293,7 +55442,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55293
55442
|
/**
|
|
55294
55443
|
* WebDeployments service.
|
|
55295
55444
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
55296
|
-
* @version
|
|
55445
|
+
* @version 169.0.0
|
|
55297
55446
|
*/
|
|
55298
55447
|
|
|
55299
55448
|
/**
|
|
@@ -55815,7 +55964,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55815
55964
|
/**
|
|
55816
55965
|
* WebMessaging service.
|
|
55817
55966
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
55818
|
-
* @version
|
|
55967
|
+
* @version 169.0.0
|
|
55819
55968
|
*/
|
|
55820
55969
|
|
|
55821
55970
|
/**
|
|
@@ -55861,7 +56010,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55861
56010
|
/**
|
|
55862
56011
|
* Widgets service.
|
|
55863
56012
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
55864
|
-
* @version
|
|
56013
|
+
* @version 169.0.0
|
|
55865
56014
|
*/
|
|
55866
56015
|
|
|
55867
56016
|
/**
|
|
@@ -56007,7 +56156,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56007
56156
|
/**
|
|
56008
56157
|
* WorkforceManagement service.
|
|
56009
56158
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
56010
|
-
* @version
|
|
56159
|
+
* @version 169.0.0
|
|
56011
56160
|
*/
|
|
56012
56161
|
|
|
56013
56162
|
/**
|
|
@@ -60814,7 +60963,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60814
60963
|
* </pre>
|
|
60815
60964
|
* </p>
|
|
60816
60965
|
* @module purecloud-platform-client-v2/index
|
|
60817
|
-
* @version
|
|
60966
|
+
* @version 169.0.0
|
|
60818
60967
|
*/
|
|
60819
60968
|
class platformClient {
|
|
60820
60969
|
constructor() {
|