purecloud-platform-client-v2 179.3.0 → 181.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 (83) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +538 -166
  3. package/dist/web-amd/purecloud-platform-client-v2.js +538 -166
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +538 -166
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +790 -213
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +459 -250
  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 +1 -1
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/ChatApi.js +8 -80
  19. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +59 -3
  22. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/JourneyApi.js +73 -2
  38. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +71 -0
  50. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/PresenceApi.js +9 -4
  54. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/QualityApi.js +2 -2
  56. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +57 -1
  69. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +86 -1
  70. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/UsersApi.js +92 -2
  76. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +17 -7
  83. package/src/purecloud-platform-client-v2/index.js +7 -1
@@ -402,7 +402,7 @@ class Configuration {
402
402
 
403
403
  /**
404
404
  * @module purecloud-platform-client-v2/ApiClient
405
- * @version 179.3.0
405
+ * @version 181.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 179.3.0
1491
+ * @version 181.0.0
1492
1492
  */
1493
1493
 
1494
1494
  /**
@@ -2138,7 +2138,7 @@ class AnalyticsApi {
2138
2138
  /**
2139
2139
  * Analytics service.
2140
2140
  * @module purecloud-platform-client-v2/api/AnalyticsApi
2141
- * @version 179.3.0
2141
+ * @version 181.0.0
2142
2142
  */
2143
2143
 
2144
2144
  /**
@@ -4584,7 +4584,7 @@ class ArchitectApi {
4584
4584
  /**
4585
4585
  * Architect service.
4586
4586
  * @module purecloud-platform-client-v2/api/ArchitectApi
4587
- * @version 179.3.0
4587
+ * @version 181.0.0
4588
4588
  */
4589
4589
 
4590
4590
  /**
@@ -8419,7 +8419,7 @@ class AuditApi {
8419
8419
  /**
8420
8420
  * Audit service.
8421
8421
  * @module purecloud-platform-client-v2/api/AuditApi
8422
- * @version 179.3.0
8422
+ * @version 181.0.0
8423
8423
  */
8424
8424
 
8425
8425
  /**
@@ -8590,7 +8590,7 @@ class AuthorizationApi {
8590
8590
  /**
8591
8591
  * Authorization service.
8592
8592
  * @module purecloud-platform-client-v2/api/AuthorizationApi
8593
- * @version 179.3.0
8593
+ * @version 181.0.0
8594
8594
  */
8595
8595
 
8596
8596
  /**
@@ -9821,7 +9821,7 @@ class BillingApi {
9821
9821
  /**
9822
9822
  * Billing service.
9823
9823
  * @module purecloud-platform-client-v2/api/BillingApi
9824
- * @version 179.3.0
9824
+ * @version 181.0.0
9825
9825
  */
9826
9826
 
9827
9827
  /**
@@ -9901,7 +9901,7 @@ class CarrierServicesApi {
9901
9901
  /**
9902
9902
  * CarrierServices service.
9903
9903
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
9904
- * @version 179.3.0
9904
+ * @version 181.0.0
9905
9905
  */
9906
9906
 
9907
9907
  /**
@@ -9971,7 +9971,7 @@ class ChatApi {
9971
9971
  /**
9972
9972
  * Chat service.
9973
9973
  * @module purecloud-platform-client-v2/api/ChatApi
9974
- * @version 179.3.0
9974
+ * @version 181.0.0
9975
9975
  */
9976
9976
 
9977
9977
  /**
@@ -10110,27 +10110,6 @@ class ChatApi {
10110
10110
  );
10111
10111
  }
10112
10112
 
10113
- /**
10114
- * Get Chat Settings.
10115
- * This route is deprecated, please use /chats/settings instead
10116
- * @deprecated
10117
- */
10118
- getChatSettings() {
10119
-
10120
- return this.apiClient.callApi(
10121
- '/api/v2/chat/settings',
10122
- 'GET',
10123
- { },
10124
- { },
10125
- { },
10126
- { },
10127
- null,
10128
- ['PureCloud OAuth'],
10129
- ['application/json'],
10130
- ['application/json']
10131
- );
10132
- }
10133
-
10134
10113
  /**
10135
10114
  * Get a message
10136
10115
  *
@@ -10379,32 +10358,6 @@ class ChatApi {
10379
10358
  );
10380
10359
  }
10381
10360
 
10382
- /**
10383
- * Patch Chat Settings.
10384
- * This route is deprecated, please use /chats/settings instead
10385
- * @param {Object} body Chat
10386
- * @deprecated
10387
- */
10388
- patchChatSettings(body) {
10389
- // verify the required parameter 'body' is set
10390
- if (body === undefined || body === null) {
10391
- throw 'Missing the required parameter "body" when calling patchChatSettings';
10392
- }
10393
-
10394
- return this.apiClient.callApi(
10395
- '/api/v2/chat/settings',
10396
- 'PATCH',
10397
- { },
10398
- { },
10399
- { },
10400
- { },
10401
- body,
10402
- ['PureCloud OAuth'],
10403
- ['application/json'],
10404
- ['application/json']
10405
- );
10406
- }
10407
-
10408
10361
  /**
10409
10362
  * Set properties for a room
10410
10363
  *
@@ -10629,13 +10582,14 @@ class ChatApi {
10629
10582
  /**
10630
10583
  * Create an adhoc room
10631
10584
  *
10632
- * @param {Object} opts Optional parameters
10633
- * @param {Object} opts.body Room properties
10585
+ * @param {Object} body Room properties
10634
10586
  * postChatsRooms is a preview method and is subject to both breaking and non-breaking changes at any time without notice
10635
10587
  */
10636
- postChatsRooms(opts) {
10637
- opts = opts || {};
10638
-
10588
+ postChatsRooms(body) {
10589
+ // verify the required parameter 'body' is set
10590
+ if (body === undefined || body === null) {
10591
+ throw 'Missing the required parameter "body" when calling postChatsRooms';
10592
+ }
10639
10593
 
10640
10594
  return this.apiClient.callApi(
10641
10595
  '/api/v2/chats/rooms',
@@ -10644,7 +10598,7 @@ class ChatApi {
10644
10598
  { },
10645
10599
  { },
10646
10600
  { },
10647
- opts['body'],
10601
+ body,
10648
10602
  ['PureCloud OAuth'],
10649
10603
  ['application/json'],
10650
10604
  ['application/json']
@@ -10682,32 +10636,6 @@ class ChatApi {
10682
10636
  );
10683
10637
  }
10684
10638
 
10685
- /**
10686
- * Update Chat Settings.
10687
- * This route is deprecated, please use /chats/settings instead
10688
- * @param {Object} body Chat
10689
- * @deprecated
10690
- */
10691
- putChatSettings(body) {
10692
- // verify the required parameter 'body' is set
10693
- if (body === undefined || body === null) {
10694
- throw 'Missing the required parameter "body" when calling putChatSettings';
10695
- }
10696
-
10697
- return this.apiClient.callApi(
10698
- '/api/v2/chat/settings',
10699
- 'PUT',
10700
- { },
10701
- { },
10702
- { },
10703
- { },
10704
- body,
10705
- ['PureCloud OAuth'],
10706
- ['application/json'],
10707
- ['application/json']
10708
- );
10709
- }
10710
-
10711
10639
  /**
10712
10640
  * Update Chat Settings.
10713
10641
  *
@@ -10739,7 +10667,7 @@ class CoachingApi {
10739
10667
  /**
10740
10668
  * Coaching service.
10741
10669
  * @module purecloud-platform-client-v2/api/CoachingApi
10742
- * @version 179.3.0
10670
+ * @version 181.0.0
10743
10671
  */
10744
10672
 
10745
10673
  /**
@@ -11316,7 +11244,7 @@ class ContentManagementApi {
11316
11244
  /**
11317
11245
  * ContentManagement service.
11318
11246
  * @module purecloud-platform-client-v2/api/ContentManagementApi
11319
- * @version 179.3.0
11247
+ * @version 181.0.0
11320
11248
  */
11321
11249
 
11322
11250
  /**
@@ -12459,7 +12387,7 @@ class ConversationsApi {
12459
12387
  /**
12460
12388
  * Conversations service.
12461
12389
  * @module purecloud-platform-client-v2/api/ConversationsApi
12462
- * @version 179.3.0
12390
+ * @version 181.0.0
12463
12391
  */
12464
12392
 
12465
12393
  /**
@@ -16504,6 +16432,36 @@ class ConversationsApi {
16504
16432
  );
16505
16433
  }
16506
16434
 
16435
+ /**
16436
+ * Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow
16437
+ * Please specify the phone number to associate with this WhatsApp integration from the list of available phone numbers returned to you in the POST call to create the integration. You can then run a GET on the integration to check if its status has been updated to Active
16438
+ * @param {String} integrationId Integration ID
16439
+ * @param {Object} body WhatsAppEmbeddedSignupIntegrationActivationRequest
16440
+ */
16441
+ patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId(integrationId, body) {
16442
+ // verify the required parameter 'integrationId' is set
16443
+ if (integrationId === undefined || integrationId === null) {
16444
+ throw 'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId';
16445
+ }
16446
+ // verify the required parameter 'body' is set
16447
+ if (body === undefined || body === null) {
16448
+ throw 'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId';
16449
+ }
16450
+
16451
+ return this.apiClient.callApi(
16452
+ '/api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup/{integrationId}',
16453
+ 'PATCH',
16454
+ { 'integrationId': integrationId },
16455
+ { },
16456
+ { },
16457
+ { },
16458
+ body,
16459
+ ['PureCloud OAuth'],
16460
+ ['application/json'],
16461
+ ['application/json']
16462
+ );
16463
+ }
16464
+
16507
16465
  /**
16508
16466
  * Update or activate a WhatsApp messaging integration
16509
16467
  * The following steps are required in order to fully activate a WhatsApp Integration: Initially, you will need to get an activation code by sending: an action set to Activate, and an authenticationMethod choosing from Sms or Voice. Finally, once you have been informed of an activation code on selected authenticationMethod, you will need to confirm the code by sending: an action set to Confirm, and the confirmationCode you have received from Whatsapp.
@@ -18730,9 +18688,10 @@ class ConversationsApi {
18730
18688
  }
18731
18689
 
18732
18690
  /**
18733
- * Create a WhatsApp Integration
18734
- * You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.
18691
+ * [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration
18692
+ * [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.
18735
18693
  * @param {Object} body WhatsAppIntegrationRequest
18694
+ * @deprecated
18736
18695
  */
18737
18696
  postConversationsMessagingIntegrationsWhatsapp(body) {
18738
18697
  // verify the required parameter 'body' is set
@@ -18754,6 +18713,31 @@ class ConversationsApi {
18754
18713
  );
18755
18714
  }
18756
18715
 
18716
+ /**
18717
+ * Create a WhatsApp Integration using the WhatsApp embedded signup flow
18718
+ * Use the access token returned from the embedded signup flow to obtain a list of available phone numbers that can be associated with the created integration. The returned WhatsApp integration will initially have a createStatus of Initiated until the list of available phone numbers can be obtained from the provider. Please run a GET on the created integration until it returns a createStatus of Completed, and the list of available phone numbers obtained from the provider. You can then specify one of the available phone numbers in the PATCH call on the integration to activate it.
18719
+ * @param {Object} body WhatsAppEmbeddedSignupIntegrationRequest
18720
+ */
18721
+ postConversationsMessagingIntegrationsWhatsappEmbeddedsignup(body) {
18722
+ // verify the required parameter 'body' is set
18723
+ if (body === undefined || body === null) {
18724
+ throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsWhatsappEmbeddedsignup';
18725
+ }
18726
+
18727
+ return this.apiClient.callApi(
18728
+ '/api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup',
18729
+ 'POST',
18730
+ { },
18731
+ { },
18732
+ { },
18733
+ { },
18734
+ body,
18735
+ ['PureCloud OAuth'],
18736
+ ['application/json'],
18737
+ ['application/json']
18738
+ );
18739
+ }
18740
+
18757
18741
  /**
18758
18742
  * Create a messaging setting
18759
18743
  *
@@ -19543,7 +19527,7 @@ class DataExtensionsApi {
19543
19527
  /**
19544
19528
  * DataExtensions service.
19545
19529
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
19546
- * @version 179.3.0
19530
+ * @version 181.0.0
19547
19531
  */
19548
19532
 
19549
19533
  /**
@@ -19629,7 +19613,7 @@ class DownloadsApi {
19629
19613
  /**
19630
19614
  * Downloads service.
19631
19615
  * @module purecloud-platform-client-v2/api/DownloadsApi
19632
- * @version 179.3.0
19616
+ * @version 181.0.0
19633
19617
  */
19634
19618
 
19635
19619
  /**
@@ -19681,7 +19665,7 @@ class EmailsApi {
19681
19665
  /**
19682
19666
  * Emails service.
19683
19667
  * @module purecloud-platform-client-v2/api/EmailsApi
19684
- * @version 179.3.0
19668
+ * @version 181.0.0
19685
19669
  */
19686
19670
 
19687
19671
  /**
@@ -19746,7 +19730,7 @@ class EventsApi {
19746
19730
  /**
19747
19731
  * Events service.
19748
19732
  * @module purecloud-platform-client-v2/api/EventsApi
19749
- * @version 179.3.0
19733
+ * @version 181.0.0
19750
19734
  */
19751
19735
 
19752
19736
  /**
@@ -19842,7 +19826,7 @@ class ExternalContactsApi {
19842
19826
  /**
19843
19827
  * ExternalContacts service.
19844
19828
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
19845
- * @version 179.3.0
19829
+ * @version 181.0.0
19846
19830
  */
19847
19831
 
19848
19832
  /**
@@ -21800,7 +21784,7 @@ class FaxApi {
21800
21784
  /**
21801
21785
  * Fax service.
21802
21786
  * @module purecloud-platform-client-v2/api/FaxApi
21803
- * @version 179.3.0
21787
+ * @version 181.0.0
21804
21788
  */
21805
21789
 
21806
21790
  /**
@@ -21971,7 +21955,7 @@ class FlowsApi {
21971
21955
  /**
21972
21956
  * Flows service.
21973
21957
  * @module purecloud-platform-client-v2/api/FlowsApi
21974
- * @version 179.3.0
21958
+ * @version 181.0.0
21975
21959
  */
21976
21960
 
21977
21961
  /**
@@ -22155,7 +22139,7 @@ class GamificationApi {
22155
22139
  /**
22156
22140
  * Gamification service.
22157
22141
  * @module purecloud-platform-client-v2/api/GamificationApi
22158
- * @version 179.3.0
22142
+ * @version 181.0.0
22159
22143
  */
22160
22144
 
22161
22145
  /**
@@ -24241,7 +24225,7 @@ class GeneralDataProtectionRegulationApi {
24241
24225
  /**
24242
24226
  * GeneralDataProtectionRegulation service.
24243
24227
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
24244
- * @version 179.3.0
24228
+ * @version 181.0.0
24245
24229
  */
24246
24230
 
24247
24231
  /**
@@ -24371,7 +24355,7 @@ class GeolocationApi {
24371
24355
  /**
24372
24356
  * Geolocation service.
24373
24357
  * @module purecloud-platform-client-v2/api/GeolocationApi
24374
- * @version 179.3.0
24358
+ * @version 181.0.0
24375
24359
  */
24376
24360
 
24377
24361
  /**
@@ -24502,7 +24486,7 @@ class GreetingsApi {
24502
24486
  /**
24503
24487
  * Greetings service.
24504
24488
  * @module purecloud-platform-client-v2/api/GreetingsApi
24505
- * @version 179.3.0
24489
+ * @version 181.0.0
24506
24490
  */
24507
24491
 
24508
24492
  /**
@@ -24957,7 +24941,7 @@ class GroupsApi {
24957
24941
  /**
24958
24942
  * Groups service.
24959
24943
  * @module purecloud-platform-client-v2/api/GroupsApi
24960
- * @version 179.3.0
24944
+ * @version 181.0.0
24961
24945
  */
24962
24946
 
24963
24947
  /**
@@ -25476,7 +25460,7 @@ class IdentityProviderApi {
25476
25460
  /**
25477
25461
  * IdentityProvider service.
25478
25462
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
25479
- * @version 179.3.0
25463
+ * @version 181.0.0
25480
25464
  */
25481
25465
 
25482
25466
  /**
@@ -26232,7 +26216,7 @@ class InfrastructureAsCodeApi {
26232
26216
  /**
26233
26217
  * InfrastructureAsCode service.
26234
26218
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
26235
- * @version 179.3.0
26219
+ * @version 181.0.0
26236
26220
  */
26237
26221
 
26238
26222
  /**
@@ -26399,7 +26383,7 @@ class IntegrationsApi {
26399
26383
  /**
26400
26384
  * Integrations service.
26401
26385
  * @module purecloud-platform-client-v2/api/IntegrationsApi
26402
- * @version 179.3.0
26386
+ * @version 181.0.0
26403
26387
  */
26404
26388
 
26405
26389
  /**
@@ -28361,7 +28345,7 @@ class JourneyApi {
28361
28345
  /**
28362
28346
  * Journey service.
28363
28347
  * @module purecloud-platform-client-v2/api/JourneyApi
28364
- * @version 179.3.0
28348
+ * @version 181.0.0
28365
28349
  */
28366
28350
 
28367
28351
  /**
@@ -28803,6 +28787,48 @@ class JourneyApi {
28803
28787
  );
28804
28788
  }
28805
28789
 
28790
+ /**
28791
+ * Send a ping.
28792
+ *
28793
+ * @param {String} deploymentId The ID of the deployment sending the ping.
28794
+ * @param {String} customerCookieId ID of the customer associated with the ping.
28795
+ * @param {String} sessionId UUID of the customer session. Use the same Session Id for all pings, AppEvents and ActionEvents in the session
28796
+ * @param {Object} opts Optional parameters
28797
+ * @param {String} opts.dl Document Location: 1) Web Page URL if overridden or URL fragment identifier (window.location.hash). OR 2) Application screen name that the ping request was sent from in the app. e.g. 'home' or 'help. Pings without this parameter will not return actions.
28798
+ * @param {String} opts.dt Document Title. A human readable name for the page or screen
28799
+ * @param {String} opts.appNamespace Namespace of the application (e.g. com.genesys.bancodinero). Used for domain filtering in application sessions
28800
+ * @param {Number} opts.sinceLastBeaconMilliseconds How long (milliseconds) since the last app event or beacon was sent. The response may return a pollInternvalMilliseconds to reduce the frequency of pings.
28801
+ */
28802
+ getJourneyDeploymentCustomerPing(deploymentId, customerCookieId, sessionId, opts) {
28803
+ opts = opts || {};
28804
+
28805
+ // verify the required parameter 'deploymentId' is set
28806
+ if (deploymentId === undefined || deploymentId === null) {
28807
+ throw 'Missing the required parameter "deploymentId" when calling getJourneyDeploymentCustomerPing';
28808
+ }
28809
+ // verify the required parameter 'customerCookieId' is set
28810
+ if (customerCookieId === undefined || customerCookieId === null) {
28811
+ throw 'Missing the required parameter "customerCookieId" when calling getJourneyDeploymentCustomerPing';
28812
+ }
28813
+ // verify the required parameter 'sessionId' is set
28814
+ if (sessionId === undefined || sessionId === null) {
28815
+ throw 'Missing the required parameter "sessionId" when calling getJourneyDeploymentCustomerPing';
28816
+ }
28817
+
28818
+ return this.apiClient.callApi(
28819
+ '/api/v2/journey/deployments/{deploymentId}/customers/{customerCookieId}/ping',
28820
+ 'GET',
28821
+ { 'deploymentId': deploymentId,'customerCookieId': customerCookieId },
28822
+ { 'dl': opts['dl'],'dt': opts['dt'],'appNamespace': opts['appNamespace'],'sessionId': sessionId,'sinceLastBeaconMilliseconds': opts['sinceLastBeaconMilliseconds'] },
28823
+ { },
28824
+ { },
28825
+ null,
28826
+ ['PureCloud OAuth'],
28827
+ ['application/json'],
28828
+ ['application/json']
28829
+ );
28830
+ }
28831
+
28806
28832
  /**
28807
28833
  * Retrieve a single outcome.
28808
28834
  *
@@ -29392,13 +29418,42 @@ class JourneyApi {
29392
29418
  );
29393
29419
  }
29394
29420
 
29421
+ /**
29422
+ * Sends an action event, which is used for changing the state of actions that have been offered to the user.
29423
+ *
29424
+ * @param {String} deploymentId The ID of the deployment sending the beacon.
29425
+ * @param {Object} body
29426
+ */
29427
+ postJourneyDeploymentActionevent(deploymentId, body) {
29428
+ // verify the required parameter 'deploymentId' is set
29429
+ if (deploymentId === undefined || deploymentId === null) {
29430
+ throw 'Missing the required parameter "deploymentId" when calling postJourneyDeploymentActionevent';
29431
+ }
29432
+ // verify the required parameter 'body' is set
29433
+ if (body === undefined || body === null) {
29434
+ throw 'Missing the required parameter "body" when calling postJourneyDeploymentActionevent';
29435
+ }
29436
+
29437
+ return this.apiClient.callApi(
29438
+ '/api/v2/journey/deployments/{deploymentId}/actionevent',
29439
+ 'POST',
29440
+ { 'deploymentId': deploymentId },
29441
+ { },
29442
+ { },
29443
+ { },
29444
+ body,
29445
+ ['PureCloud OAuth'],
29446
+ ['application/json'],
29447
+ ['application/json']
29448
+ );
29449
+ }
29450
+
29395
29451
  /**
29396
29452
  * Send a journey app event, used for tracking customer activity on an application.
29397
29453
  *
29398
29454
  * @param {String} deploymentId The ID of the deployment sending the app event.
29399
29455
  * @param {Object} opts Optional parameters
29400
29456
  * @param {Object} opts.body
29401
- * postJourneyDeploymentAppevents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
29402
29457
  */
29403
29458
  postJourneyDeploymentAppevents(deploymentId, opts) {
29404
29459
  opts = opts || {};
@@ -29525,7 +29580,7 @@ class KnowledgeApi {
29525
29580
  /**
29526
29581
  * Knowledge service.
29527
29582
  * @module purecloud-platform-client-v2/api/KnowledgeApi
29528
- * @version 179.3.0
29583
+ * @version 181.0.0
29529
29584
  */
29530
29585
 
29531
29586
  /**
@@ -32346,7 +32401,7 @@ class LanguageUnderstandingApi {
32346
32401
  /**
32347
32402
  * LanguageUnderstanding service.
32348
32403
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
32349
- * @version 179.3.0
32404
+ * @version 181.0.0
32350
32405
  */
32351
32406
 
32352
32407
  /**
@@ -33359,7 +33414,7 @@ class LanguagesApi {
33359
33414
  /**
33360
33415
  * Languages service.
33361
33416
  * @module purecloud-platform-client-v2/api/LanguagesApi
33362
- * @version 179.3.0
33417
+ * @version 181.0.0
33363
33418
  */
33364
33419
 
33365
33420
  /**
@@ -33581,7 +33636,7 @@ class LearningApi {
33581
33636
  /**
33582
33637
  * Learning service.
33583
33638
  * @module purecloud-platform-client-v2/api/LearningApi
33584
- * @version 179.3.0
33639
+ * @version 181.0.0
33585
33640
  */
33586
33641
 
33587
33642
  /**
@@ -34400,7 +34455,7 @@ class LicenseApi {
34400
34455
  /**
34401
34456
  * License service.
34402
34457
  * @module purecloud-platform-client-v2/api/LicenseApi
34403
- * @version 179.3.0
34458
+ * @version 181.0.0
34404
34459
  */
34405
34460
 
34406
34461
  /**
@@ -34638,7 +34693,7 @@ class LocationsApi {
34638
34693
  /**
34639
34694
  * Locations service.
34640
34695
  * @module purecloud-platform-client-v2/api/LocationsApi
34641
- * @version 179.3.0
34696
+ * @version 181.0.0
34642
34697
  */
34643
34698
 
34644
34699
  /**
@@ -34874,7 +34929,7 @@ class MessagingApi {
34874
34929
  /**
34875
34930
  * Messaging service.
34876
34931
  * @module purecloud-platform-client-v2/api/MessagingApi
34877
- * @version 179.3.0
34932
+ * @version 181.0.0
34878
34933
  */
34879
34934
 
34880
34935
  /**
@@ -35233,7 +35288,7 @@ class MobileDevicesApi {
35233
35288
  /**
35234
35289
  * MobileDevices service.
35235
35290
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
35236
- * @version 179.3.0
35291
+ * @version 181.0.0
35237
35292
  */
35238
35293
 
35239
35294
  /**
@@ -35384,7 +35439,7 @@ class NotificationsApi {
35384
35439
  /**
35385
35440
  * Notifications service.
35386
35441
  * @module purecloud-platform-client-v2/api/NotificationsApi
35387
- * @version 179.3.0
35442
+ * @version 181.0.0
35388
35443
  */
35389
35444
 
35390
35445
  /**
@@ -35617,7 +35672,7 @@ class OAuthApi {
35617
35672
  /**
35618
35673
  * OAuth service.
35619
35674
  * @module purecloud-platform-client-v2/api/OAuthApi
35620
- * @version 179.3.0
35675
+ * @version 181.0.0
35621
35676
  */
35622
35677
 
35623
35678
  /**
@@ -35983,7 +36038,7 @@ class ObjectsApi {
35983
36038
  /**
35984
36039
  * Objects service.
35985
36040
  * @module purecloud-platform-client-v2/api/ObjectsApi
35986
- * @version 179.3.0
36041
+ * @version 181.0.0
35987
36042
  */
35988
36043
 
35989
36044
  /**
@@ -36250,11 +36305,77 @@ class ObjectsApi {
36250
36305
 
36251
36306
  }
36252
36307
 
36308
+ class OperationalEventsApi {
36309
+ /**
36310
+ * OperationalEvents service.
36311
+ * @module purecloud-platform-client-v2/api/OperationalEventsApi
36312
+ * @version 181.0.0
36313
+ */
36314
+
36315
+ /**
36316
+ * Constructs a new OperationalEventsApi.
36317
+ * @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
36318
+ * @class
36319
+ * @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
36320
+ * default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
36321
+ */
36322
+ constructor(apiClient) {
36323
+ this.apiClient = apiClient || ApiClient.instance;
36324
+ }
36325
+
36326
+
36327
+ /**
36328
+ * Get an operational event definition by its id
36329
+ *
36330
+ * @param {String} eventDefinitionId EventDefinition id
36331
+ */
36332
+ getUsageEventsDefinition(eventDefinitionId) {
36333
+ // verify the required parameter 'eventDefinitionId' is set
36334
+ if (eventDefinitionId === undefined || eventDefinitionId === null) {
36335
+ throw 'Missing the required parameter "eventDefinitionId" when calling getUsageEventsDefinition';
36336
+ }
36337
+
36338
+ return this.apiClient.callApi(
36339
+ '/api/v2/usage/events/definitions/{eventDefinitionId}',
36340
+ 'GET',
36341
+ { 'eventDefinitionId': eventDefinitionId },
36342
+ { },
36343
+ { },
36344
+ { },
36345
+ null,
36346
+ ['PureCloud OAuth'],
36347
+ ['application/json'],
36348
+ ['application/json']
36349
+ );
36350
+ }
36351
+
36352
+ /**
36353
+ * Get all operational event definitions
36354
+ *
36355
+ */
36356
+ getUsageEventsDefinitions() {
36357
+
36358
+ return this.apiClient.callApi(
36359
+ '/api/v2/usage/events/definitions',
36360
+ 'GET',
36361
+ { },
36362
+ { },
36363
+ { },
36364
+ { },
36365
+ null,
36366
+ ['PureCloud OAuth'],
36367
+ ['application/json'],
36368
+ ['application/json']
36369
+ );
36370
+ }
36371
+
36372
+ }
36373
+
36253
36374
  class OrganizationApi {
36254
36375
  /**
36255
36376
  * Organization service.
36256
36377
  * @module purecloud-platform-client-v2/api/OrganizationApi
36257
- * @version 179.3.0
36378
+ * @version 181.0.0
36258
36379
  */
36259
36380
 
36260
36381
  /**
@@ -36709,7 +36830,7 @@ class OrganizationAuthorizationApi {
36709
36830
  /**
36710
36831
  * OrganizationAuthorization service.
36711
36832
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
36712
- * @version 179.3.0
36833
+ * @version 181.0.0
36713
36834
  */
36714
36835
 
36715
36836
  /**
@@ -38056,7 +38177,7 @@ class OutboundApi {
38056
38177
  /**
38057
38178
  * Outbound service.
38058
38179
  * @module purecloud-platform-client-v2/api/OutboundApi
38059
- * @version 179.3.0
38180
+ * @version 181.0.0
38060
38181
  */
38061
38182
 
38062
38183
  /**
@@ -41678,7 +41799,7 @@ class PresenceApi {
41678
41799
  /**
41679
41800
  * Presence service.
41680
41801
  * @module purecloud-platform-client-v2/api/PresenceApi
41681
- * @version 179.3.0
41802
+ * @version 181.0.0
41682
41803
  */
41683
41804
 
41684
41805
  /**
@@ -41773,9 +41894,13 @@ class PresenceApi {
41773
41894
  * Get a Presence Definition
41774
41895
  *
41775
41896
  * @param {String} definitionId Presence Definition ID
41897
+ * @param {Object} opts Optional parameters
41898
+ * @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
41776
41899
  * getPresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
41777
41900
  */
41778
- getPresenceDefinition0(definitionId) {
41901
+ getPresenceDefinition0(definitionId, opts) {
41902
+ opts = opts || {};
41903
+
41779
41904
  // verify the required parameter 'definitionId' is set
41780
41905
  if (definitionId === undefined || definitionId === null) {
41781
41906
  throw 'Missing the required parameter "definitionId" when calling getPresenceDefinition0';
@@ -41785,7 +41910,7 @@ class PresenceApi {
41785
41910
  '/api/v2/presence/definitions/{definitionId}',
41786
41911
  'GET',
41787
41912
  { 'definitionId': definitionId },
41788
- { },
41913
+ { 'localeCode': opts['localeCode'] },
41789
41914
  { },
41790
41915
  { },
41791
41916
  null,
@@ -41801,6 +41926,7 @@ class PresenceApi {
41801
41926
  * @param {Object} opts Optional parameters
41802
41927
  * @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
41803
41928
  * @param {Array.<String>} opts.divisionId One or more division IDs. If nothing is provided, the definitions associated withthe list of divisions that the user has access to will be returned.
41929
+ * @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
41804
41930
  * getPresenceDefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
41805
41931
  */
41806
41932
  getPresenceDefinitions0(opts) {
@@ -41811,7 +41937,7 @@ class PresenceApi {
41811
41937
  '/api/v2/presence/definitions',
41812
41938
  'GET',
41813
41939
  { },
41814
- { 'deactivated': opts['deactivated'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
41940
+ { 'deactivated': opts['deactivated'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'localeCode': opts['localeCode'] },
41815
41941
  { },
41816
41942
  { },
41817
41943
  null,
@@ -42417,7 +42543,7 @@ class ProcessAutomationApi {
42417
42543
  /**
42418
42544
  * ProcessAutomation service.
42419
42545
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
42420
- * @version 179.3.0
42546
+ * @version 181.0.0
42421
42547
  */
42422
42548
 
42423
42549
  /**
@@ -42656,7 +42782,7 @@ class QualityApi {
42656
42782
  /**
42657
42783
  * Quality service.
42658
42784
  * @module purecloud-platform-client-v2/api/QualityApi
42659
- * @version 179.3.0
42785
+ * @version 181.0.0
42660
42786
  */
42661
42787
 
42662
42788
  /**
@@ -43365,7 +43491,7 @@ class QualityApi {
43365
43491
 
43366
43492
  /**
43367
43493
  * Get the list of evaluation forms
43368
- *
43494
+ * By default, "published" field is always returned as false for all evaluation forms. If you set "expand=publishHistory", then you will be able to get published versions for each corresponding evaluation form. In addition, "questionGroups", the detailed information about evaluation form, is not returned by default. We will enhance this field in the future release.
43369
43495
  * @param {Object} opts Optional parameters
43370
43496
  * @param {Number} opts.pageSize The total page size requested (default to 25)
43371
43497
  * @param {Number} opts.pageNumber The page number requested (default to 1)
@@ -44410,7 +44536,7 @@ class RecordingApi {
44410
44536
  /**
44411
44537
  * Recording service.
44412
44538
  * @module purecloud-platform-client-v2/api/RecordingApi
44413
- * @version 179.3.0
44539
+ * @version 181.0.0
44414
44540
  */
44415
44541
 
44416
44542
  /**
@@ -46047,7 +46173,7 @@ class ResponseManagementApi {
46047
46173
  /**
46048
46174
  * ResponseManagement service.
46049
46175
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
46050
- * @version 179.3.0
46176
+ * @version 181.0.0
46051
46177
  */
46052
46178
 
46053
46179
  /**
@@ -46532,7 +46658,7 @@ class RoutingApi {
46532
46658
  /**
46533
46659
  * Routing service.
46534
46660
  * @module purecloud-platform-client-v2/api/RoutingApi
46535
- * @version 179.3.0
46661
+ * @version 181.0.0
46536
46662
  */
46537
46663
 
46538
46664
  /**
@@ -50240,7 +50366,7 @@ class SCIMApi {
50240
50366
  /**
50241
50367
  * SCIM service.
50242
50368
  * @module purecloud-platform-client-v2/api/SCIMApi
50243
- * @version 179.3.0
50369
+ * @version 181.0.0
50244
50370
  */
50245
50371
 
50246
50372
  /**
@@ -51117,7 +51243,7 @@ class ScriptsApi {
51117
51243
  /**
51118
51244
  * Scripts service.
51119
51245
  * @module purecloud-platform-client-v2/api/ScriptsApi
51120
- * @version 179.3.0
51246
+ * @version 181.0.0
51121
51247
  */
51122
51248
 
51123
51249
  /**
@@ -51561,7 +51687,7 @@ class SearchApi {
51561
51687
  /**
51562
51688
  * Search service.
51563
51689
  * @module purecloud-platform-client-v2/api/SearchApi
51564
- * @version 179.3.0
51690
+ * @version 181.0.0
51565
51691
  */
51566
51692
 
51567
51693
  /**
@@ -52250,7 +52376,7 @@ class SettingsApi {
52250
52376
  /**
52251
52377
  * Settings service.
52252
52378
  * @module purecloud-platform-client-v2/api/SettingsApi
52253
- * @version 179.3.0
52379
+ * @version 181.0.0
52254
52380
  */
52255
52381
 
52256
52382
  /**
@@ -52315,7 +52441,7 @@ class SpeechTextAnalyticsApi {
52315
52441
  /**
52316
52442
  * SpeechTextAnalytics service.
52317
52443
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
52318
- * @version 179.3.0
52444
+ * @version 181.0.0
52319
52445
  */
52320
52446
 
52321
52447
  /**
@@ -53428,7 +53554,7 @@ class StationsApi {
53428
53554
  /**
53429
53555
  * Stations service.
53430
53556
  * @module purecloud-platform-client-v2/api/StationsApi
53431
- * @version 179.3.0
53557
+ * @version 181.0.0
53432
53558
  */
53433
53559
 
53434
53560
  /**
@@ -53530,7 +53656,7 @@ class SuggestApi {
53530
53656
  /**
53531
53657
  * Suggest service.
53532
53658
  * @module purecloud-platform-client-v2/api/SuggestApi
53533
- * @version 179.3.0
53659
+ * @version 181.0.0
53534
53660
  */
53535
53661
 
53536
53662
  /**
@@ -53669,7 +53795,7 @@ class TaskManagementApi {
53669
53795
  /**
53670
53796
  * TaskManagement service.
53671
53797
  * @module purecloud-platform-client-v2/api/TaskManagementApi
53672
- * @version 179.3.0
53798
+ * @version 181.0.0
53673
53799
  */
53674
53800
 
53675
53801
  /**
@@ -54950,7 +55076,7 @@ class TeamsApi {
54950
55076
  /**
54951
55077
  * Teams service.
54952
55078
  * @module purecloud-platform-client-v2/api/TeamsApi
54953
- * @version 179.3.0
55079
+ * @version 181.0.0
54954
55080
  */
54955
55081
 
54956
55082
  /**
@@ -55252,7 +55378,7 @@ class TelephonyApi {
55252
55378
  /**
55253
55379
  * Telephony service.
55254
55380
  * @module purecloud-platform-client-v2/api/TelephonyApi
55255
- * @version 179.3.0
55381
+ * @version 181.0.0
55256
55382
  */
55257
55383
 
55258
55384
  /**
@@ -55287,6 +55413,62 @@ class TelephonyApi {
55287
55413
  );
55288
55414
  }
55289
55415
 
55416
+ /**
55417
+ * Get a SIP message.
55418
+ * Get the raw form of the SIP message
55419
+ * @param {String} conversationId Conversation id
55420
+ * getTelephonySipmessagesConversation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
55421
+ */
55422
+ getTelephonySipmessagesConversation(conversationId) {
55423
+ // verify the required parameter 'conversationId' is set
55424
+ if (conversationId === undefined || conversationId === null) {
55425
+ throw 'Missing the required parameter "conversationId" when calling getTelephonySipmessagesConversation';
55426
+ }
55427
+
55428
+ return this.apiClient.callApi(
55429
+ '/api/v2/telephony/sipmessages/conversations/{conversationId}',
55430
+ 'GET',
55431
+ { 'conversationId': conversationId },
55432
+ { },
55433
+ { },
55434
+ { },
55435
+ null,
55436
+ ['PureCloud OAuth'],
55437
+ ['application/json'],
55438
+ ['application/json']
55439
+ );
55440
+ }
55441
+
55442
+ /**
55443
+ * Get SIP headers.
55444
+ * Get parsed SIP headers. Returns specific headers if key query parameters are added.
55445
+ * @param {String} conversationId Conversation id
55446
+ * @param {Object} opts Optional parameters
55447
+ * @param {Array.<String>} opts.keys comma-separated list of header identifiers to query. e.g. ruri,to,from
55448
+ * getTelephonySipmessagesConversationHeaders is a preview method and is subject to both breaking and non-breaking changes at any time without notice
55449
+ */
55450
+ getTelephonySipmessagesConversationHeaders(conversationId, opts) {
55451
+ opts = opts || {};
55452
+
55453
+ // verify the required parameter 'conversationId' is set
55454
+ if (conversationId === undefined || conversationId === null) {
55455
+ throw 'Missing the required parameter "conversationId" when calling getTelephonySipmessagesConversationHeaders';
55456
+ }
55457
+
55458
+ return this.apiClient.callApi(
55459
+ '/api/v2/telephony/sipmessages/conversations/{conversationId}/headers',
55460
+ 'GET',
55461
+ { 'conversationId': conversationId },
55462
+ { 'keys': this.apiClient.buildCollectionParam(opts['keys'], 'multi') },
55463
+ { },
55464
+ { },
55465
+ null,
55466
+ ['PureCloud OAuth'],
55467
+ ['application/json'],
55468
+ ['application/json']
55469
+ );
55470
+ }
55471
+
55290
55472
  /**
55291
55473
  * Fetch SIP metadata
55292
55474
  * Fetch SIP metadata that matches a given parameter. If exactMatch is passed as a parameter only sip records that have exactly that value will be returned. For example, some records contain conversationId but not all relevant records for that call may contain the conversationId so only a partial view of the call will be reflected
@@ -55380,7 +55562,7 @@ class TelephonyProvidersEdgeApi {
55380
55562
  /**
55381
55563
  * TelephonyProvidersEdge service.
55382
55564
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
55383
- * @version 179.3.0
55565
+ * @version 181.0.0
55384
55566
  */
55385
55567
 
55386
55568
  /**
@@ -57304,6 +57486,31 @@ class TelephonyProvidersEdgeApi {
57304
57486
  );
57305
57487
  }
57306
57488
 
57489
+ /**
57490
+ * Get site connections for a site.
57491
+ *
57492
+ * @param {String} siteId Site ID
57493
+ */
57494
+ getTelephonyProvidersEdgesSiteSiteconnections(siteId) {
57495
+ // verify the required parameter 'siteId' is set
57496
+ if (siteId === undefined || siteId === null) {
57497
+ throw 'Missing the required parameter "siteId" when calling getTelephonyProvidersEdgesSiteSiteconnections';
57498
+ }
57499
+
57500
+ return this.apiClient.callApi(
57501
+ '/api/v2/telephony/providers/edges/sites/{siteId}/siteconnections',
57502
+ 'GET',
57503
+ { 'siteId': siteId },
57504
+ { },
57505
+ { },
57506
+ { },
57507
+ null,
57508
+ ['PureCloud OAuth'],
57509
+ ['application/json'],
57510
+ ['application/json']
57511
+ );
57512
+ }
57513
+
57307
57514
  /**
57308
57515
  * Get the list of Sites.
57309
57516
  *
@@ -57600,6 +57807,36 @@ class TelephonyProvidersEdgeApi {
57600
57807
  );
57601
57808
  }
57602
57809
 
57810
+ /**
57811
+ * Disable site connections for a site.
57812
+ *
57813
+ * @param {String} siteId Site ID
57814
+ * @param {Object} body Site
57815
+ */
57816
+ patchTelephonyProvidersEdgesSiteSiteconnections(siteId, body) {
57817
+ // verify the required parameter 'siteId' is set
57818
+ if (siteId === undefined || siteId === null) {
57819
+ throw 'Missing the required parameter "siteId" when calling patchTelephonyProvidersEdgesSiteSiteconnections';
57820
+ }
57821
+ // verify the required parameter 'body' is set
57822
+ if (body === undefined || body === null) {
57823
+ throw 'Missing the required parameter "body" when calling patchTelephonyProvidersEdgesSiteSiteconnections';
57824
+ }
57825
+
57826
+ return this.apiClient.callApi(
57827
+ '/api/v2/telephony/providers/edges/sites/{siteId}/siteconnections',
57828
+ 'PATCH',
57829
+ { 'siteId': siteId },
57830
+ { },
57831
+ { },
57832
+ { },
57833
+ body,
57834
+ ['PureCloud OAuth'],
57835
+ ['application/json'],
57836
+ ['application/json']
57837
+ );
57838
+ }
57839
+
57603
57840
  /**
57604
57841
  * Nslookup request command to collect networking-related information from an Edge for a target IP or host.
57605
57842
  *
@@ -58633,6 +58870,36 @@ class TelephonyProvidersEdgeApi {
58633
58870
  );
58634
58871
  }
58635
58872
 
58873
+ /**
58874
+ * Update site connections for a site.
58875
+ *
58876
+ * @param {String} siteId Site ID
58877
+ * @param {Object} body Site
58878
+ */
58879
+ putTelephonyProvidersEdgesSiteSiteconnections(siteId, body) {
58880
+ // verify the required parameter 'siteId' is set
58881
+ if (siteId === undefined || siteId === null) {
58882
+ throw 'Missing the required parameter "siteId" when calling putTelephonyProvidersEdgesSiteSiteconnections';
58883
+ }
58884
+ // verify the required parameter 'body' is set
58885
+ if (body === undefined || body === null) {
58886
+ throw 'Missing the required parameter "body" when calling putTelephonyProvidersEdgesSiteSiteconnections';
58887
+ }
58888
+
58889
+ return this.apiClient.callApi(
58890
+ '/api/v2/telephony/providers/edges/sites/{siteId}/siteconnections',
58891
+ 'PUT',
58892
+ { 'siteId': siteId },
58893
+ { },
58894
+ { },
58895
+ { },
58896
+ body,
58897
+ ['PureCloud OAuth'],
58898
+ ['application/json'],
58899
+ ['application/json']
58900
+ );
58901
+ }
58902
+
58636
58903
  /**
58637
58904
  * Update a Trunk Base Settings object by ID
58638
58905
  *
@@ -58669,7 +58936,7 @@ class TextbotsApi {
58669
58936
  /**
58670
58937
  * Textbots service.
58671
58938
  * @module purecloud-platform-client-v2/api/TextbotsApi
58672
- * @version 179.3.0
58939
+ * @version 181.0.0
58673
58940
  */
58674
58941
 
58675
58942
  /**
@@ -58797,7 +59064,7 @@ class TokensApi {
58797
59064
  /**
58798
59065
  * Tokens service.
58799
59066
  * @module purecloud-platform-client-v2/api/TokensApi
58800
- * @version 179.3.0
59067
+ * @version 181.0.0
58801
59068
  */
58802
59069
 
58803
59070
  /**
@@ -58953,7 +59220,7 @@ class UploadsApi {
58953
59220
  /**
58954
59221
  * Uploads service.
58955
59222
  * @module purecloud-platform-client-v2/api/UploadsApi
58956
- * @version 179.3.0
59223
+ * @version 181.0.0
58957
59224
  */
58958
59225
 
58959
59226
  /**
@@ -59129,7 +59396,7 @@ class UsageApi {
59129
59396
  /**
59130
59397
  * Usage service.
59131
59398
  * @module purecloud-platform-client-v2/api/UsageApi
59132
- * @version 179.3.0
59399
+ * @version 181.0.0
59133
59400
  */
59134
59401
 
59135
59402
  /**
@@ -59339,7 +59606,7 @@ class UserRecordingsApi {
59339
59606
  /**
59340
59607
  * UserRecordings service.
59341
59608
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
59342
- * @version 179.3.0
59609
+ * @version 181.0.0
59343
59610
  */
59344
59611
 
59345
59612
  /**
@@ -59524,7 +59791,7 @@ class UsersApi {
59524
59791
  /**
59525
59792
  * Users service.
59526
59793
  * @module purecloud-platform-client-v2/api/UsersApi
59527
- * @version 179.3.0
59794
+ * @version 181.0.0
59528
59795
  */
59529
59796
 
59530
59797
  /**
@@ -59759,6 +60026,36 @@ class UsersApi {
59759
60026
  );
59760
60027
  }
59761
60028
 
60029
+ /**
60030
+ * Delete a verifier
60031
+ *
60032
+ * @param {String} userId User ID
60033
+ * @param {String} verifierId Verifier ID
60034
+ */
60035
+ deleteUserVerifier(userId, verifierId) {
60036
+ // verify the required parameter 'userId' is set
60037
+ if (userId === undefined || userId === null) {
60038
+ throw 'Missing the required parameter "userId" when calling deleteUserVerifier';
60039
+ }
60040
+ // verify the required parameter 'verifierId' is set
60041
+ if (verifierId === undefined || verifierId === null) {
60042
+ throw 'Missing the required parameter "verifierId" when calling deleteUserVerifier';
60043
+ }
60044
+
60045
+ return this.apiClient.callApi(
60046
+ '/api/v2/users/{userId}/verifiers/{verifierId}',
60047
+ 'DELETE',
60048
+ { 'userId': userId,'verifierId': verifierId },
60049
+ { },
60050
+ { },
60051
+ { },
60052
+ null,
60053
+ ['PureCloud OAuth'],
60054
+ ['application/json'],
60055
+ ['application/json']
60056
+ );
60057
+ }
60058
+
59762
60059
  /**
59763
60060
  * Get status for async query for user aggregates
59764
60061
  *
@@ -60655,6 +60952,31 @@ class UsersApi {
60655
60952
  );
60656
60953
  }
60657
60954
 
60955
+ /**
60956
+ * Get a list of verifiers
60957
+ *
60958
+ * @param {String} userId User ID
60959
+ */
60960
+ getUserVerifiers(userId) {
60961
+ // verify the required parameter 'userId' is set
60962
+ if (userId === undefined || userId === null) {
60963
+ throw 'Missing the required parameter "userId" when calling getUserVerifiers';
60964
+ }
60965
+
60966
+ return this.apiClient.callApi(
60967
+ '/api/v2/users/{userId}/verifiers',
60968
+ 'GET',
60969
+ { 'userId': userId },
60970
+ { },
60971
+ { },
60972
+ { },
60973
+ null,
60974
+ ['PureCloud OAuth'],
60975
+ ['application/json'],
60976
+ ['application/json']
60977
+ );
60978
+ }
60979
+
60658
60980
  /**
60659
60981
  * Get the list of available users.
60660
60982
  *
@@ -61100,7 +61422,7 @@ class UsersApi {
61100
61422
  }
61101
61423
 
61102
61424
  /**
61103
- * Update bulk acd autoanswer on users
61425
+ * Update bulk acd autoanswer on users. Max 50 users can be updated at a time.
61104
61426
  *
61105
61427
  * @param {Array.<Object>} body Users
61106
61428
  */
@@ -62079,13 +62401,48 @@ class UsersApi {
62079
62401
  );
62080
62402
  }
62081
62403
 
62404
+ /**
62405
+ * Update a verifier
62406
+ *
62407
+ * @param {String} userId User ID
62408
+ * @param {String} verifierId Verifier ID
62409
+ * @param {Object} body Verifier Update
62410
+ */
62411
+ putUserVerifier(userId, verifierId, body) {
62412
+ // verify the required parameter 'userId' is set
62413
+ if (userId === undefined || userId === null) {
62414
+ throw 'Missing the required parameter "userId" when calling putUserVerifier';
62415
+ }
62416
+ // verify the required parameter 'verifierId' is set
62417
+ if (verifierId === undefined || verifierId === null) {
62418
+ throw 'Missing the required parameter "verifierId" when calling putUserVerifier';
62419
+ }
62420
+ // verify the required parameter 'body' is set
62421
+ if (body === undefined || body === null) {
62422
+ throw 'Missing the required parameter "body" when calling putUserVerifier';
62423
+ }
62424
+
62425
+ return this.apiClient.callApi(
62426
+ '/api/v2/users/{userId}/verifiers/{verifierId}',
62427
+ 'PUT',
62428
+ { 'userId': userId,'verifierId': verifierId },
62429
+ { },
62430
+ { },
62431
+ { },
62432
+ body,
62433
+ ['PureCloud OAuth'],
62434
+ ['application/json'],
62435
+ ['application/json']
62436
+ );
62437
+ }
62438
+
62082
62439
  }
62083
62440
 
62084
62441
  class UtilitiesApi {
62085
62442
  /**
62086
62443
  * Utilities service.
62087
62444
  * @module purecloud-platform-client-v2/api/UtilitiesApi
62088
- * @version 179.3.0
62445
+ * @version 181.0.0
62089
62446
  */
62090
62447
 
62091
62448
  /**
@@ -62196,7 +62553,7 @@ class VoicemailApi {
62196
62553
  /**
62197
62554
  * Voicemail service.
62198
62555
  * @module purecloud-platform-client-v2/api/VoicemailApi
62199
- * @version 179.3.0
62556
+ * @version 181.0.0
62200
62557
  */
62201
62558
 
62202
62559
  /**
@@ -62863,7 +63220,7 @@ class WebChatApi {
62863
63220
  /**
62864
63221
  * WebChat service.
62865
63222
  * @module purecloud-platform-client-v2/api/WebChatApi
62866
- * @version 179.3.0
63223
+ * @version 181.0.0
62867
63224
  */
62868
63225
 
62869
63226
  /**
@@ -63412,7 +63769,7 @@ class WebDeploymentsApi {
63412
63769
  /**
63413
63770
  * WebDeployments service.
63414
63771
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
63415
- * @version 179.3.0
63772
+ * @version 181.0.0
63416
63773
  */
63417
63774
 
63418
63775
  /**
@@ -63939,7 +64296,7 @@ class WebMessagingApi {
63939
64296
  /**
63940
64297
  * WebMessaging service.
63941
64298
  * @module purecloud-platform-client-v2/api/WebMessagingApi
63942
- * @version 179.3.0
64299
+ * @version 181.0.0
63943
64300
  */
63944
64301
 
63945
64302
  /**
@@ -63985,7 +64342,7 @@ class WidgetsApi {
63985
64342
  /**
63986
64343
  * Widgets service.
63987
64344
  * @module purecloud-platform-client-v2/api/WidgetsApi
63988
- * @version 179.3.0
64345
+ * @version 181.0.0
63989
64346
  */
63990
64347
 
63991
64348
  /**
@@ -64131,7 +64488,7 @@ class WorkforceManagementApi {
64131
64488
  /**
64132
64489
  * WorkforceManagement service.
64133
64490
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
64134
- * @version 179.3.0
64491
+ * @version 181.0.0
64135
64492
  */
64136
64493
 
64137
64494
  /**
@@ -64814,8 +65171,12 @@ class WorkforceManagementApi {
64814
65171
  * Get activity codes
64815
65172
  *
64816
65173
  * @param {String} businessUnitId The ID of the business unit, or 'mine' for the business unit of the logged-in user.
65174
+ * @param {Object} opts Optional parameters
65175
+ * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
64817
65176
  */
64818
- getWorkforcemanagementBusinessunitActivitycodes(businessUnitId) {
65177
+ getWorkforcemanagementBusinessunitActivitycodes(businessUnitId, opts) {
65178
+ opts = opts || {};
65179
+
64819
65180
  // verify the required parameter 'businessUnitId' is set
64820
65181
  if (businessUnitId === undefined || businessUnitId === null) {
64821
65182
  throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivitycodes';
@@ -64825,7 +65186,7 @@ class WorkforceManagementApi {
64825
65186
  '/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes',
64826
65187
  'GET',
64827
65188
  { 'businessUnitId': businessUnitId },
64828
- { },
65189
+ { 'forceDownloadService': opts['forceDownloadService'] },
64829
65190
  { },
64830
65191
  { },
64831
65192
  null,
@@ -66215,6 +66576,7 @@ class WorkforceManagementApi {
66215
66576
  * @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
66216
66577
  * @param {Object} opts Optional parameters
66217
66578
  * @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
66579
+ * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
66218
66580
  */
66219
66581
  getWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, opts) {
66220
66582
  opts = opts || {};
@@ -66232,7 +66594,7 @@ class WorkforceManagementApi {
66232
66594
  '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades',
66233
66595
  'GET',
66234
66596
  { 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
66235
- { 'evaluateMatches': opts['evaluateMatches'] },
66597
+ { 'evaluateMatches': opts['evaluateMatches'],'forceDownloadService': opts['forceDownloadService'] },
66236
66598
  { },
66237
66599
  { },
66238
66600
  null,
@@ -68480,6 +68842,7 @@ class WorkforceManagementApi {
68480
68842
  * Request body requires one of the following: User ID is specified, statuses == [Pending] or date range to be specified and less than or equal to 33 days. All other fields are filters
68481
68843
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
68482
68844
  * @param {Object} opts Optional parameters
68845
+ * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
68483
68846
  * @param {Object} opts.body body
68484
68847
  */
68485
68848
  postWorkforcemanagementManagementunitTimeoffrequestsQuery(managementUnitId, opts) {
@@ -68494,7 +68857,7 @@ class WorkforceManagementApi {
68494
68857
  '/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/query',
68495
68858
  'POST',
68496
68859
  { 'managementUnitId': managementUnitId },
68497
- { },
68860
+ { 'forceDownloadService': opts['forceDownloadService'] },
68498
68861
  { },
68499
68862
  { },
68500
68863
  opts['body'],
@@ -68718,8 +69081,12 @@ class WorkforceManagementApi {
68718
69081
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
68719
69082
  * @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
68720
69083
  * @param {Object} body body
69084
+ * @param {Object} opts Optional parameters
69085
+ * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
68721
69086
  */
68722
- postWorkforcemanagementManagementunitWeekShifttradesSearch(managementUnitId, weekDateId, body) {
69087
+ postWorkforcemanagementManagementunitWeekShifttradesSearch(managementUnitId, weekDateId, body, opts) {
69088
+ opts = opts || {};
69089
+
68723
69090
  // verify the required parameter 'managementUnitId' is set
68724
69091
  if (managementUnitId === undefined || managementUnitId === null) {
68725
69092
  throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttradesSearch';
@@ -68737,7 +69104,7 @@ class WorkforceManagementApi {
68737
69104
  '/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/search',
68738
69105
  'POST',
68739
69106
  { 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
68740
- { },
69107
+ { 'forceDownloadService': opts['forceDownloadService'] },
68741
69108
  { },
68742
69109
  { },
68743
69110
  body,
@@ -69295,7 +69662,7 @@ class WorkforceManagementApi {
69295
69662
  * </pre>
69296
69663
  * </p>
69297
69664
  * @module purecloud-platform-client-v2/index
69298
- * @version 179.3.0
69665
+ * @version 181.0.0
69299
69666
  */
69300
69667
  class platformClient {
69301
69668
  constructor() {
@@ -69499,6 +69866,11 @@ class platformClient {
69499
69866
  * @property {module:purecloud-platform-client-v2/api/ObjectsApi}
69500
69867
  */
69501
69868
  this.ObjectsApi = ObjectsApi;
69869
+ /**
69870
+ * The OperationalEventsApi service constructor.
69871
+ * @property {module:purecloud-platform-client-v2/api/OperationalEventsApi}
69872
+ */
69873
+ this.OperationalEventsApi = OperationalEventsApi;
69502
69874
  /**
69503
69875
  * The OrganizationApi service constructor.
69504
69876
  * @property {module:purecloud-platform-client-v2/api/OrganizationApi}