purecloud-platform-client-v2 168.1.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.
Files changed (79) hide show
  1. package/README.md +2 -35
  2. package/dist/node/purecloud-platform-client-v2.js +281 -84
  3. package/dist/web-amd/purecloud-platform-client-v2.js +281 -84
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +281 -84
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +329 -111
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +230 -77
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
  11. package/src/purecloud-platform-client-v2/api/AlertingApi.js +2 -2
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +2 -2
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +2 -2
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +2 -2
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +4 -2
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +2 -2
  17. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +2 -2
  18. package/src/purecloud-platform-client-v2/api/ChatApi.js +5 -2
  19. package/src/purecloud-platform-client-v2/api/CoachingApi.js +2 -2
  20. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +3 -2
  21. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +3 -3
  22. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +2 -2
  23. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +2 -2
  24. package/src/purecloud-platform-client-v2/api/EventsApi.js +2 -2
  25. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +2 -2
  26. package/src/purecloud-platform-client-v2/api/FaxApi.js +2 -2
  27. package/src/purecloud-platform-client-v2/api/FlowsApi.js +2 -2
  28. package/src/purecloud-platform-client-v2/api/GamificationApi.js +2 -2
  29. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +2 -2
  30. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +2 -2
  31. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +2 -2
  32. package/src/purecloud-platform-client-v2/api/GroupsApi.js +5 -2
  33. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +2 -2
  34. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +2 -2
  35. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +2 -2
  36. package/src/purecloud-platform-client-v2/api/JourneyApi.js +2 -2
  37. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +24 -4
  38. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +2 -2
  39. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +6 -2
  40. package/src/purecloud-platform-client-v2/api/LearningApi.js +2 -2
  41. package/src/purecloud-platform-client-v2/api/LicenseApi.js +2 -2
  42. package/src/purecloud-platform-client-v2/api/LocationsApi.js +2 -2
  43. package/src/purecloud-platform-client-v2/api/MessagingApi.js +12 -7
  44. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +2 -2
  45. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +2 -2
  46. package/src/purecloud-platform-client-v2/api/OAuthApi.js +2 -2
  47. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +2 -2
  48. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +60 -8
  49. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +2 -2
  50. package/src/purecloud-platform-client-v2/api/OutboundApi.js +3 -2
  51. package/src/purecloud-platform-client-v2/api/PresenceApi.js +2 -2
  52. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +2 -2
  53. package/src/purecloud-platform-client-v2/api/QualityApi.js +11 -2
  54. package/src/purecloud-platform-client-v2/api/RecordingApi.js +2 -2
  55. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +2 -2
  56. package/src/purecloud-platform-client-v2/api/RoutingApi.js +7 -2
  57. package/src/purecloud-platform-client-v2/api/SCIMApi.js +2 -2
  58. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +2 -2
  59. package/src/purecloud-platform-client-v2/api/SearchApi.js +3 -2
  60. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +26 -2
  61. package/src/purecloud-platform-client-v2/api/StationsApi.js +2 -2
  62. package/src/purecloud-platform-client-v2/api/SuggestApi.js +2 -2
  63. package/src/purecloud-platform-client-v2/api/TeamsApi.js +2 -2
  64. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +2 -2
  65. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +3 -2
  66. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +2 -2
  67. package/src/purecloud-platform-client-v2/api/TokensApi.js +2 -2
  68. package/src/purecloud-platform-client-v2/api/UploadsApi.js +2 -2
  69. package/src/purecloud-platform-client-v2/api/UsageApi.js +52 -2
  70. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +2 -2
  71. package/src/purecloud-platform-client-v2/api/UsersApi.js +8 -2
  72. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +2 -2
  73. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +2 -2
  74. package/src/purecloud-platform-client-v2/api/WebChatApi.js +7 -2
  75. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +2 -2
  76. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +2 -2
  77. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +2 -2
  78. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +7 -2
  79. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -402,7 +402,7 @@ class Configuration {
402
402
 
403
403
  /**
404
404
  * @module purecloud-platform-client-v2/ApiClient
405
- * @version 168.1.0
405
+ * @version 169.0.0
406
406
  */
407
407
  class ApiClient {
408
408
  /**
@@ -1488,7 +1488,7 @@ class AlertingApi {
1488
1488
  /**
1489
1489
  * Alerting service.
1490
1490
  * @module purecloud-platform-client-v2/api/AlertingApi
1491
- * @version 168.1.0
1491
+ * @version 169.0.0
1492
1492
  */
1493
1493
 
1494
1494
  /**
@@ -1802,7 +1802,7 @@ class AnalyticsApi {
1802
1802
  /**
1803
1803
  * Analytics service.
1804
1804
  * @module purecloud-platform-client-v2/api/AnalyticsApi
1805
- * @version 168.1.0
1805
+ * @version 169.0.0
1806
1806
  */
1807
1807
 
1808
1808
  /**
@@ -3056,7 +3056,7 @@ class ArchitectApi {
3056
3056
  /**
3057
3057
  * Architect service.
3058
3058
  * @module purecloud-platform-client-v2/api/ArchitectApi
3059
- * @version 168.1.0
3059
+ * @version 169.0.0
3060
3060
  */
3061
3061
 
3062
3062
  /**
@@ -6104,7 +6104,7 @@ class AuditApi {
6104
6104
  /**
6105
6105
  * Audit service.
6106
6106
  * @module purecloud-platform-client-v2/api/AuditApi
6107
- * @version 168.1.0
6107
+ * @version 169.0.0
6108
6108
  */
6109
6109
 
6110
6110
  /**
@@ -6275,7 +6275,7 @@ class AuthorizationApi {
6275
6275
  /**
6276
6276
  * Authorization service.
6277
6277
  * @module purecloud-platform-client-v2/api/AuthorizationApi
6278
- * @version 168.1.0
6278
+ * @version 169.0.0
6279
6279
  */
6280
6280
 
6281
6281
  /**
@@ -6516,6 +6516,7 @@ class AuthorizationApi {
6516
6516
  * @param {String} permission The permission string, including the object to access, e.g. routing:queue:view
6517
6517
  * @param {Object} opts Optional parameters
6518
6518
  * @param {String} opts.name Search term to filter by division name
6519
+ * @deprecated
6519
6520
  */
6520
6521
  getAuthorizationDivisionspermittedMe(permission, opts) {
6521
6522
  opts = opts || {};
@@ -6577,6 +6578,7 @@ class AuthorizationApi {
6577
6578
  * @param {Object} opts Optional parameters
6578
6579
  * @param {Number} opts.pageNumber Page number (default to 1)
6579
6580
  * @param {Number} opts.pageSize Page size (default to 25)
6581
+ * @deprecated
6580
6582
  */
6581
6583
  getAuthorizationDivisionspermittedPagedSubjectId(subjectId, permission, opts) {
6582
6584
  opts = opts || {};
@@ -7504,7 +7506,7 @@ class BillingApi {
7504
7506
  /**
7505
7507
  * Billing service.
7506
7508
  * @module purecloud-platform-client-v2/api/BillingApi
7507
- * @version 168.1.0
7509
+ * @version 169.0.0
7508
7510
  */
7509
7511
 
7510
7512
  /**
@@ -7584,7 +7586,7 @@ class CarrierServicesApi {
7584
7586
  /**
7585
7587
  * CarrierServices service.
7586
7588
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
7587
- * @version 168.1.0
7589
+ * @version 169.0.0
7588
7590
  */
7589
7591
 
7590
7592
  /**
@@ -7654,7 +7656,7 @@ class ChatApi {
7654
7656
  /**
7655
7657
  * Chat service.
7656
7658
  * @module purecloud-platform-client-v2/api/ChatApi
7657
- * @version 168.1.0
7659
+ * @version 169.0.0
7658
7660
  */
7659
7661
 
7660
7662
  /**
@@ -7672,6 +7674,7 @@ class ChatApi {
7672
7674
  /**
7673
7675
  * Get Chat Settings.
7674
7676
  * This route is deprecated, please use /chats/settings instead
7677
+ * @deprecated
7675
7678
  */
7676
7679
  getChatSettings() {
7677
7680
 
@@ -7713,6 +7716,7 @@ class ChatApi {
7713
7716
  * Patch Chat Settings.
7714
7717
  * This route is deprecated, please use /chats/settings instead
7715
7718
  * @param {Object} body Chat
7719
+ * @deprecated
7716
7720
  */
7717
7721
  patchChatSettings(body) {
7718
7722
  // verify the required parameter 'body' is set
@@ -7763,6 +7767,7 @@ class ChatApi {
7763
7767
  * Update Chat Settings.
7764
7768
  * This route is deprecated, please use /chats/settings instead
7765
7769
  * @param {Object} body Chat
7770
+ * @deprecated
7766
7771
  */
7767
7772
  putChatSettings(body) {
7768
7773
  // verify the required parameter 'body' is set
@@ -7815,7 +7820,7 @@ class CoachingApi {
7815
7820
  /**
7816
7821
  * Coaching service.
7817
7822
  * @module purecloud-platform-client-v2/api/CoachingApi
7818
- * @version 168.1.0
7823
+ * @version 169.0.0
7819
7824
  */
7820
7825
 
7821
7826
  /**
@@ -8392,7 +8397,7 @@ class ContentManagementApi {
8392
8397
  /**
8393
8398
  * ContentManagement service.
8394
8399
  * @module purecloud-platform-client-v2/api/ContentManagementApi
8395
- * @version 168.1.0
8400
+ * @version 169.0.0
8396
8401
  */
8397
8402
 
8398
8403
  /**
@@ -8679,6 +8684,7 @@ class ContentManagementApi {
8679
8684
  * @param {Number} opts.pageNumber Page number (default to 1)
8680
8685
  * @param {String} opts.sortBy name or dateCreated
8681
8686
  * @param {String} opts.sortOrder ascending or descending (default to ascending)
8687
+ * @deprecated
8682
8688
  */
8683
8689
  getContentmanagementDocuments(workspaceId, opts) {
8684
8690
  opts = opts || {};
@@ -9532,7 +9538,7 @@ class ConversationsApi {
9532
9538
  /**
9533
9539
  * Conversations service.
9534
9540
  * @module purecloud-platform-client-v2/api/ConversationsApi
9535
- * @version 168.1.0
9541
+ * @version 169.0.0
9536
9542
  */
9537
9543
 
9538
9544
  /**
@@ -14737,7 +14743,7 @@ class ConversationsApi {
14737
14743
 
14738
14744
  /**
14739
14745
  * Send an agentless outbound message
14740
- * 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. This will generate a new Conversation, if there is an existing active Conversation between the fromAddress and toAddress already, then this POST will fail.
14746
+ * 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.
14741
14747
  * @param {Object} body Create agentless outbound messaging request
14742
14748
  */
14743
14749
  postConversationsMessagesAgentless(body) {
@@ -15623,7 +15629,7 @@ class DataExtensionsApi {
15623
15629
  /**
15624
15630
  * DataExtensions service.
15625
15631
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
15626
- * @version 168.1.0
15632
+ * @version 169.0.0
15627
15633
  */
15628
15634
 
15629
15635
  /**
@@ -15709,7 +15715,7 @@ class DownloadsApi {
15709
15715
  /**
15710
15716
  * Downloads service.
15711
15717
  * @module purecloud-platform-client-v2/api/DownloadsApi
15712
- * @version 168.1.0
15718
+ * @version 169.0.0
15713
15719
  */
15714
15720
 
15715
15721
  /**
@@ -15761,7 +15767,7 @@ class EventsApi {
15761
15767
  /**
15762
15768
  * Events service.
15763
15769
  * @module purecloud-platform-client-v2/api/EventsApi
15764
- * @version 168.1.0
15770
+ * @version 169.0.0
15765
15771
  */
15766
15772
 
15767
15773
  /**
@@ -15857,7 +15863,7 @@ class ExternalContactsApi {
15857
15863
  /**
15858
15864
  * ExternalContacts service.
15859
15865
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
15860
- * @version 168.1.0
15866
+ * @version 169.0.0
15861
15867
  */
15862
15868
 
15863
15869
  /**
@@ -17815,7 +17821,7 @@ class FaxApi {
17815
17821
  /**
17816
17822
  * Fax service.
17817
17823
  * @module purecloud-platform-client-v2/api/FaxApi
17818
- * @version 168.1.0
17824
+ * @version 169.0.0
17819
17825
  */
17820
17826
 
17821
17827
  /**
@@ -17986,7 +17992,7 @@ class FlowsApi {
17986
17992
  /**
17987
17993
  * Flows service.
17988
17994
  * @module purecloud-platform-client-v2/api/FlowsApi
17989
- * @version 168.1.0
17995
+ * @version 169.0.0
17990
17996
  */
17991
17997
 
17992
17998
  /**
@@ -18057,7 +18063,7 @@ class GamificationApi {
18057
18063
  /**
18058
18064
  * Gamification service.
18059
18065
  * @module purecloud-platform-client-v2/api/GamificationApi
18060
- * @version 168.1.0
18066
+ * @version 169.0.0
18061
18067
  */
18062
18068
 
18063
18069
  /**
@@ -20143,7 +20149,7 @@ class GeneralDataProtectionRegulationApi {
20143
20149
  /**
20144
20150
  * GeneralDataProtectionRegulation service.
20145
20151
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
20146
- * @version 168.1.0
20152
+ * @version 169.0.0
20147
20153
  */
20148
20154
 
20149
20155
  /**
@@ -20273,7 +20279,7 @@ class GeolocationApi {
20273
20279
  /**
20274
20280
  * Geolocation service.
20275
20281
  * @module purecloud-platform-client-v2/api/GeolocationApi
20276
- * @version 168.1.0
20282
+ * @version 169.0.0
20277
20283
  */
20278
20284
 
20279
20285
  /**
@@ -20404,7 +20410,7 @@ class GreetingsApi {
20404
20410
  /**
20405
20411
  * Greetings service.
20406
20412
  * @module purecloud-platform-client-v2/api/GreetingsApi
20407
- * @version 168.1.0
20413
+ * @version 169.0.0
20408
20414
  */
20409
20415
 
20410
20416
  /**
@@ -20859,7 +20865,7 @@ class GroupsApi {
20859
20865
  /**
20860
20866
  * Groups service.
20861
20867
  * @module purecloud-platform-client-v2/api/GroupsApi
20862
- * @version 168.1.0
20868
+ * @version 169.0.0
20863
20869
  */
20864
20870
 
20865
20871
  /**
@@ -20933,6 +20939,7 @@ class GroupsApi {
20933
20939
  * Fetch field config for an entity type
20934
20940
  *
20935
20941
  * @param {Object} type Field type
20942
+ * @deprecated
20936
20943
  */
20937
20944
  getFieldconfig(type) {
20938
20945
  // verify the required parameter 'type' is set
@@ -21042,6 +21049,7 @@ class GroupsApi {
21042
21049
  * @param {String} groupId groupId
21043
21050
  * @param {Object} opts Optional parameters
21044
21051
  * @param {String} opts.fields Comma separated fields to return. Allowable values can be found by querying /api/v2/fieldconfig?type=group and using the key for the elements returned by the fieldList
21052
+ * @deprecated
21045
21053
  */
21046
21054
  getGroupProfile(groupId, opts) {
21047
21055
  opts = opts || {};
@@ -21131,6 +21139,7 @@ class GroupsApi {
21131
21139
  * @param {Array.<String>} opts.id id
21132
21140
  * @param {Array.<String>} opts.jabberId A list of jabberIds to fetch by bulk (cannot be used with the id parameter)
21133
21141
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
21142
+ * @deprecated
21134
21143
  */
21135
21144
  getProfilesGroups(opts) {
21136
21145
  opts = opts || {};
@@ -21265,7 +21274,7 @@ class IdentityProviderApi {
21265
21274
  /**
21266
21275
  * IdentityProvider service.
21267
21276
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
21268
- * @version 168.1.0
21277
+ * @version 169.0.0
21269
21278
  */
21270
21279
 
21271
21280
  /**
@@ -22021,7 +22030,7 @@ class InfrastructureAsCodeApi {
22021
22030
  /**
22022
22031
  * InfrastructureAsCode service.
22023
22032
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
22024
- * @version 168.1.0
22033
+ * @version 169.0.0
22025
22034
  */
22026
22035
 
22027
22036
  /**
@@ -22188,7 +22197,7 @@ class IntegrationsApi {
22188
22197
  /**
22189
22198
  * Integrations service.
22190
22199
  * @module purecloud-platform-client-v2/api/IntegrationsApi
22191
- * @version 168.1.0
22200
+ * @version 169.0.0
22192
22201
  */
22193
22202
 
22194
22203
  /**
@@ -23788,7 +23797,7 @@ class JourneyApi {
23788
23797
  /**
23789
23798
  * Journey service.
23790
23799
  * @module purecloud-platform-client-v2/api/JourneyApi
23791
- * @version 168.1.0
23800
+ * @version 169.0.0
23792
23801
  */
23793
23802
 
23794
23803
  /**
@@ -24668,7 +24677,7 @@ class KnowledgeApi {
24668
24677
  /**
24669
24678
  * Knowledge service.
24670
24679
  * @module purecloud-platform-client-v2/api/KnowledgeApi
24671
- * @version 168.1.0
24680
+ * @version 169.0.0
24672
24681
  */
24673
24682
 
24674
24683
  /**
@@ -24899,6 +24908,7 @@ class KnowledgeApi {
24899
24908
  * @param {String} categoryId Category ID
24900
24909
  * @param {String} knowledgeBaseId Knowledge base ID
24901
24910
  * @param {Object} languageCode Language code, format: iso2-LOCALE
24911
+ * @deprecated
24902
24912
  */
24903
24913
  deleteKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode) {
24904
24914
  // verify the required parameter 'categoryId' is set
@@ -24934,6 +24944,7 @@ class KnowledgeApi {
24934
24944
  * @param {String} documentId Document ID
24935
24945
  * @param {String} knowledgeBaseId Knowledge base ID
24936
24946
  * @param {Object} languageCode Language code, format: iso2-LOCALE
24947
+ * @deprecated
24937
24948
  */
24938
24949
  deleteKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode) {
24939
24950
  // verify the required parameter 'documentId' is set
@@ -24969,6 +24980,7 @@ class KnowledgeApi {
24969
24980
  * @param {String} knowledgeBaseId Knowledge base ID
24970
24981
  * @param {Object} languageCode Language code, format: iso2-LOCALE
24971
24982
  * @param {String} importId Import ID
24983
+ * @deprecated
24972
24984
  */
24973
24985
  deleteKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId) {
24974
24986
  // verify the required parameter 'knowledgeBaseId' is set
@@ -25627,6 +25639,7 @@ class KnowledgeApi {
25627
25639
  * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
25628
25640
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
25629
25641
  * @param {String} opts.name Filter to return the categories that starts with the given category name.
25642
+ * @deprecated
25630
25643
  */
25631
25644
  getKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, opts) {
25632
25645
  opts = opts || {};
@@ -25660,6 +25673,7 @@ class KnowledgeApi {
25660
25673
  * @param {String} categoryId Category ID
25661
25674
  * @param {String} knowledgeBaseId Knowledge base ID
25662
25675
  * @param {Object} languageCode Language code, format: iso2-LOCALE
25676
+ * @deprecated
25663
25677
  */
25664
25678
  getKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode) {
25665
25679
  // verify the required parameter 'categoryId' is set
@@ -25695,6 +25709,7 @@ class KnowledgeApi {
25695
25709
  * @param {String} documentId Document ID
25696
25710
  * @param {String} knowledgeBaseId Knowledge base ID
25697
25711
  * @param {Object} languageCode Language code, format: iso2-LOCALE
25712
+ * @deprecated
25698
25713
  */
25699
25714
  getKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode) {
25700
25715
  // verify the required parameter 'documentId' is set
@@ -25739,6 +25754,7 @@ class KnowledgeApi {
25739
25754
  * @param {Object} opts.sortBy Sort by.
25740
25755
  * @param {Object} opts.sortOrder Sort Order.
25741
25756
  * @param {Array.<String>} opts.documentIds Comma-separated list of document identifiers to fetch by.
25757
+ * @deprecated
25742
25758
  */
25743
25759
  getKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, opts) {
25744
25760
  opts = opts || {};
@@ -25772,6 +25788,7 @@ class KnowledgeApi {
25772
25788
  * @param {String} knowledgeBaseId Knowledge base ID
25773
25789
  * @param {Object} languageCode Language code, format: iso2-LOCALE
25774
25790
  * @param {String} importId Import ID
25791
+ * @deprecated
25775
25792
  */
25776
25793
  getKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId) {
25777
25794
  // verify the required parameter 'knowledgeBaseId' is set
@@ -25807,6 +25824,7 @@ class KnowledgeApi {
25807
25824
  * @param {String} knowledgeBaseId Knowledge base ID
25808
25825
  * @param {Object} languageCode Language code, format: iso2-LOCALE
25809
25826
  * @param {String} trainingId Training ID
25827
+ * @deprecated
25810
25828
  */
25811
25829
  getKnowledgeKnowledgebaseLanguageTraining(knowledgeBaseId, languageCode, trainingId) {
25812
25830
  // verify the required parameter 'knowledgeBaseId' is set
@@ -25847,6 +25865,7 @@ class KnowledgeApi {
25847
25865
  * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
25848
25866
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
25849
25867
  * @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
25868
+ * @deprecated
25850
25869
  */
25851
25870
  getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode, opts) {
25852
25871
  opts = opts || {};
@@ -25982,8 +26001,8 @@ class KnowledgeApi {
25982
26001
  * @param {Object} opts Optional parameters
25983
26002
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
25984
26003
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
25985
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
25986
- * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
26004
+ * @param {String} opts.limit Number of entities to return. Maximum of 100. Deprecated in favour of pageSize
26005
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 100.
25987
26006
  * @param {String} opts.name Filter by Name.
25988
26007
  * @param {Object} opts.coreLanguage Filter by core language.
25989
26008
  * @param {Boolean} opts.published Filter by published status.
@@ -26294,6 +26313,7 @@ class KnowledgeApi {
26294
26313
  * @param {String} knowledgeBaseId Knowledge base ID
26295
26314
  * @param {Object} languageCode Language code, format: iso2-LOCALE
26296
26315
  * @param {Object} body
26316
+ * @deprecated
26297
26317
  */
26298
26318
  patchKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode, body) {
26299
26319
  // verify the required parameter 'categoryId' is set
@@ -26334,6 +26354,7 @@ class KnowledgeApi {
26334
26354
  * @param {String} knowledgeBaseId Knowledge base ID
26335
26355
  * @param {Object} languageCode Language code, format: iso2-LOCALE
26336
26356
  * @param {Object} body
26357
+ * @deprecated
26337
26358
  */
26338
26359
  patchKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode, body) {
26339
26360
  // verify the required parameter 'documentId' is set
@@ -26373,6 +26394,7 @@ class KnowledgeApi {
26373
26394
  * @param {String} knowledgeBaseId Knowledge base ID
26374
26395
  * @param {Object} languageCode Language code, format: iso2-LOCALE
26375
26396
  * @param {Array.<Object>} body
26397
+ * @deprecated
26376
26398
  */
26377
26399
  patchKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body) {
26378
26400
  // verify the required parameter 'knowledgeBaseId' is set
@@ -26409,6 +26431,7 @@ class KnowledgeApi {
26409
26431
  * @param {Object} languageCode Language code, format: iso2-LOCALE
26410
26432
  * @param {String} importId Import ID
26411
26433
  * @param {Object} body
26434
+ * @deprecated
26412
26435
  */
26413
26436
  patchKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId, body) {
26414
26437
  // verify the required parameter 'knowledgeBaseId' is set
@@ -26876,6 +26899,7 @@ class KnowledgeApi {
26876
26899
  * @param {String} knowledgeBaseId Knowledge base ID
26877
26900
  * @param {Object} languageCode Language code, format: iso2-LOCALE
26878
26901
  * @param {Object} body
26902
+ * @deprecated
26879
26903
  */
26880
26904
  postKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, body) {
26881
26905
  // verify the required parameter 'knowledgeBaseId' is set
@@ -26911,6 +26935,7 @@ class KnowledgeApi {
26911
26935
  * @param {String} knowledgeBaseId Knowledge base ID
26912
26936
  * @param {Object} languageCode Language code, format: iso2-LOCALE
26913
26937
  * @param {Object} body
26938
+ * @deprecated
26914
26939
  */
26915
26940
  postKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body) {
26916
26941
  // verify the required parameter 'knowledgeBaseId' is set
@@ -26946,6 +26971,7 @@ class KnowledgeApi {
26946
26971
  * @param {String} knowledgeBaseId Knowledge base ID
26947
26972
  * @param {Object} languageCode Language code, format: iso2-LOCALE
26948
26973
  * @param {Object} body
26974
+ * @deprecated
26949
26975
  */
26950
26976
  postKnowledgeKnowledgebaseLanguageDocumentsImports(knowledgeBaseId, languageCode, body) {
26951
26977
  // verify the required parameter 'knowledgeBaseId' is set
@@ -26981,6 +27007,7 @@ class KnowledgeApi {
26981
27007
  * @param {String} knowledgeBaseId Knowledge base ID
26982
27008
  * @param {Object} languageCode Language code, format: iso2-LOCALE
26983
27009
  * @param {String} trainingId Training ID
27010
+ * @deprecated
26984
27011
  */
26985
27012
  postKnowledgeKnowledgebaseLanguageTrainingPromote(knowledgeBaseId, languageCode, trainingId) {
26986
27013
  // verify the required parameter 'knowledgeBaseId' is set
@@ -27015,6 +27042,7 @@ class KnowledgeApi {
27015
27042
  *
27016
27043
  * @param {String} knowledgeBaseId Knowledge base ID
27017
27044
  * @param {Object} languageCode Language code, format: iso2-LOCALE
27045
+ * @deprecated
27018
27046
  */
27019
27047
  postKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode) {
27020
27048
  // verify the required parameter 'knowledgeBaseId' is set
@@ -27046,6 +27074,7 @@ class KnowledgeApi {
27046
27074
  * @param {String} knowledgeBaseId Knowledge base ID
27047
27075
  * @param {Object} opts Optional parameters
27048
27076
  * @param {Object} opts.body
27077
+ * @deprecated
27049
27078
  */
27050
27079
  postKnowledgeKnowledgebaseSearch(knowledgeBaseId, opts) {
27051
27080
  opts = opts || {};
@@ -27100,7 +27129,7 @@ class LanguageUnderstandingApi {
27100
27129
  /**
27101
27130
  * LanguageUnderstanding service.
27102
27131
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
27103
- * @version 168.1.0
27132
+ * @version 169.0.0
27104
27133
  */
27105
27134
 
27106
27135
  /**
@@ -28113,7 +28142,7 @@ class LanguagesApi {
28113
28142
  /**
28114
28143
  * Languages service.
28115
28144
  * @module purecloud-platform-client-v2/api/LanguagesApi
28116
- * @version 168.1.0
28145
+ * @version 169.0.0
28117
28146
  */
28118
28147
 
28119
28148
  /**
@@ -28132,6 +28161,7 @@ class LanguagesApi {
28132
28161
  * Delete Language (Deprecated)
28133
28162
  * This endpoint is deprecated. Please see the Routing API (DELETE /api/v2/routing/languages/{languageId})
28134
28163
  * @param {String} languageId Language ID
28164
+ * @deprecated
28135
28165
  */
28136
28166
  deleteLanguage(languageId) {
28137
28167
  // verify the required parameter 'languageId' is set
@@ -28157,6 +28187,7 @@ class LanguagesApi {
28157
28187
  * Get Language (Deprecated)
28158
28188
  * This endpoint is deprecated. Please see the Routing API (GET /api/v2/routing/languages/{languageId})
28159
28189
  * @param {String} languageId Language ID
28190
+ * @deprecated
28160
28191
  */
28161
28192
  getLanguage(languageId) {
28162
28193
  // verify the required parameter 'languageId' is set
@@ -28186,6 +28217,7 @@ class LanguagesApi {
28186
28217
  * @param {Number} opts.pageNumber Page number (default to 1)
28187
28218
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
28188
28219
  * @param {String} opts.name Name
28220
+ * @deprecated
28189
28221
  */
28190
28222
  getLanguages(opts) {
28191
28223
  opts = opts || {};
@@ -28304,6 +28336,7 @@ class LanguagesApi {
28304
28336
  * Create Language (Deprecated)
28305
28337
  * This endpoint is deprecated. Please see the Routing API. (POST /api/v2/routing/languages
28306
28338
  * @param {Object} body Language
28339
+ * @deprecated
28307
28340
  */
28308
28341
  postLanguages(body) {
28309
28342
  // verify the required parameter 'body' is set
@@ -28331,7 +28364,7 @@ class LearningApi {
28331
28364
  /**
28332
28365
  * Learning service.
28333
28366
  * @module purecloud-platform-client-v2/api/LearningApi
28334
- * @version 168.1.0
28367
+ * @version 169.0.0
28335
28368
  */
28336
28369
 
28337
28370
  /**
@@ -29146,7 +29179,7 @@ class LicenseApi {
29146
29179
  /**
29147
29180
  * License service.
29148
29181
  * @module purecloud-platform-client-v2/api/LicenseApi
29149
- * @version 168.1.0
29182
+ * @version 169.0.0
29150
29183
  */
29151
29184
 
29152
29185
  /**
@@ -29384,7 +29417,7 @@ class LocationsApi {
29384
29417
  /**
29385
29418
  * Locations service.
29386
29419
  * @module purecloud-platform-client-v2/api/LocationsApi
29387
- * @version 168.1.0
29420
+ * @version 169.0.0
29388
29421
  */
29389
29422
 
29390
29423
  /**
@@ -29620,7 +29653,7 @@ class MessagingApi {
29620
29653
  /**
29621
29654
  * Messaging service.
29622
29655
  * @module purecloud-platform-client-v2/api/MessagingApi
29623
- * @version 168.1.0
29656
+ * @version 169.0.0
29624
29657
  */
29625
29658
 
29626
29659
  /**
@@ -29637,8 +29670,9 @@ class MessagingApi {
29637
29670
 
29638
29671
  /**
29639
29672
  * Delete a supported content profile
29640
- *
29673
+ * Deprecated - use DELETE /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
29641
29674
  * @param {String} supportedContentId Supported Content ID
29675
+ * @deprecated
29642
29676
  */
29643
29677
  deleteMessagingSupportedcontentSupportedContentId(supportedContentId) {
29644
29678
  // verify the required parameter 'supportedContentId' is set
@@ -29662,10 +29696,11 @@ class MessagingApi {
29662
29696
 
29663
29697
  /**
29664
29698
  * Get a list of Supported Content profiles
29665
- *
29699
+ * Deprecated - use GET /api/v2/conversations/messaging/supportedcontent as replacement
29666
29700
  * @param {Object} opts Optional parameters
29667
29701
  * @param {Number} opts.pageSize Page size (default to 25)
29668
29702
  * @param {Number} opts.pageNumber Page number (default to 1)
29703
+ * @deprecated
29669
29704
  */
29670
29705
  getMessagingSupportedcontent(opts) {
29671
29706
  opts = opts || {};
@@ -29687,8 +29722,9 @@ class MessagingApi {
29687
29722
 
29688
29723
  /**
29689
29724
  * Get a supported content profile
29690
- *
29725
+ * Deprecated - use GET /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
29691
29726
  * @param {String} supportedContentId Supported Content ID
29727
+ * @deprecated
29692
29728
  */
29693
29729
  getMessagingSupportedcontentSupportedContentId(supportedContentId) {
29694
29730
  // verify the required parameter 'supportedContentId' is set
@@ -29712,9 +29748,10 @@ class MessagingApi {
29712
29748
 
29713
29749
  /**
29714
29750
  * Update a supported content profile
29715
- *
29751
+ * Deprecated - use PATCH /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
29716
29752
  * @param {String} supportedContentId Supported Content ID
29717
29753
  * @param {Object} body SupportedContent
29754
+ * @deprecated
29718
29755
  */
29719
29756
  patchMessagingSupportedcontentSupportedContentId(supportedContentId, body) {
29720
29757
  // verify the required parameter 'supportedContentId' is set
@@ -29742,8 +29779,9 @@ class MessagingApi {
29742
29779
 
29743
29780
  /**
29744
29781
  * Create a Supported Content profile
29745
- *
29782
+ * Deprecated - use POST /api/v2/conversations/messaging/supportedcontent as replacement
29746
29783
  * @param {Object} body SupportedContent
29784
+ * @deprecated
29747
29785
  */
29748
29786
  postMessagingSupportedcontent(body) {
29749
29787
  // verify the required parameter 'body' is set
@@ -29771,7 +29809,7 @@ class MobileDevicesApi {
29771
29809
  /**
29772
29810
  * MobileDevices service.
29773
29811
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
29774
- * @version 168.1.0
29812
+ * @version 169.0.0
29775
29813
  */
29776
29814
 
29777
29815
  /**
@@ -29922,7 +29960,7 @@ class NotificationsApi {
29922
29960
  /**
29923
29961
  * Notifications service.
29924
29962
  * @module purecloud-platform-client-v2/api/NotificationsApi
29925
- * @version 168.1.0
29963
+ * @version 169.0.0
29926
29964
  */
29927
29965
 
29928
29966
  /**
@@ -30155,7 +30193,7 @@ class OAuthApi {
30155
30193
  /**
30156
30194
  * OAuth service.
30157
30195
  * @module purecloud-platform-client-v2/api/OAuthApi
30158
- * @version 168.1.0
30196
+ * @version 169.0.0
30159
30197
  */
30160
30198
 
30161
30199
  /**
@@ -30521,7 +30559,7 @@ class ObjectsApi {
30521
30559
  /**
30522
30560
  * Objects service.
30523
30561
  * @module purecloud-platform-client-v2/api/ObjectsApi
30524
- * @version 168.1.0
30562
+ * @version 169.0.0
30525
30563
  */
30526
30564
 
30527
30565
  /**
@@ -30792,7 +30830,7 @@ class OrganizationApi {
30792
30830
  /**
30793
30831
  * Organization service.
30794
30832
  * @module purecloud-platform-client-v2/api/OrganizationApi
30795
- * @version 168.1.0
30833
+ * @version 169.0.0
30796
30834
  */
30797
30835
 
30798
30836
  /**
@@ -30811,6 +30849,7 @@ class OrganizationApi {
30811
30849
  * Fetch field config for an entity type
30812
30850
  *
30813
30851
  * @param {Object} type Field type
30852
+ * @deprecated
30814
30853
  */
30815
30854
  getFieldconfig(type) {
30816
30855
  // verify the required parameter 'type' is set
@@ -30833,9 +30872,30 @@ class OrganizationApi {
30833
30872
  }
30834
30873
 
30835
30874
  /**
30836
- * Get the list of domains that will be allowed to embed PureCloud applications
30875
+ * Gets the organization's settings
30837
30876
  *
30838
30877
  */
30878
+ getOrganizationsAuthenticationSettings() {
30879
+
30880
+ return this.apiClient.callApi(
30881
+ '/api/v2/organizations/authentication/settings',
30882
+ 'GET',
30883
+ { },
30884
+ { },
30885
+ { },
30886
+ { },
30887
+ null,
30888
+ ['PureCloud OAuth'],
30889
+ ['application/json'],
30890
+ ['application/json']
30891
+ );
30892
+ }
30893
+
30894
+ /**
30895
+ * Get the list of domains that will be allowed to embed PureCloud applications
30896
+ * This route is deprecated, please use /api/v2/organizations/authentication/settings instead
30897
+ * @deprecated
30898
+ */
30839
30899
  getOrganizationsEmbeddedintegration() {
30840
30900
 
30841
30901
  return this.apiClient.callApi(
@@ -30854,7 +30914,8 @@ class OrganizationApi {
30854
30914
 
30855
30915
  /**
30856
30916
  * Get organization IP address whitelist settings
30857
- *
30917
+ * This route is deprecated, please use /api/v2/organizations/authentication/settings instead
30918
+ * @deprecated
30858
30919
  */
30859
30920
  getOrganizationsIpaddressauthentication() {
30860
30921
 
@@ -31041,8 +31102,9 @@ class OrganizationApi {
31041
31102
  }
31042
31103
 
31043
31104
  /**
31044
- * Use PUT /api/v2/organizations/embeddedintegration instead
31105
+ * This route is deprecated, please use /api/v2/organizations/authentication/settings instead
31045
31106
  *
31107
+ * @deprecated
31046
31108
  */
31047
31109
  getOrganizationsWhitelist() {
31048
31110
 
@@ -31060,6 +31122,31 @@ class OrganizationApi {
31060
31122
  );
31061
31123
  }
31062
31124
 
31125
+ /**
31126
+ * Update the organization's settings
31127
+ *
31128
+ * @param {Object} body Org settings
31129
+ */
31130
+ patchOrganizationsAuthenticationSettings(body) {
31131
+ // verify the required parameter 'body' is set
31132
+ if (body === undefined || body === null) {
31133
+ throw 'Missing the required parameter "body" when calling patchOrganizationsAuthenticationSettings';
31134
+ }
31135
+
31136
+ return this.apiClient.callApi(
31137
+ '/api/v2/organizations/authentication/settings',
31138
+ 'PATCH',
31139
+ { },
31140
+ { },
31141
+ { },
31142
+ { },
31143
+ body,
31144
+ ['PureCloud OAuth'],
31145
+ ['application/json'],
31146
+ ['application/json']
31147
+ );
31148
+ }
31149
+
31063
31150
  /**
31064
31151
  * Update organization
31065
31152
  *
@@ -31092,8 +31179,9 @@ class OrganizationApi {
31092
31179
 
31093
31180
  /**
31094
31181
  * Update the list of domains that will be allowed to embed PureCloud applications
31095
- *
31182
+ * This route is deprecated, please use /api/v2/organizations/authentication/settings instead
31096
31183
  * @param {Object} body Whitelist settings
31184
+ * @deprecated
31097
31185
  */
31098
31186
  putOrganizationsEmbeddedintegration(body) {
31099
31187
  // verify the required parameter 'body' is set
@@ -31117,8 +31205,9 @@ class OrganizationApi {
31117
31205
 
31118
31206
  /**
31119
31207
  * Update organization IP address whitelist settings
31120
- *
31208
+ * This route is deprecated, please use /api/v2/organizations/authentication/settings instead
31121
31209
  * @param {Object} body IP address Whitelist settings
31210
+ * @deprecated
31122
31211
  */
31123
31212
  putOrganizationsIpaddressauthentication(body) {
31124
31213
  // verify the required parameter 'body' is set
@@ -31165,9 +31254,10 @@ class OrganizationApi {
31165
31254
  }
31166
31255
 
31167
31256
  /**
31168
- * Use PUT /api/v2/organizations/embeddedintegration instead
31257
+ * This route is deprecated, please use /api/v2/organizations/authentication/settings instead
31169
31258
  *
31170
31259
  * @param {Object} body Whitelist settings
31260
+ * @deprecated
31171
31261
  */
31172
31262
  putOrganizationsWhitelist(body) {
31173
31263
  // verify the required parameter 'body' is set
@@ -31195,7 +31285,7 @@ class OrganizationAuthorizationApi {
31195
31285
  /**
31196
31286
  * OrganizationAuthorization service.
31197
31287
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
31198
- * @version 168.1.0
31288
+ * @version 169.0.0
31199
31289
  */
31200
31290
 
31201
31291
  /**
@@ -32490,7 +32580,7 @@ class OutboundApi {
32490
32580
  /**
32491
32581
  * Outbound service.
32492
32582
  * @module purecloud-platform-client-v2/api/OutboundApi
32493
- * @version 168.1.0
32583
+ * @version 169.0.0
32494
32584
  */
32495
32585
 
32496
32586
  /**
@@ -34975,6 +35065,7 @@ class OutboundApi {
34975
35065
  * This endpoint is deprecated and may have unexpected results. Please use "/conversations/{conversationId}/participants/{participantId}/callbacks instead."
34976
35066
  * @param {String} campaignId Campaign ID
34977
35067
  * @param {Object} body ContactCallbackRequest
35068
+ * @deprecated
34978
35069
  */
34979
35070
  postOutboundCampaignCallbackSchedule(campaignId, body) {
34980
35071
  // verify the required parameter 'campaignId' is set
@@ -36111,7 +36202,7 @@ class PresenceApi {
36111
36202
  /**
36112
36203
  * Presence service.
36113
36204
  * @module purecloud-platform-client-v2/api/PresenceApi
36114
- * @version 168.1.0
36205
+ * @version 169.0.0
36115
36206
  */
36116
36207
 
36117
36208
  /**
@@ -36662,7 +36753,7 @@ class ProcessAutomationApi {
36662
36753
  /**
36663
36754
  * ProcessAutomation service.
36664
36755
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
36665
- * @version 168.1.0
36756
+ * @version 169.0.0
36666
36757
  */
36667
36758
 
36668
36759
  /**
@@ -36901,7 +36992,7 @@ class QualityApi {
36901
36992
  /**
36902
36993
  * Quality service.
36903
36994
  * @module purecloud-platform-client-v2/api/QualityApi
36904
- * @version 168.1.0
36995
+ * @version 169.0.0
36905
36996
  */
36906
36997
 
36907
36998
  /**
@@ -36984,6 +37075,7 @@ class QualityApi {
36984
37075
  * Delete an evaluation form.
36985
37076
  *
36986
37077
  * @param {String} formId Form ID
37078
+ * @deprecated
36987
37079
  */
36988
37080
  deleteQualityForm(formId) {
36989
37081
  // verify the required parameter 'formId' is set
@@ -37352,6 +37444,7 @@ class QualityApi {
37352
37444
  * Get an evaluation form
37353
37445
  *
37354
37446
  * @param {String} formId Form ID
37447
+ * @deprecated
37355
37448
  */
37356
37449
  getQualityForm(formId) {
37357
37450
  // verify the required parameter 'formId' is set
@@ -37380,6 +37473,7 @@ class QualityApi {
37380
37473
  * @param {Object} opts Optional parameters
37381
37474
  * @param {Number} opts.pageSize Page size (default to 25)
37382
37475
  * @param {Number} opts.pageNumber Page number (default to 1)
37476
+ * @deprecated
37383
37477
  */
37384
37478
  getQualityFormVersions(formId, opts) {
37385
37479
  opts = opts || {};
@@ -37415,6 +37509,7 @@ class QualityApi {
37415
37509
  * @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
37416
37510
  * @param {String} opts.name Name
37417
37511
  * @param {String} opts.sortOrder Order to sort results, either asc or desc
37512
+ * @deprecated
37418
37513
  */
37419
37514
  getQualityForms(opts) {
37420
37515
  opts = opts || {};
@@ -37690,6 +37785,7 @@ class QualityApi {
37690
37785
  * Get the published evaluation forms.
37691
37786
  *
37692
37787
  * @param {String} formId Form ID
37788
+ * @deprecated
37693
37789
  */
37694
37790
  getQualityPublishedform(formId) {
37695
37791
  // verify the required parameter 'formId' is set
@@ -37719,6 +37815,7 @@ class QualityApi {
37719
37815
  * @param {Number} opts.pageNumber Page number (default to 1)
37720
37816
  * @param {String} opts.name Name
37721
37817
  * @param {Boolean} opts.onlyLatestPerContext onlyLatestPerContext (default to false)
37818
+ * @deprecated
37722
37819
  */
37723
37820
  getQualityPublishedforms(opts) {
37724
37821
  opts = opts || {};
@@ -38114,6 +38211,7 @@ class QualityApi {
38114
38211
  * Create an evaluation form.
38115
38212
  *
38116
38213
  * @param {Object} body Evaluation form
38214
+ * @deprecated
38117
38215
  */
38118
38216
  postQualityForms(body) {
38119
38217
  // verify the required parameter 'body' is set
@@ -38189,6 +38287,7 @@ class QualityApi {
38189
38287
  * Publish an evaluation form.
38190
38288
  *
38191
38289
  * @param {Object} body Publish request containing id of form to publish
38290
+ * @deprecated
38192
38291
  */
38193
38292
  postQualityPublishedforms(body) {
38194
38293
  // verify the required parameter 'body' is set
@@ -38359,6 +38458,7 @@ class QualityApi {
38359
38458
  *
38360
38459
  * @param {String} formId Form ID
38361
38460
  * @param {Object} body Evaluation form
38461
+ * @deprecated
38362
38462
  */
38363
38463
  putQualityForm(formId, body) {
38364
38464
  // verify the required parameter 'formId' is set
@@ -38480,7 +38580,7 @@ class RecordingApi {
38480
38580
  /**
38481
38581
  * Recording service.
38482
38582
  * @module purecloud-platform-client-v2/api/RecordingApi
38483
- * @version 168.1.0
38583
+ * @version 169.0.0
38484
38584
  */
38485
38585
 
38486
38586
  /**
@@ -40117,7 +40217,7 @@ class ResponseManagementApi {
40117
40217
  /**
40118
40218
  * ResponseManagement service.
40119
40219
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
40120
- * @version 168.1.0
40220
+ * @version 169.0.0
40121
40221
  */
40122
40222
 
40123
40223
  /**
@@ -40602,7 +40702,7 @@ class RoutingApi {
40602
40702
  /**
40603
40703
  * Routing service.
40604
40704
  * @module purecloud-platform-client-v2/api/RoutingApi
40605
- * @version 168.1.0
40705
+ * @version 169.0.0
40606
40706
  */
40607
40707
 
40608
40708
  /**
@@ -40836,6 +40936,7 @@ class RoutingApi {
40836
40936
  *
40837
40937
  * @param {String} queueId Queue ID
40838
40938
  * @param {String} memberId Member ID
40939
+ * @deprecated
40839
40940
  */
40840
40941
  deleteRoutingQueueUser(queueId, memberId) {
40841
40942
  // verify the required parameter 'queueId' is set
@@ -41927,6 +42028,7 @@ class RoutingApi {
41927
42028
  * @param {Array.<String>} opts.languages Filter by language
41928
42029
  * @param {Array.<String>} opts.routingStatus Filter by routing status
41929
42030
  * @param {Array.<String>} opts.presence Filter by presence
42031
+ * @deprecated
41930
42032
  */
41931
42033
  getRoutingQueueUsers(queueId, opts) {
41932
42034
  opts = opts || {};
@@ -42884,6 +42986,7 @@ class RoutingApi {
42884
42986
  * @param {String} queueId Queue ID
42885
42987
  * @param {String} memberId Member ID
42886
42988
  * @param {Object} body Queue Member
42989
+ * @deprecated
42887
42990
  */
42888
42991
  patchRoutingQueueUser(queueId, memberId, body) {
42889
42992
  // verify the required parameter 'queueId' is set
@@ -42918,6 +43021,7 @@ class RoutingApi {
42918
43021
  *
42919
43022
  * @param {String} queueId Queue ID
42920
43023
  * @param {Array.<Object>} body Queue Members
43024
+ * @deprecated
42921
43025
  */
42922
43026
  patchRoutingQueueUsers(queueId, body) {
42923
43027
  // verify the required parameter 'queueId' is set
@@ -43459,6 +43563,7 @@ class RoutingApi {
43459
43563
  * @param {Array.<Object>} body Queue Members
43460
43564
  * @param {Object} opts Optional parameters
43461
43565
  * @param {Boolean} opts._delete True to delete queue members (default to false)
43566
+ * @deprecated
43462
43567
  */
43463
43568
  postRoutingQueueUsers(queueId, body, opts) {
43464
43569
  opts = opts || {};
@@ -44111,7 +44216,7 @@ class SCIMApi {
44111
44216
  /**
44112
44217
  * SCIM service.
44113
44218
  * @module purecloud-platform-client-v2/api/SCIMApi
44114
- * @version 168.1.0
44219
+ * @version 169.0.0
44115
44220
  */
44116
44221
 
44117
44222
  /**
@@ -44988,7 +45093,7 @@ class ScriptsApi {
44988
45093
  /**
44989
45094
  * Scripts service.
44990
45095
  * @module purecloud-platform-client-v2/api/ScriptsApi
44991
- * @version 168.1.0
45096
+ * @version 169.0.0
44992
45097
  */
44993
45098
 
44994
45099
  /**
@@ -45407,7 +45512,7 @@ class SearchApi {
45407
45512
  /**
45408
45513
  * Search service.
45409
45514
  * @module purecloud-platform-client-v2/api/SearchApi
45410
- * @version 168.1.0
45515
+ * @version 169.0.0
45411
45516
  */
45412
45517
 
45413
45518
  /**
@@ -45780,6 +45885,7 @@ class SearchApi {
45780
45885
  * @param {String} knowledgeBaseId Knowledge base ID
45781
45886
  * @param {Object} opts Optional parameters
45782
45887
  * @param {Object} opts.body
45888
+ * @deprecated
45783
45889
  */
45784
45890
  postKnowledgeKnowledgebaseSearch(knowledgeBaseId, opts) {
45785
45891
  opts = opts || {};
@@ -46017,7 +46123,7 @@ class SpeechTextAnalyticsApi {
46017
46123
  /**
46018
46124
  * SpeechTextAnalytics service.
46019
46125
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
46020
- * @version 168.1.0
46126
+ * @version 169.0.0
46021
46127
  */
46022
46128
 
46023
46129
  /**
@@ -46570,6 +46676,30 @@ class SpeechTextAnalyticsApi {
46570
46676
  );
46571
46677
  }
46572
46678
 
46679
+ /**
46680
+ * Get the list of general topics from the org and the system with their current status
46681
+ *
46682
+ * @param {Object} opts Optional parameters
46683
+ * @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
46684
+ */
46685
+ getSpeechandtextanalyticsTopicsGeneralStatus(opts) {
46686
+ opts = opts || {};
46687
+
46688
+
46689
+ return this.apiClient.callApi(
46690
+ '/api/v2/speechandtextanalytics/topics/general/status',
46691
+ 'GET',
46692
+ { },
46693
+ { 'dialect': opts['dialect'] },
46694
+ { },
46695
+ { },
46696
+ null,
46697
+ ['PureCloud OAuth'],
46698
+ ['application/json'],
46699
+ ['application/json']
46700
+ );
46701
+ }
46702
+
46573
46703
  /**
46574
46704
  * Get a Speech and Text Analytics publish topics job by id
46575
46705
  *
@@ -46946,7 +47076,7 @@ class StationsApi {
46946
47076
  /**
46947
47077
  * Stations service.
46948
47078
  * @module purecloud-platform-client-v2/api/StationsApi
46949
- * @version 168.1.0
47079
+ * @version 169.0.0
46950
47080
  */
46951
47081
 
46952
47082
  /**
@@ -47048,7 +47178,7 @@ class SuggestApi {
47048
47178
  /**
47049
47179
  * Suggest service.
47050
47180
  * @module purecloud-platform-client-v2/api/SuggestApi
47051
- * @version 168.1.0
47181
+ * @version 169.0.0
47052
47182
  */
47053
47183
 
47054
47184
  /**
@@ -47187,7 +47317,7 @@ class TeamsApi {
47187
47317
  /**
47188
47318
  * Teams service.
47189
47319
  * @module purecloud-platform-client-v2/api/TeamsApi
47190
- * @version 168.1.0
47320
+ * @version 169.0.0
47191
47321
  */
47192
47322
 
47193
47323
  /**
@@ -47458,7 +47588,7 @@ class TelephonyApi {
47458
47588
  /**
47459
47589
  * Telephony service.
47460
47590
  * @module purecloud-platform-client-v2/api/TelephonyApi
47461
- * @version 168.1.0
47591
+ * @version 169.0.0
47462
47592
  */
47463
47593
 
47464
47594
  /**
@@ -47586,7 +47716,7 @@ class TelephonyProvidersEdgeApi {
47586
47716
  /**
47587
47717
  * TelephonyProvidersEdge service.
47588
47718
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
47589
- * @version 168.1.0
47719
+ * @version 169.0.0
47590
47720
  */
47591
47721
 
47592
47722
  /**
@@ -48980,6 +49110,7 @@ class TelephonyProvidersEdgeApi {
48980
49110
  * Get outbound route
48981
49111
  * This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} instead.
48982
49112
  * @param {String} outboundRouteId Outbound route ID
49113
+ * @deprecated
48983
49114
  */
48984
49115
  getTelephonyProvidersEdgesOutboundroute(outboundRouteId) {
48985
49116
  // verify the required parameter 'outboundRouteId' is set
@@ -50786,7 +50917,7 @@ class TextbotsApi {
50786
50917
  /**
50787
50918
  * Textbots service.
50788
50919
  * @module purecloud-platform-client-v2/api/TextbotsApi
50789
- * @version 168.1.0
50920
+ * @version 169.0.0
50790
50921
  */
50791
50922
 
50792
50923
  /**
@@ -50914,7 +51045,7 @@ class TokensApi {
50914
51045
  /**
50915
51046
  * Tokens service.
50916
51047
  * @module purecloud-platform-client-v2/api/TokensApi
50917
- * @version 168.1.0
51048
+ * @version 169.0.0
50918
51049
  */
50919
51050
 
50920
51051
  /**
@@ -51020,7 +51151,7 @@ class UploadsApi {
51020
51151
  /**
51021
51152
  * Uploads service.
51022
51153
  * @module purecloud-platform-client-v2/api/UploadsApi
51023
- * @version 168.1.0
51154
+ * @version 169.0.0
51024
51155
  */
51025
51156
 
51026
51157
  /**
@@ -51196,7 +51327,7 @@ class UsageApi {
51196
51327
  /**
51197
51328
  * Usage service.
51198
51329
  * @module purecloud-platform-client-v2/api/UsageApi
51199
- * @version 168.1.0
51330
+ * @version 169.0.0
51200
51331
  */
51201
51332
 
51202
51333
  /**
@@ -51295,6 +51426,31 @@ class UsageApi {
51295
51426
  );
51296
51427
  }
51297
51428
 
51429
+ /**
51430
+ * Get the results of a usage search
51431
+ *
51432
+ * @param {String} executionId ID of the search execution
51433
+ */
51434
+ getUsageSimplesearchExecutionIdResults(executionId) {
51435
+ // verify the required parameter 'executionId' is set
51436
+ if (executionId === undefined || executionId === null) {
51437
+ throw 'Missing the required parameter "executionId" when calling getUsageSimplesearchExecutionIdResults';
51438
+ }
51439
+
51440
+ return this.apiClient.callApi(
51441
+ '/api/v2/usage/simplesearch/{executionId}/results',
51442
+ 'GET',
51443
+ { 'executionId': executionId },
51444
+ { },
51445
+ { },
51446
+ { },
51447
+ null,
51448
+ ['PureCloud OAuth'],
51449
+ ['application/json'],
51450
+ ['application/json']
51451
+ );
51452
+ }
51453
+
51298
51454
  /**
51299
51455
  * Query for OAuth client API usage
51300
51456
  * After calling this method, you will then need to poll for the query results based on the returned execution Id
@@ -51350,13 +51506,38 @@ class UsageApi {
51350
51506
  );
51351
51507
  }
51352
51508
 
51509
+ /**
51510
+ * Search organization API Usage -
51511
+ * After calling this method, you will then need to poll for the query results based on the returned execution Id
51512
+ * @param {Object} body SimpleSearch
51513
+ */
51514
+ postUsageSimplesearch(body) {
51515
+ // verify the required parameter 'body' is set
51516
+ if (body === undefined || body === null) {
51517
+ throw 'Missing the required parameter "body" when calling postUsageSimplesearch';
51518
+ }
51519
+
51520
+ return this.apiClient.callApi(
51521
+ '/api/v2/usage/simplesearch',
51522
+ 'POST',
51523
+ { },
51524
+ { },
51525
+ { },
51526
+ { },
51527
+ body,
51528
+ ['PureCloud OAuth'],
51529
+ ['application/json'],
51530
+ ['application/json']
51531
+ );
51532
+ }
51533
+
51353
51534
  }
51354
51535
 
51355
51536
  class UserRecordingsApi {
51356
51537
  /**
51357
51538
  * UserRecordings service.
51358
51539
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
51359
- * @version 168.1.0
51540
+ * @version 169.0.0
51360
51541
  */
51361
51542
 
51362
51543
  /**
@@ -51541,7 +51722,7 @@ class UsersApi {
51541
51722
  /**
51542
51723
  * Users service.
51543
51724
  * @module purecloud-platform-client-v2/api/UsersApi
51544
- * @version 168.1.0
51725
+ * @version 169.0.0
51545
51726
  */
51546
51727
 
51547
51728
  /**
@@ -51857,6 +52038,7 @@ class UsersApi {
51857
52038
  * @param {String} permission The permission string, including the object to access, e.g. routing:queue:view
51858
52039
  * @param {Object} opts Optional parameters
51859
52040
  * @param {String} opts.name Search term to filter by division name
52041
+ * @deprecated
51860
52042
  */
51861
52043
  getAuthorizationDivisionspermittedMe(permission, opts) {
51862
52044
  opts = opts || {};
@@ -51918,6 +52100,7 @@ class UsersApi {
51918
52100
  * @param {Object} opts Optional parameters
51919
52101
  * @param {Number} opts.pageNumber Page number (default to 1)
51920
52102
  * @param {Number} opts.pageSize Page size (default to 25)
52103
+ * @deprecated
51921
52104
  */
51922
52105
  getAuthorizationDivisionspermittedPagedSubjectId(subjectId, permission, opts) {
51923
52106
  opts = opts || {};
@@ -51994,6 +52177,7 @@ class UsersApi {
51994
52177
  * Fetch field config for an entity type
51995
52178
  *
51996
52179
  * @param {Object} type Field type
52180
+ * @deprecated
51997
52181
  */
51998
52182
  getFieldconfig(type) {
51999
52183
  // verify the required parameter 'type' is set
@@ -52026,6 +52210,7 @@ class UsersApi {
52026
52210
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
52027
52211
  * @param {Array.<String>} opts.expand Which fields, if any, to expand
52028
52212
  * @param {Object} opts.integrationPresenceSource Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an expand.
52213
+ * @deprecated
52029
52214
  */
52030
52215
  getProfilesUsers(opts) {
52031
52216
  opts = opts || {};
@@ -52193,6 +52378,7 @@ class UsersApi {
52193
52378
  * @param {Number} opts.pageNumber Page number (default to 1)
52194
52379
  * @param {String} opts.sortOrder Sort order (default to ASC)
52195
52380
  * @param {Array.<String>} opts.expand Which fields, if any, to expand
52381
+ * @deprecated
52196
52382
  */
52197
52383
  getUserFavorites(userId, opts) {
52198
52384
  opts = opts || {};
@@ -52278,6 +52464,7 @@ class UsersApi {
52278
52464
  * @param {Object} opts Optional parameters
52279
52465
  * @param {Array.<String>} opts.expand Which fields, if any, to expand
52280
52466
  * @param {Object} opts.integrationPresenceSource Gets an integration presence for a user instead of their default.
52467
+ * @deprecated
52281
52468
  */
52282
52469
  getUserProfile(userId, opts) {
52283
52470
  opts = opts || {};
@@ -53931,7 +54118,7 @@ class UtilitiesApi {
53931
54118
  /**
53932
54119
  * Utilities service.
53933
54120
  * @module purecloud-platform-client-v2/api/UtilitiesApi
53934
- * @version 168.1.0
54121
+ * @version 169.0.0
53935
54122
  */
53936
54123
 
53937
54124
  /**
@@ -54042,7 +54229,7 @@ class VoicemailApi {
54042
54229
  /**
54043
54230
  * Voicemail service.
54044
54231
  * @module purecloud-platform-client-v2/api/VoicemailApi
54045
- * @version 168.1.0
54232
+ * @version 169.0.0
54046
54233
  */
54047
54234
 
54048
54235
  /**
@@ -54709,7 +54896,7 @@ class WebChatApi {
54709
54896
  /**
54710
54897
  * WebChat service.
54711
54898
  * @module purecloud-platform-client-v2/api/WebChatApi
54712
- * @version 168.1.0
54899
+ * @version 169.0.0
54713
54900
  */
54714
54901
 
54715
54902
  /**
@@ -54728,6 +54915,7 @@ class WebChatApi {
54728
54915
  * Delete a WebChat deployment
54729
54916
  *
54730
54917
  * @param {String} deploymentId Deployment Id
54918
+ * @deprecated
54731
54919
  */
54732
54920
  deleteWebchatDeployment(deploymentId) {
54733
54921
  // verify the required parameter 'deploymentId' is set
@@ -54803,6 +54991,7 @@ class WebChatApi {
54803
54991
  * Get a WebChat deployment
54804
54992
  *
54805
54993
  * @param {String} deploymentId Deployment Id
54994
+ * @deprecated
54806
54995
  */
54807
54996
  getWebchatDeployment(deploymentId) {
54808
54997
  // verify the required parameter 'deploymentId' is set
@@ -54827,6 +55016,7 @@ class WebChatApi {
54827
55016
  /**
54828
55017
  * List WebChat deployments
54829
55018
  *
55019
+ * @deprecated
54830
55020
  */
54831
55021
  getWebchatDeployments() {
54832
55022
 
@@ -55081,6 +55271,7 @@ class WebChatApi {
55081
55271
  * Create WebChat deployment
55082
55272
  *
55083
55273
  * @param {Object} body Deployment
55274
+ * @deprecated
55084
55275
  */
55085
55276
  postWebchatDeployments(body) {
55086
55277
  // verify the required parameter 'body' is set
@@ -55197,6 +55388,7 @@ class WebChatApi {
55197
55388
  *
55198
55389
  * @param {String} deploymentId Deployment Id
55199
55390
  * @param {Object} body Deployment
55391
+ * @deprecated
55200
55392
  */
55201
55393
  putWebchatDeployment(deploymentId, body) {
55202
55394
  // verify the required parameter 'deploymentId' is set
@@ -55253,7 +55445,7 @@ class WebDeploymentsApi {
55253
55445
  /**
55254
55446
  * WebDeployments service.
55255
55447
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
55256
- * @version 168.1.0
55448
+ * @version 169.0.0
55257
55449
  */
55258
55450
 
55259
55451
  /**
@@ -55775,7 +55967,7 @@ class WebMessagingApi {
55775
55967
  /**
55776
55968
  * WebMessaging service.
55777
55969
  * @module purecloud-platform-client-v2/api/WebMessagingApi
55778
- * @version 168.1.0
55970
+ * @version 169.0.0
55779
55971
  */
55780
55972
 
55781
55973
  /**
@@ -55821,7 +56013,7 @@ class WidgetsApi {
55821
56013
  /**
55822
56014
  * Widgets service.
55823
56015
  * @module purecloud-platform-client-v2/api/WidgetsApi
55824
- * @version 168.1.0
56016
+ * @version 169.0.0
55825
56017
  */
55826
56018
 
55827
56019
  /**
@@ -55967,7 +56159,7 @@ class WorkforceManagementApi {
55967
56159
  /**
55968
56160
  * WorkforceManagement service.
55969
56161
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
55970
- * @version 168.1.0
56162
+ * @version 169.0.0
55971
56163
  */
55972
56164
 
55973
56165
  /**
@@ -57509,6 +57701,7 @@ class WorkforceManagementApi {
57509
57701
  * Get activity codes
57510
57702
  *
57511
57703
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
57704
+ * @deprecated
57512
57705
  */
57513
57706
  getWorkforcemanagementManagementunitActivitycodes(managementUnitId) {
57514
57707
  // verify the required parameter 'managementUnitId' is set
@@ -57921,6 +58114,7 @@ class WorkforceManagementApi {
57921
58114
  * @param {Object} opts Optional parameters
57922
58115
  * @param {Object} opts.expand Which fields, if any, to expand
57923
58116
  * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
58117
+ * @deprecated
57924
58118
  */
57925
58119
  getWorkforcemanagementManagementunitWeekSchedule(managementUnitId, weekId, scheduleId, opts) {
57926
58120
  opts = opts || {};
@@ -57961,6 +58155,7 @@ class WorkforceManagementApi {
57961
58155
  * @param {Boolean} opts.includeOnlyPublished Return only published schedules
57962
58156
  * @param {String} opts.earliestWeekDate The start date of the earliest week to query in yyyy-MM-dd format
57963
58157
  * @param {String} opts.latestWeekDate The start date of the latest week to query in yyyy-MM-dd format
58158
+ * @deprecated
57964
58159
  */
57965
58160
  getWorkforcemanagementManagementunitWeekSchedules(managementUnitId, weekId, opts) {
57966
58161
  opts = opts || {};
@@ -59919,6 +60114,7 @@ class WorkforceManagementApi {
59919
60114
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
59920
60115
  * @param {Object} opts Optional parameters
59921
60116
  * @param {Object} opts.body body
60117
+ * @deprecated
59922
60118
  */
59923
60119
  postWorkforcemanagementManagementunitSchedulesSearch(managementUnitId, opts) {
59924
60120
  opts = opts || {};
@@ -60579,6 +60775,7 @@ class WorkforceManagementApi {
60579
60775
  *
60580
60776
  * @param {Object} opts Optional parameters
60581
60777
  * @param {Object} opts.body body
60778
+ * @deprecated
60582
60779
  */
60583
60780
  postWorkforcemanagementSchedules(opts) {
60584
60781
  opts = opts || {};
@@ -60769,7 +60966,7 @@ class WorkforceManagementApi {
60769
60966
  * </pre>
60770
60967
  * </p>
60771
60968
  * @module purecloud-platform-client-v2/index
60772
- * @version 168.1.0
60969
+ * @version 169.0.0
60773
60970
  */
60774
60971
  class platformClient {
60775
60972
  constructor() {