purecloud-platform-client-v2 127.0.0 → 131.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 (73) hide show
  1. package/README.md +2 -8
  2. package/dist/node/purecloud-platform-client-v2.js +610 -97
  3. package/dist/web-amd/purecloud-platform-client-v2.js +610 -97
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +610 -97
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +610 -97
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +475 -219
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
  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/ChatApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/CoachingApi.js +5 -3
  19. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +176 -1
  21. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/GamificationApi.js +121 -1
  26. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +30 -1
  32. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/MessagingApi.js +156 -0
  40. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/RecordingApi.js +8 -8
  50. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/RoutingApi.js +8 -4
  52. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -21
  56. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +21 -1
  60. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +28 -1
  61. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +2 -2
  67. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/index.js +7 -1
@@ -6873,7 +6873,7 @@ class Configuration {
6873
6873
 
6874
6874
  /**
6875
6875
  * @module purecloud-platform-client-v2/ApiClient
6876
- * @version 127.0.0
6876
+ * @version 131.0.0
6877
6877
  */
6878
6878
  class ApiClient {
6879
6879
  /**
@@ -7813,7 +7813,7 @@ class ApiClient {
7813
7813
 
7814
7814
  // set header parameters
7815
7815
  request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
7816
- //request.set({ 'purecloud-sdk': '127.0.0' });
7816
+ //request.set({ 'purecloud-sdk': '131.0.0' });
7817
7817
 
7818
7818
  // set request timeout
7819
7819
  request.timeout(that.timeout);
@@ -7913,7 +7913,7 @@ class AlertingApi {
7913
7913
  /**
7914
7914
  * Alerting service.
7915
7915
  * @module purecloud-platform-client-v2/api/AlertingApi
7916
- * @version 127.0.0
7916
+ * @version 131.0.0
7917
7917
  */
7918
7918
 
7919
7919
  /**
@@ -8227,7 +8227,7 @@ class AnalyticsApi {
8227
8227
  /**
8228
8228
  * Analytics service.
8229
8229
  * @module purecloud-platform-client-v2/api/AnalyticsApi
8230
- * @version 127.0.0
8230
+ * @version 131.0.0
8231
8231
  */
8232
8232
 
8233
8233
  /**
@@ -9364,7 +9364,7 @@ class ArchitectApi {
9364
9364
  /**
9365
9365
  * Architect service.
9366
9366
  * @module purecloud-platform-client-v2/api/ArchitectApi
9367
- * @version 127.0.0
9367
+ * @version 131.0.0
9368
9368
  */
9369
9369
 
9370
9370
  /**
@@ -12360,7 +12360,7 @@ class AuditApi {
12360
12360
  /**
12361
12361
  * Audit service.
12362
12362
  * @module purecloud-platform-client-v2/api/AuditApi
12363
- * @version 127.0.0
12363
+ * @version 131.0.0
12364
12364
  */
12365
12365
 
12366
12366
  /**
@@ -12531,7 +12531,7 @@ class AuthorizationApi {
12531
12531
  /**
12532
12532
  * Authorization service.
12533
12533
  * @module purecloud-platform-client-v2/api/AuthorizationApi
12534
- * @version 127.0.0
12534
+ * @version 131.0.0
12535
12535
  */
12536
12536
 
12537
12537
  /**
@@ -13714,7 +13714,7 @@ class BillingApi {
13714
13714
  /**
13715
13715
  * Billing service.
13716
13716
  * @module purecloud-platform-client-v2/api/BillingApi
13717
- * @version 127.0.0
13717
+ * @version 131.0.0
13718
13718
  */
13719
13719
 
13720
13720
  /**
@@ -13794,7 +13794,7 @@ class ChatApi {
13794
13794
  /**
13795
13795
  * Chat service.
13796
13796
  * @module purecloud-platform-client-v2/api/ChatApi
13797
- * @version 127.0.0
13797
+ * @version 131.0.0
13798
13798
  */
13799
13799
 
13800
13800
  /**
@@ -13885,7 +13885,7 @@ class CoachingApi {
13885
13885
  /**
13886
13886
  * Coaching service.
13887
13887
  * @module purecloud-platform-client-v2/api/CoachingApi
13888
- * @version 127.0.0
13888
+ * @version 131.0.0
13889
13889
  */
13890
13890
 
13891
13891
  /**
@@ -14084,6 +14084,7 @@ class CoachingApi {
14084
14084
  * @param {Array.<String>} opts.relationships Relationships to filter by
14085
14085
  * @param {String} opts.completionInterval Appointment completion start and end to filter by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
14086
14086
  * @param {Object} opts.overdue Overdue status to filter by
14087
+ * @param {Object} opts.intervalCondition Filter condition for interval
14087
14088
  */
14088
14089
  getCoachingAppointments(userIds, opts) {
14089
14090
  opts = opts || {};
@@ -14097,7 +14098,7 @@ class CoachingApi {
14097
14098
  '/api/v2/coaching/appointments',
14098
14099
  'GET',
14099
14100
  { },
14100
- { 'userIds': this.apiClient.buildCollectionParam(userIds, 'multi'),'interval': opts['interval'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'facilitatorIds': this.apiClient.buildCollectionParam(opts['facilitatorIds'], 'multi'),'sortOrder': opts['sortOrder'],'relationships': this.apiClient.buildCollectionParam(opts['relationships'], 'multi'),'completionInterval': opts['completionInterval'],'overdue': opts['overdue'] },
14101
+ { 'userIds': this.apiClient.buildCollectionParam(userIds, 'multi'),'interval': opts['interval'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'facilitatorIds': this.apiClient.buildCollectionParam(opts['facilitatorIds'], 'multi'),'sortOrder': opts['sortOrder'],'relationships': this.apiClient.buildCollectionParam(opts['relationships'], 'multi'),'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'intervalCondition': opts['intervalCondition'] },
14101
14102
  { },
14102
14103
  { },
14103
14104
  null,
@@ -14120,6 +14121,7 @@ class CoachingApi {
14120
14121
  * @param {Array.<String>} opts.relationships Relationships to filter by
14121
14122
  * @param {String} opts.completionInterval Appointment completion start and end to filter by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
14122
14123
  * @param {Object} opts.overdue Overdue status to filter by
14124
+ * @param {Object} opts.intervalCondition Filter condition for interval
14123
14125
  */
14124
14126
  getCoachingAppointmentsMe(opts) {
14125
14127
  opts = opts || {};
@@ -14129,7 +14131,7 @@ class CoachingApi {
14129
14131
  '/api/v2/coaching/appointments/me',
14130
14132
  'GET',
14131
14133
  { },
14132
- { 'interval': opts['interval'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'facilitatorIds': this.apiClient.buildCollectionParam(opts['facilitatorIds'], 'multi'),'sortOrder': opts['sortOrder'],'relationships': this.apiClient.buildCollectionParam(opts['relationships'], 'multi'),'completionInterval': opts['completionInterval'],'overdue': opts['overdue'] },
14134
+ { 'interval': opts['interval'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'facilitatorIds': this.apiClient.buildCollectionParam(opts['facilitatorIds'], 'multi'),'sortOrder': opts['sortOrder'],'relationships': this.apiClient.buildCollectionParam(opts['relationships'], 'multi'),'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'intervalCondition': opts['intervalCondition'] },
14133
14135
  { },
14134
14136
  { },
14135
14137
  null,
@@ -14460,7 +14462,7 @@ class ContentManagementApi {
14460
14462
  /**
14461
14463
  * ContentManagement service.
14462
14464
  * @module purecloud-platform-client-v2/api/ContentManagementApi
14463
- * @version 127.0.0
14465
+ * @version 131.0.0
14464
14466
  */
14465
14467
 
14466
14468
  /**
@@ -15600,7 +15602,7 @@ class ConversationsApi {
15600
15602
  /**
15601
15603
  * Conversations service.
15602
15604
  * @module purecloud-platform-client-v2/api/ConversationsApi
15603
- * @version 127.0.0
15605
+ * @version 131.0.0
15604
15606
  */
15605
15607
 
15606
15608
  /**
@@ -15890,6 +15892,31 @@ class ConversationsApi {
15890
15892
  );
15891
15893
  }
15892
15894
 
15895
+ /**
15896
+ * Delete a supported content profile
15897
+ *
15898
+ * @param {String} supportedContentId Supported Content ID
15899
+ */
15900
+ deleteConversationsMessagingSupportedcontentSupportedContentId(supportedContentId) {
15901
+ // verify the required parameter 'supportedContentId' is set
15902
+ if (supportedContentId === undefined || supportedContentId === null) {
15903
+ throw 'Missing the required parameter "supportedContentId" when calling deleteConversationsMessagingSupportedcontentSupportedContentId';
15904
+ }
15905
+
15906
+ return this.apiClient.callApi(
15907
+ '/api/v2/conversations/messaging/supportedcontent/{supportedContentId}',
15908
+ 'DELETE',
15909
+ { 'supportedContentId': supportedContentId },
15910
+ { },
15911
+ { },
15912
+ { },
15913
+ null,
15914
+ ['PureCloud OAuth'],
15915
+ ['application/json'],
15916
+ ['application/json']
15917
+ );
15918
+ }
15919
+
15893
15920
  /**
15894
15921
  * Get a conversation by id
15895
15922
  *
@@ -17482,6 +17509,76 @@ class ConversationsApi {
17482
17509
  );
17483
17510
  }
17484
17511
 
17512
+ /**
17513
+ * Get a list of Supported Content profiles
17514
+ *
17515
+ * @param {Object} opts Optional parameters
17516
+ * @param {Number} opts.pageSize Page size (default to 25)
17517
+ * @param {Number} opts.pageNumber Page number (default to 1)
17518
+ */
17519
+ getConversationsMessagingSupportedcontent(opts) {
17520
+ opts = opts || {};
17521
+
17522
+
17523
+ return this.apiClient.callApi(
17524
+ '/api/v2/conversations/messaging/supportedcontent',
17525
+ 'GET',
17526
+ { },
17527
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
17528
+ { },
17529
+ { },
17530
+ null,
17531
+ ['PureCloud OAuth'],
17532
+ ['application/json'],
17533
+ ['application/json']
17534
+ );
17535
+ }
17536
+
17537
+ /**
17538
+ * Get the organization&#39;s default supported content profile that will be used as the default when creating an integration.
17539
+ * When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it.
17540
+ */
17541
+ getConversationsMessagingSupportedcontentDefault() {
17542
+
17543
+ return this.apiClient.callApi(
17544
+ '/api/v2/conversations/messaging/supportedcontent/default',
17545
+ 'GET',
17546
+ { },
17547
+ { },
17548
+ { },
17549
+ { },
17550
+ null,
17551
+ ['PureCloud OAuth'],
17552
+ ['application/json'],
17553
+ ['application/json']
17554
+ );
17555
+ }
17556
+
17557
+ /**
17558
+ * Get a supported content profile
17559
+ *
17560
+ * @param {String} supportedContentId Supported Content ID
17561
+ */
17562
+ getConversationsMessagingSupportedcontentSupportedContentId(supportedContentId) {
17563
+ // verify the required parameter 'supportedContentId' is set
17564
+ if (supportedContentId === undefined || supportedContentId === null) {
17565
+ throw 'Missing the required parameter "supportedContentId" when calling getConversationsMessagingSupportedcontentSupportedContentId';
17566
+ }
17567
+
17568
+ return this.apiClient.callApi(
17569
+ '/api/v2/conversations/messaging/supportedcontent/{supportedContentId}',
17570
+ 'GET',
17571
+ { 'supportedContentId': supportedContentId },
17572
+ { },
17573
+ { },
17574
+ { },
17575
+ null,
17576
+ ['PureCloud OAuth'],
17577
+ ['application/json'],
17578
+ ['application/json']
17579
+ );
17580
+ }
17581
+
17485
17582
  /**
17486
17583
  * Get conversation threading window timeline for each messaging type
17487
17584
  * Conversation messaging threading timeline is a setting defined for each messenger type in your organization. This setting will dictate whether a new message is added to the most recent existing conversation, or creates a new Conversation. If the existing Conversation is still in a connected state the threading timeline setting will never play a role. After the conversation is disconnected, if an inbound message is received or an outbound message is sent after the setting for threading timeline expires, a new conversation is created.
@@ -18563,6 +18660,36 @@ class ConversationsApi {
18563
18660
  );
18564
18661
  }
18565
18662
 
18663
+ /**
18664
+ * Update a supported content profile
18665
+ *
18666
+ * @param {String} supportedContentId Supported Content ID
18667
+ * @param {Object} body SupportedContent
18668
+ */
18669
+ patchConversationsMessagingSupportedcontentSupportedContentId(supportedContentId, body) {
18670
+ // verify the required parameter 'supportedContentId' is set
18671
+ if (supportedContentId === undefined || supportedContentId === null) {
18672
+ throw 'Missing the required parameter "supportedContentId" when calling patchConversationsMessagingSupportedcontentSupportedContentId';
18673
+ }
18674
+ // verify the required parameter 'body' is set
18675
+ if (body === undefined || body === null) {
18676
+ throw 'Missing the required parameter "body" when calling patchConversationsMessagingSupportedcontentSupportedContentId';
18677
+ }
18678
+
18679
+ return this.apiClient.callApi(
18680
+ '/api/v2/conversations/messaging/supportedcontent/{supportedContentId}',
18681
+ 'PATCH',
18682
+ { 'supportedContentId': supportedContentId },
18683
+ { },
18684
+ { },
18685
+ { },
18686
+ body,
18687
+ ['PureCloud OAuth'],
18688
+ ['application/json'],
18689
+ ['application/json']
18690
+ );
18691
+ }
18692
+
18566
18693
  /**
18567
18694
  * Index conversation properties
18568
18695
  *
@@ -19798,6 +19925,31 @@ class ConversationsApi {
19798
19925
  );
19799
19926
  }
19800
19927
 
19928
+ /**
19929
+ * Create a Supported Content profile
19930
+ *
19931
+ * @param {Object} body SupportedContent
19932
+ */
19933
+ postConversationsMessagingSupportedcontent(body) {
19934
+ // verify the required parameter 'body' is set
19935
+ if (body === undefined || body === null) {
19936
+ throw 'Missing the required parameter "body" when calling postConversationsMessagingSupportedcontent';
19937
+ }
19938
+
19939
+ return this.apiClient.callApi(
19940
+ '/api/v2/conversations/messaging/supportedcontent',
19941
+ 'POST',
19942
+ { },
19943
+ { },
19944
+ { },
19945
+ { },
19946
+ body,
19947
+ ['PureCloud OAuth'],
19948
+ ['application/json'],
19949
+ ['application/json']
19950
+ );
19951
+ }
19952
+
19801
19953
  /**
19802
19954
  * Set flagged reason on conversation participant to indicate bad conversation quality.
19803
19955
  *
@@ -19958,6 +20110,31 @@ class ConversationsApi {
19958
20110
  );
19959
20111
  }
19960
20112
 
20113
+ /**
20114
+ * Set the organization&#39;s default supported content profile that may be assigned to an integration when it is created.
20115
+ * When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it.
20116
+ * @param {Object} body SupportedContent
20117
+ */
20118
+ putConversationsMessagingSupportedcontentDefault(body) {
20119
+ // verify the required parameter 'body' is set
20120
+ if (body === undefined || body === null) {
20121
+ throw 'Missing the required parameter "body" when calling putConversationsMessagingSupportedcontentDefault';
20122
+ }
20123
+
20124
+ return this.apiClient.callApi(
20125
+ '/api/v2/conversations/messaging/supportedcontent/default',
20126
+ 'PUT',
20127
+ { },
20128
+ { },
20129
+ { },
20130
+ { },
20131
+ body,
20132
+ ['PureCloud OAuth'],
20133
+ ['application/json'],
20134
+ ['application/json']
20135
+ );
20136
+ }
20137
+
19961
20138
  /**
19962
20139
  * Update conversation threading window timeline for each messaging type
19963
20140
  * PUT Conversation messaging threading timeline is intended to set the conversation threading settings for ALL messengerTypes. If you omit a messengerType in the request body then the setting for that messengerType will use the platform default value. The PUT replaces the existing setting(s) that were previously set for each messengerType.
@@ -19989,7 +20166,7 @@ class DataExtensionsApi {
19989
20166
  /**
19990
20167
  * DataExtensions service.
19991
20168
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
19992
- * @version 127.0.0
20169
+ * @version 131.0.0
19993
20170
  */
19994
20171
 
19995
20172
  /**
@@ -20075,7 +20252,7 @@ class ExternalContactsApi {
20075
20252
  /**
20076
20253
  * ExternalContacts service.
20077
20254
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
20078
- * @version 127.0.0
20255
+ * @version 131.0.0
20079
20256
  */
20080
20257
 
20081
20258
  /**
@@ -21818,7 +21995,7 @@ class FaxApi {
21818
21995
  /**
21819
21996
  * Fax service.
21820
21997
  * @module purecloud-platform-client-v2/api/FaxApi
21821
- * @version 127.0.0
21998
+ * @version 131.0.0
21822
21999
  */
21823
22000
 
21824
22001
  /**
@@ -21989,7 +22166,7 @@ class FlowsApi {
21989
22166
  /**
21990
22167
  * Flows service.
21991
22168
  * @module purecloud-platform-client-v2/api/FlowsApi
21992
- * @version 127.0.0
22169
+ * @version 131.0.0
21993
22170
  */
21994
22171
 
21995
22172
  /**
@@ -22060,7 +22237,7 @@ class GamificationApi {
22060
22237
  /**
22061
22238
  * Gamification service.
22062
22239
  * @module purecloud-platform-client-v2/api/GamificationApi
22063
- * @version 127.0.0
22240
+ * @version 131.0.0
22064
22241
  */
22065
22242
 
22066
22243
  /**
@@ -22328,6 +22505,31 @@ class GamificationApi {
22328
22505
  );
22329
22506
  }
22330
22507
 
22508
+ /**
22509
+ * Members of a given performance profile
22510
+ *
22511
+ * @param {String} performanceProfileId Performance Profile Id
22512
+ */
22513
+ getGamificationProfileMembers(performanceProfileId) {
22514
+ // verify the required parameter 'performanceProfileId' is set
22515
+ if (performanceProfileId === undefined || performanceProfileId === null) {
22516
+ throw 'Missing the required parameter "performanceProfileId" when calling getGamificationProfileMembers';
22517
+ }
22518
+
22519
+ return this.apiClient.callApi(
22520
+ '/api/v2/gamification/profiles/{performanceProfileId}/members',
22521
+ 'GET',
22522
+ { 'performanceProfileId': performanceProfileId },
22523
+ { },
22524
+ { },
22525
+ { },
22526
+ null,
22527
+ ['PureCloud OAuth'],
22528
+ ['application/json'],
22529
+ ['application/json']
22530
+ );
22531
+ }
22532
+
22331
22533
  /**
22332
22534
  * Performance profile gamified metric by id
22333
22535
  *
@@ -23182,6 +23384,101 @@ class GamificationApi {
23182
23384
  );
23183
23385
  }
23184
23386
 
23387
+ /**
23388
+ * Assign members to a given performance profile
23389
+ *
23390
+ * @param {String} performanceProfileId Performance Profile Id
23391
+ * @param {Object} body assignUsers
23392
+ */
23393
+ postGamificationProfileMembers(performanceProfileId, body) {
23394
+ // verify the required parameter 'performanceProfileId' is set
23395
+ if (performanceProfileId === undefined || performanceProfileId === null) {
23396
+ throw 'Missing the required parameter "performanceProfileId" when calling postGamificationProfileMembers';
23397
+ }
23398
+ // verify the required parameter 'body' is set
23399
+ if (body === undefined || body === null) {
23400
+ throw 'Missing the required parameter "body" when calling postGamificationProfileMembers';
23401
+ }
23402
+
23403
+ return this.apiClient.callApi(
23404
+ '/api/v2/gamification/profiles/{performanceProfileId}/members',
23405
+ 'POST',
23406
+ { 'performanceProfileId': performanceProfileId },
23407
+ { },
23408
+ { },
23409
+ { },
23410
+ body,
23411
+ ['PureCloud OAuth'],
23412
+ ['application/json'],
23413
+ ['application/json']
23414
+ );
23415
+ }
23416
+
23417
+ /**
23418
+ * Validate member assignment
23419
+ *
23420
+ * @param {String} performanceProfileId Performance Profile Id
23421
+ * @param {Object} body memberAssignments
23422
+ */
23423
+ postGamificationProfileMembersValidate(performanceProfileId, body) {
23424
+ // verify the required parameter 'performanceProfileId' is set
23425
+ if (performanceProfileId === undefined || performanceProfileId === null) {
23426
+ throw 'Missing the required parameter "performanceProfileId" when calling postGamificationProfileMembersValidate';
23427
+ }
23428
+ // verify the required parameter 'body' is set
23429
+ if (body === undefined || body === null) {
23430
+ throw 'Missing the required parameter "body" when calling postGamificationProfileMembersValidate';
23431
+ }
23432
+
23433
+ return this.apiClient.callApi(
23434
+ '/api/v2/gamification/profiles/{performanceProfileId}/members/validate',
23435
+ 'POST',
23436
+ { 'performanceProfileId': performanceProfileId },
23437
+ { },
23438
+ { },
23439
+ { },
23440
+ body,
23441
+ ['PureCloud OAuth'],
23442
+ ['application/json'],
23443
+ ['application/json']
23444
+ );
23445
+ }
23446
+
23447
+ /**
23448
+ * Creates a linked metric
23449
+ *
23450
+ * @param {String} sourceProfileId Source Performance Profile Id
23451
+ * @param {String} sourceMetricId Source Metric Id
23452
+ * @param {Object} body linkedMetric
23453
+ */
23454
+ postGamificationProfileMetricLink(sourceProfileId, sourceMetricId, body) {
23455
+ // verify the required parameter 'sourceProfileId' is set
23456
+ if (sourceProfileId === undefined || sourceProfileId === null) {
23457
+ throw 'Missing the required parameter "sourceProfileId" when calling postGamificationProfileMetricLink';
23458
+ }
23459
+ // verify the required parameter 'sourceMetricId' is set
23460
+ if (sourceMetricId === undefined || sourceMetricId === null) {
23461
+ throw 'Missing the required parameter "sourceMetricId" when calling postGamificationProfileMetricLink';
23462
+ }
23463
+ // verify the required parameter 'body' is set
23464
+ if (body === undefined || body === null) {
23465
+ throw 'Missing the required parameter "body" when calling postGamificationProfileMetricLink';
23466
+ }
23467
+
23468
+ return this.apiClient.callApi(
23469
+ '/api/v2/gamification/profiles/{sourceProfileId}/metrics/{sourceMetricId}/link',
23470
+ 'POST',
23471
+ { 'sourceProfileId': sourceProfileId,'sourceMetricId': sourceMetricId },
23472
+ { },
23473
+ { },
23474
+ { },
23475
+ body,
23476
+ ['PureCloud OAuth'],
23477
+ ['application/json'],
23478
+ ['application/json']
23479
+ );
23480
+ }
23481
+
23185
23482
  /**
23186
23483
  * Creates a gamified metric with a given metric definition and metric objective under in a performance profile
23187
23484
  *
@@ -23366,7 +23663,7 @@ class GeneralDataProtectionRegulationApi {
23366
23663
  /**
23367
23664
  * GeneralDataProtectionRegulation service.
23368
23665
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
23369
- * @version 127.0.0
23666
+ * @version 131.0.0
23370
23667
  */
23371
23668
 
23372
23669
  /**
@@ -23496,7 +23793,7 @@ class GeolocationApi {
23496
23793
  /**
23497
23794
  * Geolocation service.
23498
23795
  * @module purecloud-platform-client-v2/api/GeolocationApi
23499
- * @version 127.0.0
23796
+ * @version 131.0.0
23500
23797
  */
23501
23798
 
23502
23799
  /**
@@ -23627,7 +23924,7 @@ class GreetingsApi {
23627
23924
  /**
23628
23925
  * Greetings service.
23629
23926
  * @module purecloud-platform-client-v2/api/GreetingsApi
23630
- * @version 127.0.0
23927
+ * @version 131.0.0
23631
23928
  */
23632
23929
 
23633
23930
  /**
@@ -24082,7 +24379,7 @@ class GroupsApi {
24082
24379
  /**
24083
24380
  * Groups service.
24084
24381
  * @module purecloud-platform-client-v2/api/GroupsApi
24085
- * @version 127.0.0
24382
+ * @version 131.0.0
24086
24383
  */
24087
24384
 
24088
24385
  /**
@@ -24487,7 +24784,7 @@ class IdentityProviderApi {
24487
24784
  /**
24488
24785
  * IdentityProvider service.
24489
24786
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
24490
- * @version 127.0.0
24787
+ * @version 131.0.0
24491
24788
  */
24492
24789
 
24493
24790
  /**
@@ -25243,7 +25540,7 @@ class IntegrationsApi {
25243
25540
  /**
25244
25541
  * Integrations service.
25245
25542
  * @module purecloud-platform-client-v2/api/IntegrationsApi
25246
- * @version 127.0.0
25543
+ * @version 131.0.0
25247
25544
  */
25248
25545
 
25249
25546
  /**
@@ -25900,6 +26197,35 @@ class IntegrationsApi {
25900
26197
  );
25901
26198
  }
25902
26199
 
26200
+ /**
26201
+ * UC integration client application configuration.
26202
+ * This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled for the current organization.
26203
+ * @param {Object} opts Optional parameters
26204
+ * @param {Number} opts.pageSize The total page size requested (default to 25)
26205
+ * @param {Number} opts.pageNumber The page number requested (default to 1)
26206
+ * @param {String} opts.sortBy variable name requested to sort by
26207
+ * @param {Array.<String>} opts.expand variable name requested by expand list
26208
+ * @param {String} opts.nextPage next page token
26209
+ * @param {String} opts.previousPage Previous page token
26210
+ */
26211
+ getIntegrationsClientappsUnifiedcommunications(opts) {
26212
+ opts = opts || {};
26213
+
26214
+
26215
+ return this.apiClient.callApi(
26216
+ '/api/v2/integrations/clientapps/unifiedcommunications',
26217
+ 'GET',
26218
+ { },
26219
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'] },
26220
+ { },
26221
+ { },
26222
+ null,
26223
+ ['PureCloud OAuth'],
26224
+ ['application/json'],
26225
+ ['application/json']
26226
+ );
26227
+ }
26228
+
25903
26229
  /**
25904
26230
  * Get a single credential with sensitive fields redacted
25905
26231
  *
@@ -26889,7 +27215,7 @@ class JourneyApi {
26889
27215
  /**
26890
27216
  * Journey service.
26891
27217
  * @module purecloud-platform-client-v2/api/JourneyApi
26892
- * @version 127.0.0
27218
+ * @version 131.0.0
26893
27219
  */
26894
27220
 
26895
27221
  /**
@@ -27600,7 +27926,7 @@ class KnowledgeApi {
27600
27926
  /**
27601
27927
  * Knowledge service.
27602
27928
  * @module purecloud-platform-client-v2/api/KnowledgeApi
27603
- * @version 127.0.0
27929
+ * @version 131.0.0
27604
27930
  */
27605
27931
 
27606
27932
  /**
@@ -28500,7 +28826,7 @@ class LanguageUnderstandingApi {
28500
28826
  /**
28501
28827
  * LanguageUnderstanding service.
28502
28828
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
28503
- * @version 127.0.0
28829
+ * @version 131.0.0
28504
28830
  */
28505
28831
 
28506
28832
  /**
@@ -29404,7 +29730,7 @@ class LanguagesApi {
29404
29730
  /**
29405
29731
  * Languages service.
29406
29732
  * @module purecloud-platform-client-v2/api/LanguagesApi
29407
- * @version 127.0.0
29733
+ * @version 131.0.0
29408
29734
  */
29409
29735
 
29410
29736
  /**
@@ -29672,7 +29998,7 @@ class LearningApi {
29672
29998
  /**
29673
29999
  * Learning service.
29674
30000
  * @module purecloud-platform-client-v2/api/LearningApi
29675
- * @version 127.0.0
30001
+ * @version 131.0.0
29676
30002
  */
29677
30003
 
29678
30004
  /**
@@ -30263,7 +30589,7 @@ class LicenseApi {
30263
30589
  /**
30264
30590
  * License service.
30265
30591
  * @module purecloud-platform-client-v2/api/LicenseApi
30266
- * @version 127.0.0
30592
+ * @version 131.0.0
30267
30593
  */
30268
30594
 
30269
30595
  /**
@@ -30501,7 +30827,7 @@ class LocationsApi {
30501
30827
  /**
30502
30828
  * Locations service.
30503
30829
  * @module purecloud-platform-client-v2/api/LocationsApi
30504
- * @version 127.0.0
30830
+ * @version 131.0.0
30505
30831
  */
30506
30832
 
30507
30833
  /**
@@ -30733,11 +31059,162 @@ class LocationsApi {
30733
31059
 
30734
31060
  }
30735
31061
 
31062
+ class MessagingApi {
31063
+ /**
31064
+ * Messaging service.
31065
+ * @module purecloud-platform-client-v2/api/MessagingApi
31066
+ * @version 131.0.0
31067
+ */
31068
+
31069
+ /**
31070
+ * Constructs a new MessagingApi.
31071
+ * @alias module:purecloud-platform-client-v2/api/MessagingApi
31072
+ * @class
31073
+ * @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
31074
+ * default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
31075
+ */
31076
+ constructor(apiClient) {
31077
+ this.apiClient = apiClient || ApiClient.instance;
31078
+ }
31079
+
31080
+
31081
+ /**
31082
+ * Delete a supported content profile
31083
+ *
31084
+ * @param {String} supportedContentId Supported Content ID
31085
+ */
31086
+ deleteMessagingSupportedcontentSupportedContentId(supportedContentId) {
31087
+ // verify the required parameter 'supportedContentId' is set
31088
+ if (supportedContentId === undefined || supportedContentId === null) {
31089
+ throw 'Missing the required parameter "supportedContentId" when calling deleteMessagingSupportedcontentSupportedContentId';
31090
+ }
31091
+
31092
+ return this.apiClient.callApi(
31093
+ '/api/v2/messaging/supportedcontent/{supportedContentId}',
31094
+ 'DELETE',
31095
+ { 'supportedContentId': supportedContentId },
31096
+ { },
31097
+ { },
31098
+ { },
31099
+ null,
31100
+ ['PureCloud OAuth'],
31101
+ ['application/json'],
31102
+ ['application/json']
31103
+ );
31104
+ }
31105
+
31106
+ /**
31107
+ * Get a list of Supported Content profiles
31108
+ *
31109
+ * @param {Object} opts Optional parameters
31110
+ * @param {Number} opts.pageSize Page size (default to 25)
31111
+ * @param {Number} opts.pageNumber Page number (default to 1)
31112
+ */
31113
+ getMessagingSupportedcontent(opts) {
31114
+ opts = opts || {};
31115
+
31116
+
31117
+ return this.apiClient.callApi(
31118
+ '/api/v2/messaging/supportedcontent',
31119
+ 'GET',
31120
+ { },
31121
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
31122
+ { },
31123
+ { },
31124
+ null,
31125
+ ['PureCloud OAuth'],
31126
+ ['application/json'],
31127
+ ['application/json']
31128
+ );
31129
+ }
31130
+
31131
+ /**
31132
+ * Get a supported content profile
31133
+ *
31134
+ * @param {String} supportedContentId Supported Content ID
31135
+ */
31136
+ getMessagingSupportedcontentSupportedContentId(supportedContentId) {
31137
+ // verify the required parameter 'supportedContentId' is set
31138
+ if (supportedContentId === undefined || supportedContentId === null) {
31139
+ throw 'Missing the required parameter "supportedContentId" when calling getMessagingSupportedcontentSupportedContentId';
31140
+ }
31141
+
31142
+ return this.apiClient.callApi(
31143
+ '/api/v2/messaging/supportedcontent/{supportedContentId}',
31144
+ 'GET',
31145
+ { 'supportedContentId': supportedContentId },
31146
+ { },
31147
+ { },
31148
+ { },
31149
+ null,
31150
+ ['PureCloud OAuth'],
31151
+ ['application/json'],
31152
+ ['application/json']
31153
+ );
31154
+ }
31155
+
31156
+ /**
31157
+ * Update a supported content profile
31158
+ *
31159
+ * @param {String} supportedContentId Supported Content ID
31160
+ * @param {Object} body SupportedContent
31161
+ */
31162
+ patchMessagingSupportedcontentSupportedContentId(supportedContentId, body) {
31163
+ // verify the required parameter 'supportedContentId' is set
31164
+ if (supportedContentId === undefined || supportedContentId === null) {
31165
+ throw 'Missing the required parameter "supportedContentId" when calling patchMessagingSupportedcontentSupportedContentId';
31166
+ }
31167
+ // verify the required parameter 'body' is set
31168
+ if (body === undefined || body === null) {
31169
+ throw 'Missing the required parameter "body" when calling patchMessagingSupportedcontentSupportedContentId';
31170
+ }
31171
+
31172
+ return this.apiClient.callApi(
31173
+ '/api/v2/messaging/supportedcontent/{supportedContentId}',
31174
+ 'PATCH',
31175
+ { 'supportedContentId': supportedContentId },
31176
+ { },
31177
+ { },
31178
+ { },
31179
+ body,
31180
+ ['PureCloud OAuth'],
31181
+ ['application/json'],
31182
+ ['application/json']
31183
+ );
31184
+ }
31185
+
31186
+ /**
31187
+ * Create a Supported Content profile
31188
+ *
31189
+ * @param {Object} body SupportedContent
31190
+ */
31191
+ postMessagingSupportedcontent(body) {
31192
+ // verify the required parameter 'body' is set
31193
+ if (body === undefined || body === null) {
31194
+ throw 'Missing the required parameter "body" when calling postMessagingSupportedcontent';
31195
+ }
31196
+
31197
+ return this.apiClient.callApi(
31198
+ '/api/v2/messaging/supportedcontent',
31199
+ 'POST',
31200
+ { },
31201
+ { },
31202
+ { },
31203
+ { },
31204
+ body,
31205
+ ['PureCloud OAuth'],
31206
+ ['application/json'],
31207
+ ['application/json']
31208
+ );
31209
+ }
31210
+
31211
+ }
31212
+
30736
31213
  class MobileDevicesApi {
30737
31214
  /**
30738
31215
  * MobileDevices service.
30739
31216
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
30740
- * @version 127.0.0
31217
+ * @version 131.0.0
30741
31218
  */
30742
31219
 
30743
31220
  /**
@@ -30888,7 +31365,7 @@ class NotificationsApi {
30888
31365
  /**
30889
31366
  * Notifications service.
30890
31367
  * @module purecloud-platform-client-v2/api/NotificationsApi
30891
- * @version 127.0.0
31368
+ * @version 131.0.0
30892
31369
  */
30893
31370
 
30894
31371
  /**
@@ -31113,7 +31590,7 @@ class OAuthApi {
31113
31590
  /**
31114
31591
  * OAuth service.
31115
31592
  * @module purecloud-platform-client-v2/api/OAuthApi
31116
- * @version 127.0.0
31593
+ * @version 131.0.0
31117
31594
  */
31118
31595
 
31119
31596
  /**
@@ -31471,7 +31948,7 @@ class ObjectsApi {
31471
31948
  /**
31472
31949
  * Objects service.
31473
31950
  * @module purecloud-platform-client-v2/api/ObjectsApi
31474
- * @version 127.0.0
31951
+ * @version 131.0.0
31475
31952
  */
31476
31953
 
31477
31954
  /**
@@ -31742,7 +32219,7 @@ class OrganizationApi {
31742
32219
  /**
31743
32220
  * Organization service.
31744
32221
  * @module purecloud-platform-client-v2/api/OrganizationApi
31745
- * @version 127.0.0
32222
+ * @version 131.0.0
31746
32223
  */
31747
32224
 
31748
32225
  /**
@@ -32145,7 +32622,7 @@ class OrganizationAuthorizationApi {
32145
32622
  /**
32146
32623
  * OrganizationAuthorization service.
32147
32624
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
32148
- * @version 127.0.0
32625
+ * @version 131.0.0
32149
32626
  */
32150
32627
 
32151
32628
  /**
@@ -33070,7 +33547,7 @@ class OutboundApi {
33070
33547
  /**
33071
33548
  * Outbound service.
33072
33549
  * @module purecloud-platform-client-v2/api/OutboundApi
33073
- * @version 127.0.0
33550
+ * @version 131.0.0
33074
33551
  */
33075
33552
 
33076
33553
  /**
@@ -36096,7 +36573,7 @@ class PresenceApi {
36096
36573
  /**
36097
36574
  * Presence service.
36098
36575
  * @module purecloud-platform-client-v2/api/PresenceApi
36099
- * @version 127.0.0
36576
+ * @version 131.0.0
36100
36577
  */
36101
36578
 
36102
36579
  /**
@@ -36468,7 +36945,7 @@ class QualityApi {
36468
36945
  /**
36469
36946
  * Quality service.
36470
36947
  * @module purecloud-platform-client-v2/api/QualityApi
36471
- * @version 127.0.0
36948
+ * @version 131.0.0
36472
36949
  */
36473
36950
 
36474
36951
  /**
@@ -37996,7 +38473,7 @@ class RecordingApi {
37996
38473
  /**
37997
38474
  * Recording service.
37998
38475
  * @module purecloud-platform-client-v2/api/RecordingApi
37999
- * @version 127.0.0
38476
+ * @version 131.0.0
38000
38477
  */
38001
38478
 
38002
38479
  /**
@@ -38202,11 +38679,11 @@ class RecordingApi {
38202
38679
  * @param {String} conversationId Conversation ID
38203
38680
  * @param {String} recordingId Recording ID
38204
38681
  * @param {Object} opts Optional parameters
38205
- * @param {Object} opts.formatId The desired media format. (default to WEBM)
38206
- * @param {Object} opts.emailFormatId The desired media format when downloading an email recording. (default to EML)
38207
- * @param {Object} opts.chatFormatId The desired media format when downloading a chat recording. (default to ZIP)
38208
- * @param {Object} opts.messageFormatId The desired media format when downloading a message recording. (default to ZIP)
38209
- * @param {Boolean} opts.download requesting a download format of the recording (default to false)
38682
+ * @param {Object} opts.formatId The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE (default to WEBM)
38683
+ * @param {Object} opts.emailFormatId The desired media format when downloading an email recording. Valid values:EML,NONE (default to EML)
38684
+ * @param {Object} opts.chatFormatId The desired media format when downloading a chat recording. Valid values:ZIP,NONE (default to ZIP)
38685
+ * @param {Object} opts.messageFormatId The desired media format when downloading a message recording. Valid values:ZIP,NONE (default to ZIP)
38686
+ * @param {Boolean} opts.download requesting a download format of the recording. Valid values:true,false (default to false)
38210
38687
  * @param {String} opts.fileName the name of the downloaded fileName
38211
38688
  * @param {String} opts.locale The locale for the requested file when downloading, as an ISO 639-1 code
38212
38689
  */
@@ -38302,7 +38779,7 @@ class RecordingApi {
38302
38779
  }
38303
38780
 
38304
38781
  /**
38305
- * Get recording metadata for a conversation. Does not return playable media.
38782
+ * Get recording metadata for a conversation. Does not return playable media. Annotations won&#39;t be included in the response if recording:recording:view permission is missing.
38306
38783
  *
38307
38784
  * @param {String} conversationId Conversation ID
38308
38785
  */
@@ -38362,7 +38839,7 @@ class RecordingApi {
38362
38839
  * @param {String} conversationId Conversation ID
38363
38840
  * @param {Object} opts Optional parameters
38364
38841
  * @param {Number} opts.maxWaitMs The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value. (default to 5000)
38365
- * @param {Object} opts.formatId The desired media format (default to WEBM)
38842
+ * @param {Object} opts.formatId The desired media format . Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. (default to WEBM)
38366
38843
  */
38367
38844
  getConversationRecordings(conversationId, opts) {
38368
38845
  opts = opts || {};
@@ -39519,7 +39996,7 @@ class ResponseManagementApi {
39519
39996
  /**
39520
39997
  * ResponseManagement service.
39521
39998
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
39522
- * @version 127.0.0
39999
+ * @version 131.0.0
39523
40000
  */
39524
40001
 
39525
40002
  /**
@@ -39844,7 +40321,7 @@ class RoutingApi {
39844
40321
  /**
39845
40322
  * Routing service.
39846
40323
  * @module purecloud-platform-client-v2/api/RoutingApi
39847
- * @version 127.0.0
40324
+ * @version 131.0.0
39848
40325
  */
39849
40326
 
39850
40327
  /**
@@ -41282,10 +41759,14 @@ class RoutingApi {
41282
41759
  *
41283
41760
  * @param {Object} opts Optional parameters
41284
41761
  * @param {String} opts.phoneNumber Filter on phone number address. Allowable characters are the digits &#39;0-9&#39; and the wild card character &#39;\\*&#39;. If just digits are present, a contains search is done on the address pattern. For example, &#39;317&#39; could be matched anywhere in the address. An &#39;\\*&#39; will match multiple digits. For example, to match a specific area code within the US a pattern like &#39;1317*&#39; could be used.
41285
- * @param {Object} opts.phoneNumberType Filter on phone number type
41286
- * @param {Object} opts.phoneNumberStatus Filter on phone number status
41762
+ * @param {Array.<String>} opts.phoneNumberType Filter on phone number type
41763
+ * @param {Array.<String>} opts.phoneNumberStatus Filter on phone number status
41764
+ * @param {Array.<String>} opts.countryCode Filter on country code
41287
41765
  * @param {Number} opts.pageSize Page size (default to 25)
41288
41766
  * @param {Number} opts.pageNumber Page number (default to 1)
41767
+ * @param {Object} opts.sortBy Optional field to sort results
41768
+ * @param {Object} opts.sortOrder Sort order
41769
+ * @param {String} opts.language A language tag (which is sometimes referred to as a \&quot;locale identifier\&quot;) to use to localize country field and sort operations (default to en-US)
41289
41770
  */
41290
41771
  getRoutingSmsPhonenumbers(opts) {
41291
41772
  opts = opts || {};
@@ -41295,7 +41776,7 @@ class RoutingApi {
41295
41776
  '/api/v2/routing/sms/phonenumbers',
41296
41777
  'GET',
41297
41778
  { },
41298
- { 'phoneNumber': opts['phoneNumber'],'phoneNumberType': opts['phoneNumberType'],'phoneNumberStatus': opts['phoneNumberStatus'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
41779
+ { 'phoneNumber': opts['phoneNumber'],'phoneNumberType': this.apiClient.buildCollectionParam(opts['phoneNumberType'], 'multi'),'phoneNumberStatus': this.apiClient.buildCollectionParam(opts['phoneNumberStatus'], 'multi'),'countryCode': this.apiClient.buildCollectionParam(opts['countryCode'], 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'language': opts['language'] },
41299
41780
  { },
41300
41781
  { },
41301
41782
  null,
@@ -42763,7 +43244,7 @@ class SCIMApi {
42763
43244
  /**
42764
43245
  * SCIM service.
42765
43246
  * @module purecloud-platform-client-v2/api/SCIMApi
42766
- * @version 127.0.0
43247
+ * @version 131.0.0
42767
43248
  */
42768
43249
 
42769
43250
  /**
@@ -43640,7 +44121,7 @@ class ScriptsApi {
43640
44121
  /**
43641
44122
  * Scripts service.
43642
44123
  * @module purecloud-platform-client-v2/api/ScriptsApi
43643
- * @version 127.0.0
44124
+ * @version 131.0.0
43644
44125
  */
43645
44126
 
43646
44127
  /**
@@ -43993,7 +44474,7 @@ class SearchApi {
43993
44474
  /**
43994
44475
  * Search service.
43995
44476
  * @module purecloud-platform-client-v2/api/SearchApi
43996
- * @version 127.0.0
44477
+ * @version 131.0.0
43997
44478
  */
43998
44479
 
43999
44480
  /**
@@ -44528,7 +45009,7 @@ class SpeechTextAnalyticsApi {
44528
45009
  /**
44529
45010
  * SpeechTextAnalytics service.
44530
45011
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
44531
- * @version 127.0.0
45012
+ * @version 131.0.0
44532
45013
  */
44533
45014
 
44534
45015
  /**
@@ -44697,26 +45178,6 @@ class SpeechTextAnalyticsApi {
44697
45178
  );
44698
45179
  }
44699
45180
 
44700
- /**
44701
- * Get list of supported Speech &amp; Text Analytics dialects
44702
- * This api has been deprecated. Use api/v2/topics/dialects instead
44703
- */
44704
- getSpeechandtextanalyticsDialects() {
44705
-
44706
- return this.apiClient.callApi(
44707
- '/api/v2/speechandtextanalytics/dialects',
44708
- 'GET',
44709
- { },
44710
- { },
44711
- { },
44712
- { },
44713
- null,
44714
- ['PureCloud OAuth'],
44715
- ['application/json'],
44716
- ['application/json']
44717
- );
44718
- }
44719
-
44720
45181
  /**
44721
45182
  * Get a Speech &amp; Text Analytics program by id
44722
45183
  *
@@ -45401,7 +45862,7 @@ class StationsApi {
45401
45862
  /**
45402
45863
  * Stations service.
45403
45864
  * @module purecloud-platform-client-v2/api/StationsApi
45404
- * @version 127.0.0
45865
+ * @version 131.0.0
45405
45866
  */
45406
45867
 
45407
45868
  /**
@@ -45548,7 +46009,7 @@ class SuggestApi {
45548
46009
  /**
45549
46010
  * Suggest service.
45550
46011
  * @module purecloud-platform-client-v2/api/SuggestApi
45551
- * @version 127.0.0
46012
+ * @version 131.0.0
45552
46013
  */
45553
46014
 
45554
46015
  /**
@@ -45687,7 +46148,7 @@ class TelephonyApi {
45687
46148
  /**
45688
46149
  * Telephony service.
45689
46150
  * @module purecloud-platform-client-v2/api/TelephonyApi
45690
- * @version 127.0.0
46151
+ * @version 131.0.0
45691
46152
  */
45692
46153
 
45693
46154
  /**
@@ -45795,7 +46256,7 @@ class TelephonyProvidersEdgeApi {
45795
46256
  /**
45796
46257
  * TelephonyProvidersEdge service.
45797
46258
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
45798
- * @version 127.0.0
46259
+ * @version 131.0.0
45799
46260
  */
45800
46261
 
45801
46262
  /**
@@ -47133,6 +47594,26 @@ class TelephonyProvidersEdgeApi {
47133
47594
  );
47134
47595
  }
47135
47596
 
47597
+ /**
47598
+ * List of edges more than 4 edge versions behind the latest software.
47599
+ *
47600
+ */
47601
+ getTelephonyProvidersEdgesExpired() {
47602
+
47603
+ return this.apiClient.callApi(
47604
+ '/api/v2/telephony/providers/edges/expired',
47605
+ 'GET',
47606
+ { },
47607
+ { },
47608
+ { },
47609
+ { },
47610
+ null,
47611
+ ['PureCloud OAuth'],
47612
+ ['application/json'],
47613
+ ['application/json']
47614
+ );
47615
+ }
47616
+
47136
47617
  /**
47137
47618
  * Get an extension by ID.
47138
47619
  *
@@ -49408,7 +49889,7 @@ class TextbotsApi {
49408
49889
  /**
49409
49890
  * Textbots service.
49410
49891
  * @module purecloud-platform-client-v2/api/TextbotsApi
49411
- * @version 127.0.0
49892
+ * @version 131.0.0
49412
49893
  */
49413
49894
 
49414
49895
  /**
@@ -49423,6 +49904,33 @@ class TextbotsApi {
49423
49904
  }
49424
49905
 
49425
49906
 
49907
+ /**
49908
+ * Find bots using the currently configured friendly name or ID.
49909
+ * The name does allow case-insensitive partial string matches or by IDs (up to 50), but not both at the same time. Optionally you can limit the scope of the search by providing one or more bot types. You can specify the maximum results to return, up to a limit of 100
49910
+ * @param {Object} opts Optional parameters
49911
+ * @param {Array.<String>} opts.botType Bot types
49912
+ * @param {String} opts.botName Bot name
49913
+ * @param {Array.<String>} opts.botId Bot IDs
49914
+ * @param {Number} opts.pageSize The maximum results to return (default to 25)
49915
+ */
49916
+ getTextbotsBotsSearch(opts) {
49917
+ opts = opts || {};
49918
+
49919
+
49920
+ return this.apiClient.callApi(
49921
+ '/api/v2/textbots/bots/search',
49922
+ 'GET',
49923
+ { },
49924
+ { 'botType': this.apiClient.buildCollectionParam(opts['botType'], 'multi'),'botName': opts['botName'],'botId': this.apiClient.buildCollectionParam(opts['botId'], 'multi'),'pageSize': opts['pageSize'] },
49925
+ { },
49926
+ { },
49927
+ null,
49928
+ ['PureCloud OAuth'],
49929
+ ['application/json'],
49930
+ ['application/json']
49931
+ );
49932
+ }
49933
+
49426
49934
  /**
49427
49935
  * Issue a bot flow turn event
49428
49936
  * Send a turn event to an executing bot flow and produce the next action to take.
@@ -49509,7 +50017,7 @@ class TokensApi {
49509
50017
  /**
49510
50018
  * Tokens service.
49511
50019
  * @module purecloud-platform-client-v2/api/TokensApi
49512
- * @version 127.0.0
50020
+ * @version 131.0.0
49513
50021
  */
49514
50022
 
49515
50023
  /**
@@ -49615,7 +50123,7 @@ class UploadsApi {
49615
50123
  /**
49616
50124
  * Uploads service.
49617
50125
  * @module purecloud-platform-client-v2/api/UploadsApi
49618
- * @version 127.0.0
50126
+ * @version 131.0.0
49619
50127
  */
49620
50128
 
49621
50129
  /**
@@ -49791,7 +50299,7 @@ class UsageApi {
49791
50299
  /**
49792
50300
  * Usage service.
49793
50301
  * @module purecloud-platform-client-v2/api/UsageApi
49794
- * @version 127.0.0
50302
+ * @version 131.0.0
49795
50303
  */
49796
50304
 
49797
50305
  /**
@@ -49862,7 +50370,7 @@ class UserRecordingsApi {
49862
50370
  /**
49863
50371
  * UserRecordings service.
49864
50372
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
49865
- * @version 127.0.0
50373
+ * @version 131.0.0
49866
50374
  */
49867
50375
 
49868
50376
  /**
@@ -50046,7 +50554,7 @@ class UsersApi {
50046
50554
  /**
50047
50555
  * Users service.
50048
50556
  * @module purecloud-platform-client-v2/api/UsersApi
50049
- * @version 127.0.0
50557
+ * @version 131.0.0
50050
50558
  */
50051
50559
 
50052
50560
  /**
@@ -52348,7 +52856,7 @@ class UtilitiesApi {
52348
52856
  /**
52349
52857
  * Utilities service.
52350
52858
  * @module purecloud-platform-client-v2/api/UtilitiesApi
52351
- * @version 127.0.0
52859
+ * @version 131.0.0
52352
52860
  */
52353
52861
 
52354
52862
  /**
@@ -52384,7 +52892,7 @@ class UtilitiesApi {
52384
52892
  }
52385
52893
 
52386
52894
  /**
52387
- * Get public ip address ranges for PureCloud
52895
+ * Get public ip address ranges for Genesys Cloud
52388
52896
  *
52389
52897
  */
52390
52898
  getIpranges() {
@@ -52459,7 +52967,7 @@ class VoicemailApi {
52459
52967
  /**
52460
52968
  * Voicemail service.
52461
52969
  * @module purecloud-platform-client-v2/api/VoicemailApi
52462
- * @version 127.0.0
52970
+ * @version 131.0.0
52463
52971
  */
52464
52972
 
52465
52973
  /**
@@ -53126,7 +53634,7 @@ class WebChatApi {
53126
53634
  /**
53127
53635
  * WebChat service.
53128
53636
  * @module purecloud-platform-client-v2/api/WebChatApi
53129
- * @version 127.0.0
53637
+ * @version 131.0.0
53130
53638
  */
53131
53639
 
53132
53640
  /**
@@ -53670,7 +54178,7 @@ class WebDeploymentsApi {
53670
54178
  /**
53671
54179
  * WebDeployments service.
53672
54180
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
53673
- * @version 127.0.0
54181
+ * @version 131.0.0
53674
54182
  */
53675
54183
 
53676
54184
  /**
@@ -54025,7 +54533,7 @@ class WebMessagingApi {
54025
54533
  /**
54026
54534
  * WebMessaging service.
54027
54535
  * @module purecloud-platform-client-v2/api/WebMessagingApi
54028
- * @version 127.0.0
54536
+ * @version 131.0.0
54029
54537
  */
54030
54538
 
54031
54539
  /**
@@ -54071,7 +54579,7 @@ class WidgetsApi {
54071
54579
  /**
54072
54580
  * Widgets service.
54073
54581
  * @module purecloud-platform-client-v2/api/WidgetsApi
54074
- * @version 127.0.0
54582
+ * @version 131.0.0
54075
54583
  */
54076
54584
 
54077
54585
  /**
@@ -54217,7 +54725,7 @@ class WorkforceManagementApi {
54217
54725
  /**
54218
54726
  * WorkforceManagement service.
54219
54727
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
54220
- * @version 127.0.0
54728
+ * @version 131.0.0
54221
54729
  */
54222
54730
 
54223
54731
  /**
@@ -58248,7 +58756,7 @@ class WorkforceManagementApi {
58248
58756
  * </pre>
58249
58757
  * </p>
58250
58758
  * @module purecloud-platform-client-v2/index
58251
- * @version 127.0.0
58759
+ * @version 131.0.0
58252
58760
  */
58253
58761
  class platformClient {
58254
58762
  constructor() {
@@ -58402,6 +58910,11 @@ class platformClient {
58402
58910
  * @property {module:purecloud-platform-client-v2/api/LocationsApi}
58403
58911
  */
58404
58912
  this.LocationsApi = LocationsApi;
58913
+ /**
58914
+ * The MessagingApi service constructor.
58915
+ * @property {module:purecloud-platform-client-v2/api/MessagingApi}
58916
+ */
58917
+ this.MessagingApi = MessagingApi;
58405
58918
  /**
58406
58919
  * The MobileDevicesApi service constructor.
58407
58920
  * @property {module:purecloud-platform-client-v2/api/MobileDevicesApi}