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
@@ -2263,7 +2263,7 @@ class Configuration {
2263
2263
 
2264
2264
  /**
2265
2265
  * @module purecloud-platform-client-v2/ApiClient
2266
- * @version 127.0.0
2266
+ * @version 131.0.0
2267
2267
  */
2268
2268
  class ApiClient {
2269
2269
  /**
@@ -3203,7 +3203,7 @@ class ApiClient {
3203
3203
 
3204
3204
  // set header parameters
3205
3205
  request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
3206
- //request.set({ 'purecloud-sdk': '127.0.0' });
3206
+ //request.set({ 'purecloud-sdk': '131.0.0' });
3207
3207
 
3208
3208
  // set request timeout
3209
3209
  request.timeout(that.timeout);
@@ -3303,7 +3303,7 @@ class AlertingApi {
3303
3303
  /**
3304
3304
  * Alerting service.
3305
3305
  * @module purecloud-platform-client-v2/api/AlertingApi
3306
- * @version 127.0.0
3306
+ * @version 131.0.0
3307
3307
  */
3308
3308
 
3309
3309
  /**
@@ -3617,7 +3617,7 @@ class AnalyticsApi {
3617
3617
  /**
3618
3618
  * Analytics service.
3619
3619
  * @module purecloud-platform-client-v2/api/AnalyticsApi
3620
- * @version 127.0.0
3620
+ * @version 131.0.0
3621
3621
  */
3622
3622
 
3623
3623
  /**
@@ -4754,7 +4754,7 @@ class ArchitectApi {
4754
4754
  /**
4755
4755
  * Architect service.
4756
4756
  * @module purecloud-platform-client-v2/api/ArchitectApi
4757
- * @version 127.0.0
4757
+ * @version 131.0.0
4758
4758
  */
4759
4759
 
4760
4760
  /**
@@ -7750,7 +7750,7 @@ class AuditApi {
7750
7750
  /**
7751
7751
  * Audit service.
7752
7752
  * @module purecloud-platform-client-v2/api/AuditApi
7753
- * @version 127.0.0
7753
+ * @version 131.0.0
7754
7754
  */
7755
7755
 
7756
7756
  /**
@@ -7921,7 +7921,7 @@ class AuthorizationApi {
7921
7921
  /**
7922
7922
  * Authorization service.
7923
7923
  * @module purecloud-platform-client-v2/api/AuthorizationApi
7924
- * @version 127.0.0
7924
+ * @version 131.0.0
7925
7925
  */
7926
7926
 
7927
7927
  /**
@@ -9104,7 +9104,7 @@ class BillingApi {
9104
9104
  /**
9105
9105
  * Billing service.
9106
9106
  * @module purecloud-platform-client-v2/api/BillingApi
9107
- * @version 127.0.0
9107
+ * @version 131.0.0
9108
9108
  */
9109
9109
 
9110
9110
  /**
@@ -9184,7 +9184,7 @@ class ChatApi {
9184
9184
  /**
9185
9185
  * Chat service.
9186
9186
  * @module purecloud-platform-client-v2/api/ChatApi
9187
- * @version 127.0.0
9187
+ * @version 131.0.0
9188
9188
  */
9189
9189
 
9190
9190
  /**
@@ -9275,7 +9275,7 @@ class CoachingApi {
9275
9275
  /**
9276
9276
  * Coaching service.
9277
9277
  * @module purecloud-platform-client-v2/api/CoachingApi
9278
- * @version 127.0.0
9278
+ * @version 131.0.0
9279
9279
  */
9280
9280
 
9281
9281
  /**
@@ -9474,6 +9474,7 @@ class CoachingApi {
9474
9474
  * @param {Array.<String>} opts.relationships Relationships to filter by
9475
9475
  * @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
9476
9476
  * @param {Object} opts.overdue Overdue status to filter by
9477
+ * @param {Object} opts.intervalCondition Filter condition for interval
9477
9478
  */
9478
9479
  getCoachingAppointments(userIds, opts) {
9479
9480
  opts = opts || {};
@@ -9487,7 +9488,7 @@ class CoachingApi {
9487
9488
  '/api/v2/coaching/appointments',
9488
9489
  'GET',
9489
9490
  { },
9490
- { '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'] },
9491
+ { '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'] },
9491
9492
  { },
9492
9493
  { },
9493
9494
  null,
@@ -9510,6 +9511,7 @@ class CoachingApi {
9510
9511
  * @param {Array.<String>} opts.relationships Relationships to filter by
9511
9512
  * @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
9512
9513
  * @param {Object} opts.overdue Overdue status to filter by
9514
+ * @param {Object} opts.intervalCondition Filter condition for interval
9513
9515
  */
9514
9516
  getCoachingAppointmentsMe(opts) {
9515
9517
  opts = opts || {};
@@ -9519,7 +9521,7 @@ class CoachingApi {
9519
9521
  '/api/v2/coaching/appointments/me',
9520
9522
  'GET',
9521
9523
  { },
9522
- { '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'] },
9524
+ { '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'] },
9523
9525
  { },
9524
9526
  { },
9525
9527
  null,
@@ -9850,7 +9852,7 @@ class ContentManagementApi {
9850
9852
  /**
9851
9853
  * ContentManagement service.
9852
9854
  * @module purecloud-platform-client-v2/api/ContentManagementApi
9853
- * @version 127.0.0
9855
+ * @version 131.0.0
9854
9856
  */
9855
9857
 
9856
9858
  /**
@@ -10990,7 +10992,7 @@ class ConversationsApi {
10990
10992
  /**
10991
10993
  * Conversations service.
10992
10994
  * @module purecloud-platform-client-v2/api/ConversationsApi
10993
- * @version 127.0.0
10995
+ * @version 131.0.0
10994
10996
  */
10995
10997
 
10996
10998
  /**
@@ -11280,6 +11282,31 @@ class ConversationsApi {
11280
11282
  );
11281
11283
  }
11282
11284
 
11285
+ /**
11286
+ * Delete a supported content profile
11287
+ *
11288
+ * @param {String} supportedContentId Supported Content ID
11289
+ */
11290
+ deleteConversationsMessagingSupportedcontentSupportedContentId(supportedContentId) {
11291
+ // verify the required parameter 'supportedContentId' is set
11292
+ if (supportedContentId === undefined || supportedContentId === null) {
11293
+ throw 'Missing the required parameter "supportedContentId" when calling deleteConversationsMessagingSupportedcontentSupportedContentId';
11294
+ }
11295
+
11296
+ return this.apiClient.callApi(
11297
+ '/api/v2/conversations/messaging/supportedcontent/{supportedContentId}',
11298
+ 'DELETE',
11299
+ { 'supportedContentId': supportedContentId },
11300
+ { },
11301
+ { },
11302
+ { },
11303
+ null,
11304
+ ['PureCloud OAuth'],
11305
+ ['application/json'],
11306
+ ['application/json']
11307
+ );
11308
+ }
11309
+
11283
11310
  /**
11284
11311
  * Get a conversation by id
11285
11312
  *
@@ -12872,6 +12899,76 @@ class ConversationsApi {
12872
12899
  );
12873
12900
  }
12874
12901
 
12902
+ /**
12903
+ * Get a list of Supported Content profiles
12904
+ *
12905
+ * @param {Object} opts Optional parameters
12906
+ * @param {Number} opts.pageSize Page size (default to 25)
12907
+ * @param {Number} opts.pageNumber Page number (default to 1)
12908
+ */
12909
+ getConversationsMessagingSupportedcontent(opts) {
12910
+ opts = opts || {};
12911
+
12912
+
12913
+ return this.apiClient.callApi(
12914
+ '/api/v2/conversations/messaging/supportedcontent',
12915
+ 'GET',
12916
+ { },
12917
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
12918
+ { },
12919
+ { },
12920
+ null,
12921
+ ['PureCloud OAuth'],
12922
+ ['application/json'],
12923
+ ['application/json']
12924
+ );
12925
+ }
12926
+
12927
+ /**
12928
+ * Get the organization&#39;s default supported content profile that will be used as the default when creating an integration.
12929
+ * 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.
12930
+ */
12931
+ getConversationsMessagingSupportedcontentDefault() {
12932
+
12933
+ return this.apiClient.callApi(
12934
+ '/api/v2/conversations/messaging/supportedcontent/default',
12935
+ 'GET',
12936
+ { },
12937
+ { },
12938
+ { },
12939
+ { },
12940
+ null,
12941
+ ['PureCloud OAuth'],
12942
+ ['application/json'],
12943
+ ['application/json']
12944
+ );
12945
+ }
12946
+
12947
+ /**
12948
+ * Get a supported content profile
12949
+ *
12950
+ * @param {String} supportedContentId Supported Content ID
12951
+ */
12952
+ getConversationsMessagingSupportedcontentSupportedContentId(supportedContentId) {
12953
+ // verify the required parameter 'supportedContentId' is set
12954
+ if (supportedContentId === undefined || supportedContentId === null) {
12955
+ throw 'Missing the required parameter "supportedContentId" when calling getConversationsMessagingSupportedcontentSupportedContentId';
12956
+ }
12957
+
12958
+ return this.apiClient.callApi(
12959
+ '/api/v2/conversations/messaging/supportedcontent/{supportedContentId}',
12960
+ 'GET',
12961
+ { 'supportedContentId': supportedContentId },
12962
+ { },
12963
+ { },
12964
+ { },
12965
+ null,
12966
+ ['PureCloud OAuth'],
12967
+ ['application/json'],
12968
+ ['application/json']
12969
+ );
12970
+ }
12971
+
12875
12972
  /**
12876
12973
  * Get conversation threading window timeline for each messaging type
12877
12974
  * 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.
@@ -13953,6 +14050,36 @@ class ConversationsApi {
13953
14050
  );
13954
14051
  }
13955
14052
 
14053
+ /**
14054
+ * Update a supported content profile
14055
+ *
14056
+ * @param {String} supportedContentId Supported Content ID
14057
+ * @param {Object} body SupportedContent
14058
+ */
14059
+ patchConversationsMessagingSupportedcontentSupportedContentId(supportedContentId, body) {
14060
+ // verify the required parameter 'supportedContentId' is set
14061
+ if (supportedContentId === undefined || supportedContentId === null) {
14062
+ throw 'Missing the required parameter "supportedContentId" when calling patchConversationsMessagingSupportedcontentSupportedContentId';
14063
+ }
14064
+ // verify the required parameter 'body' is set
14065
+ if (body === undefined || body === null) {
14066
+ throw 'Missing the required parameter "body" when calling patchConversationsMessagingSupportedcontentSupportedContentId';
14067
+ }
14068
+
14069
+ return this.apiClient.callApi(
14070
+ '/api/v2/conversations/messaging/supportedcontent/{supportedContentId}',
14071
+ 'PATCH',
14072
+ { 'supportedContentId': supportedContentId },
14073
+ { },
14074
+ { },
14075
+ { },
14076
+ body,
14077
+ ['PureCloud OAuth'],
14078
+ ['application/json'],
14079
+ ['application/json']
14080
+ );
14081
+ }
14082
+
13956
14083
  /**
13957
14084
  * Index conversation properties
13958
14085
  *
@@ -15188,6 +15315,31 @@ class ConversationsApi {
15188
15315
  );
15189
15316
  }
15190
15317
 
15318
+ /**
15319
+ * Create a Supported Content profile
15320
+ *
15321
+ * @param {Object} body SupportedContent
15322
+ */
15323
+ postConversationsMessagingSupportedcontent(body) {
15324
+ // verify the required parameter 'body' is set
15325
+ if (body === undefined || body === null) {
15326
+ throw 'Missing the required parameter "body" when calling postConversationsMessagingSupportedcontent';
15327
+ }
15328
+
15329
+ return this.apiClient.callApi(
15330
+ '/api/v2/conversations/messaging/supportedcontent',
15331
+ 'POST',
15332
+ { },
15333
+ { },
15334
+ { },
15335
+ { },
15336
+ body,
15337
+ ['PureCloud OAuth'],
15338
+ ['application/json'],
15339
+ ['application/json']
15340
+ );
15341
+ }
15342
+
15191
15343
  /**
15192
15344
  * Set flagged reason on conversation participant to indicate bad conversation quality.
15193
15345
  *
@@ -15348,6 +15500,31 @@ class ConversationsApi {
15348
15500
  );
15349
15501
  }
15350
15502
 
15503
+ /**
15504
+ * Set the organization&#39;s default supported content profile that may be assigned to an integration when it is created.
15505
+ * 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.
15506
+ * @param {Object} body SupportedContent
15507
+ */
15508
+ putConversationsMessagingSupportedcontentDefault(body) {
15509
+ // verify the required parameter 'body' is set
15510
+ if (body === undefined || body === null) {
15511
+ throw 'Missing the required parameter "body" when calling putConversationsMessagingSupportedcontentDefault';
15512
+ }
15513
+
15514
+ return this.apiClient.callApi(
15515
+ '/api/v2/conversations/messaging/supportedcontent/default',
15516
+ 'PUT',
15517
+ { },
15518
+ { },
15519
+ { },
15520
+ { },
15521
+ body,
15522
+ ['PureCloud OAuth'],
15523
+ ['application/json'],
15524
+ ['application/json']
15525
+ );
15526
+ }
15527
+
15351
15528
  /**
15352
15529
  * Update conversation threading window timeline for each messaging type
15353
15530
  * 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.
@@ -15379,7 +15556,7 @@ class DataExtensionsApi {
15379
15556
  /**
15380
15557
  * DataExtensions service.
15381
15558
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
15382
- * @version 127.0.0
15559
+ * @version 131.0.0
15383
15560
  */
15384
15561
 
15385
15562
  /**
@@ -15465,7 +15642,7 @@ class ExternalContactsApi {
15465
15642
  /**
15466
15643
  * ExternalContacts service.
15467
15644
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
15468
- * @version 127.0.0
15645
+ * @version 131.0.0
15469
15646
  */
15470
15647
 
15471
15648
  /**
@@ -17208,7 +17385,7 @@ class FaxApi {
17208
17385
  /**
17209
17386
  * Fax service.
17210
17387
  * @module purecloud-platform-client-v2/api/FaxApi
17211
- * @version 127.0.0
17388
+ * @version 131.0.0
17212
17389
  */
17213
17390
 
17214
17391
  /**
@@ -17379,7 +17556,7 @@ class FlowsApi {
17379
17556
  /**
17380
17557
  * Flows service.
17381
17558
  * @module purecloud-platform-client-v2/api/FlowsApi
17382
- * @version 127.0.0
17559
+ * @version 131.0.0
17383
17560
  */
17384
17561
 
17385
17562
  /**
@@ -17450,7 +17627,7 @@ class GamificationApi {
17450
17627
  /**
17451
17628
  * Gamification service.
17452
17629
  * @module purecloud-platform-client-v2/api/GamificationApi
17453
- * @version 127.0.0
17630
+ * @version 131.0.0
17454
17631
  */
17455
17632
 
17456
17633
  /**
@@ -17718,6 +17895,31 @@ class GamificationApi {
17718
17895
  );
17719
17896
  }
17720
17897
 
17898
+ /**
17899
+ * Members of a given performance profile
17900
+ *
17901
+ * @param {String} performanceProfileId Performance Profile Id
17902
+ */
17903
+ getGamificationProfileMembers(performanceProfileId) {
17904
+ // verify the required parameter 'performanceProfileId' is set
17905
+ if (performanceProfileId === undefined || performanceProfileId === null) {
17906
+ throw 'Missing the required parameter "performanceProfileId" when calling getGamificationProfileMembers';
17907
+ }
17908
+
17909
+ return this.apiClient.callApi(
17910
+ '/api/v2/gamification/profiles/{performanceProfileId}/members',
17911
+ 'GET',
17912
+ { 'performanceProfileId': performanceProfileId },
17913
+ { },
17914
+ { },
17915
+ { },
17916
+ null,
17917
+ ['PureCloud OAuth'],
17918
+ ['application/json'],
17919
+ ['application/json']
17920
+ );
17921
+ }
17922
+
17721
17923
  /**
17722
17924
  * Performance profile gamified metric by id
17723
17925
  *
@@ -18572,6 +18774,101 @@ class GamificationApi {
18572
18774
  );
18573
18775
  }
18574
18776
 
18777
+ /**
18778
+ * Assign members to a given performance profile
18779
+ *
18780
+ * @param {String} performanceProfileId Performance Profile Id
18781
+ * @param {Object} body assignUsers
18782
+ */
18783
+ postGamificationProfileMembers(performanceProfileId, body) {
18784
+ // verify the required parameter 'performanceProfileId' is set
18785
+ if (performanceProfileId === undefined || performanceProfileId === null) {
18786
+ throw 'Missing the required parameter "performanceProfileId" when calling postGamificationProfileMembers';
18787
+ }
18788
+ // verify the required parameter 'body' is set
18789
+ if (body === undefined || body === null) {
18790
+ throw 'Missing the required parameter "body" when calling postGamificationProfileMembers';
18791
+ }
18792
+
18793
+ return this.apiClient.callApi(
18794
+ '/api/v2/gamification/profiles/{performanceProfileId}/members',
18795
+ 'POST',
18796
+ { 'performanceProfileId': performanceProfileId },
18797
+ { },
18798
+ { },
18799
+ { },
18800
+ body,
18801
+ ['PureCloud OAuth'],
18802
+ ['application/json'],
18803
+ ['application/json']
18804
+ );
18805
+ }
18806
+
18807
+ /**
18808
+ * Validate member assignment
18809
+ *
18810
+ * @param {String} performanceProfileId Performance Profile Id
18811
+ * @param {Object} body memberAssignments
18812
+ */
18813
+ postGamificationProfileMembersValidate(performanceProfileId, body) {
18814
+ // verify the required parameter 'performanceProfileId' is set
18815
+ if (performanceProfileId === undefined || performanceProfileId === null) {
18816
+ throw 'Missing the required parameter "performanceProfileId" when calling postGamificationProfileMembersValidate';
18817
+ }
18818
+ // verify the required parameter 'body' is set
18819
+ if (body === undefined || body === null) {
18820
+ throw 'Missing the required parameter "body" when calling postGamificationProfileMembersValidate';
18821
+ }
18822
+
18823
+ return this.apiClient.callApi(
18824
+ '/api/v2/gamification/profiles/{performanceProfileId}/members/validate',
18825
+ 'POST',
18826
+ { 'performanceProfileId': performanceProfileId },
18827
+ { },
18828
+ { },
18829
+ { },
18830
+ body,
18831
+ ['PureCloud OAuth'],
18832
+ ['application/json'],
18833
+ ['application/json']
18834
+ );
18835
+ }
18836
+
18837
+ /**
18838
+ * Creates a linked metric
18839
+ *
18840
+ * @param {String} sourceProfileId Source Performance Profile Id
18841
+ * @param {String} sourceMetricId Source Metric Id
18842
+ * @param {Object} body linkedMetric
18843
+ */
18844
+ postGamificationProfileMetricLink(sourceProfileId, sourceMetricId, body) {
18845
+ // verify the required parameter 'sourceProfileId' is set
18846
+ if (sourceProfileId === undefined || sourceProfileId === null) {
18847
+ throw 'Missing the required parameter "sourceProfileId" when calling postGamificationProfileMetricLink';
18848
+ }
18849
+ // verify the required parameter 'sourceMetricId' is set
18850
+ if (sourceMetricId === undefined || sourceMetricId === null) {
18851
+ throw 'Missing the required parameter "sourceMetricId" when calling postGamificationProfileMetricLink';
18852
+ }
18853
+ // verify the required parameter 'body' is set
18854
+ if (body === undefined || body === null) {
18855
+ throw 'Missing the required parameter "body" when calling postGamificationProfileMetricLink';
18856
+ }
18857
+
18858
+ return this.apiClient.callApi(
18859
+ '/api/v2/gamification/profiles/{sourceProfileId}/metrics/{sourceMetricId}/link',
18860
+ 'POST',
18861
+ { 'sourceProfileId': sourceProfileId,'sourceMetricId': sourceMetricId },
18862
+ { },
18863
+ { },
18864
+ { },
18865
+ body,
18866
+ ['PureCloud OAuth'],
18867
+ ['application/json'],
18868
+ ['application/json']
18869
+ );
18870
+ }
18871
+
18575
18872
  /**
18576
18873
  * Creates a gamified metric with a given metric definition and metric objective under in a performance profile
18577
18874
  *
@@ -18756,7 +19053,7 @@ class GeneralDataProtectionRegulationApi {
18756
19053
  /**
18757
19054
  * GeneralDataProtectionRegulation service.
18758
19055
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
18759
- * @version 127.0.0
19056
+ * @version 131.0.0
18760
19057
  */
18761
19058
 
18762
19059
  /**
@@ -18886,7 +19183,7 @@ class GeolocationApi {
18886
19183
  /**
18887
19184
  * Geolocation service.
18888
19185
  * @module purecloud-platform-client-v2/api/GeolocationApi
18889
- * @version 127.0.0
19186
+ * @version 131.0.0
18890
19187
  */
18891
19188
 
18892
19189
  /**
@@ -19017,7 +19314,7 @@ class GreetingsApi {
19017
19314
  /**
19018
19315
  * Greetings service.
19019
19316
  * @module purecloud-platform-client-v2/api/GreetingsApi
19020
- * @version 127.0.0
19317
+ * @version 131.0.0
19021
19318
  */
19022
19319
 
19023
19320
  /**
@@ -19472,7 +19769,7 @@ class GroupsApi {
19472
19769
  /**
19473
19770
  * Groups service.
19474
19771
  * @module purecloud-platform-client-v2/api/GroupsApi
19475
- * @version 127.0.0
19772
+ * @version 131.0.0
19476
19773
  */
19477
19774
 
19478
19775
  /**
@@ -19877,7 +20174,7 @@ class IdentityProviderApi {
19877
20174
  /**
19878
20175
  * IdentityProvider service.
19879
20176
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
19880
- * @version 127.0.0
20177
+ * @version 131.0.0
19881
20178
  */
19882
20179
 
19883
20180
  /**
@@ -20633,7 +20930,7 @@ class IntegrationsApi {
20633
20930
  /**
20634
20931
  * Integrations service.
20635
20932
  * @module purecloud-platform-client-v2/api/IntegrationsApi
20636
- * @version 127.0.0
20933
+ * @version 131.0.0
20637
20934
  */
20638
20935
 
20639
20936
  /**
@@ -21290,6 +21587,35 @@ class IntegrationsApi {
21290
21587
  );
21291
21588
  }
21292
21589
 
21590
+ /**
21591
+ * UC integration client application configuration.
21592
+ * This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled for the current organization.
21593
+ * @param {Object} opts Optional parameters
21594
+ * @param {Number} opts.pageSize The total page size requested (default to 25)
21595
+ * @param {Number} opts.pageNumber The page number requested (default to 1)
21596
+ * @param {String} opts.sortBy variable name requested to sort by
21597
+ * @param {Array.<String>} opts.expand variable name requested by expand list
21598
+ * @param {String} opts.nextPage next page token
21599
+ * @param {String} opts.previousPage Previous page token
21600
+ */
21601
+ getIntegrationsClientappsUnifiedcommunications(opts) {
21602
+ opts = opts || {};
21603
+
21604
+
21605
+ return this.apiClient.callApi(
21606
+ '/api/v2/integrations/clientapps/unifiedcommunications',
21607
+ 'GET',
21608
+ { },
21609
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'] },
21610
+ { },
21611
+ { },
21612
+ null,
21613
+ ['PureCloud OAuth'],
21614
+ ['application/json'],
21615
+ ['application/json']
21616
+ );
21617
+ }
21618
+
21293
21619
  /**
21294
21620
  * Get a single credential with sensitive fields redacted
21295
21621
  *
@@ -22279,7 +22605,7 @@ class JourneyApi {
22279
22605
  /**
22280
22606
  * Journey service.
22281
22607
  * @module purecloud-platform-client-v2/api/JourneyApi
22282
- * @version 127.0.0
22608
+ * @version 131.0.0
22283
22609
  */
22284
22610
 
22285
22611
  /**
@@ -22990,7 +23316,7 @@ class KnowledgeApi {
22990
23316
  /**
22991
23317
  * Knowledge service.
22992
23318
  * @module purecloud-platform-client-v2/api/KnowledgeApi
22993
- * @version 127.0.0
23319
+ * @version 131.0.0
22994
23320
  */
22995
23321
 
22996
23322
  /**
@@ -23890,7 +24216,7 @@ class LanguageUnderstandingApi {
23890
24216
  /**
23891
24217
  * LanguageUnderstanding service.
23892
24218
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
23893
- * @version 127.0.0
24219
+ * @version 131.0.0
23894
24220
  */
23895
24221
 
23896
24222
  /**
@@ -24794,7 +25120,7 @@ class LanguagesApi {
24794
25120
  /**
24795
25121
  * Languages service.
24796
25122
  * @module purecloud-platform-client-v2/api/LanguagesApi
24797
- * @version 127.0.0
25123
+ * @version 131.0.0
24798
25124
  */
24799
25125
 
24800
25126
  /**
@@ -25062,7 +25388,7 @@ class LearningApi {
25062
25388
  /**
25063
25389
  * Learning service.
25064
25390
  * @module purecloud-platform-client-v2/api/LearningApi
25065
- * @version 127.0.0
25391
+ * @version 131.0.0
25066
25392
  */
25067
25393
 
25068
25394
  /**
@@ -25653,7 +25979,7 @@ class LicenseApi {
25653
25979
  /**
25654
25980
  * License service.
25655
25981
  * @module purecloud-platform-client-v2/api/LicenseApi
25656
- * @version 127.0.0
25982
+ * @version 131.0.0
25657
25983
  */
25658
25984
 
25659
25985
  /**
@@ -25891,7 +26217,7 @@ class LocationsApi {
25891
26217
  /**
25892
26218
  * Locations service.
25893
26219
  * @module purecloud-platform-client-v2/api/LocationsApi
25894
- * @version 127.0.0
26220
+ * @version 131.0.0
25895
26221
  */
25896
26222
 
25897
26223
  /**
@@ -26123,11 +26449,162 @@ class LocationsApi {
26123
26449
 
26124
26450
  }
26125
26451
 
26452
+ class MessagingApi {
26453
+ /**
26454
+ * Messaging service.
26455
+ * @module purecloud-platform-client-v2/api/MessagingApi
26456
+ * @version 131.0.0
26457
+ */
26458
+
26459
+ /**
26460
+ * Constructs a new MessagingApi.
26461
+ * @alias module:purecloud-platform-client-v2/api/MessagingApi
26462
+ * @class
26463
+ * @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
26464
+ * default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
26465
+ */
26466
+ constructor(apiClient) {
26467
+ this.apiClient = apiClient || ApiClient.instance;
26468
+ }
26469
+
26470
+
26471
+ /**
26472
+ * Delete a supported content profile
26473
+ *
26474
+ * @param {String} supportedContentId Supported Content ID
26475
+ */
26476
+ deleteMessagingSupportedcontentSupportedContentId(supportedContentId) {
26477
+ // verify the required parameter 'supportedContentId' is set
26478
+ if (supportedContentId === undefined || supportedContentId === null) {
26479
+ throw 'Missing the required parameter "supportedContentId" when calling deleteMessagingSupportedcontentSupportedContentId';
26480
+ }
26481
+
26482
+ return this.apiClient.callApi(
26483
+ '/api/v2/messaging/supportedcontent/{supportedContentId}',
26484
+ 'DELETE',
26485
+ { 'supportedContentId': supportedContentId },
26486
+ { },
26487
+ { },
26488
+ { },
26489
+ null,
26490
+ ['PureCloud OAuth'],
26491
+ ['application/json'],
26492
+ ['application/json']
26493
+ );
26494
+ }
26495
+
26496
+ /**
26497
+ * Get a list of Supported Content profiles
26498
+ *
26499
+ * @param {Object} opts Optional parameters
26500
+ * @param {Number} opts.pageSize Page size (default to 25)
26501
+ * @param {Number} opts.pageNumber Page number (default to 1)
26502
+ */
26503
+ getMessagingSupportedcontent(opts) {
26504
+ opts = opts || {};
26505
+
26506
+
26507
+ return this.apiClient.callApi(
26508
+ '/api/v2/messaging/supportedcontent',
26509
+ 'GET',
26510
+ { },
26511
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
26512
+ { },
26513
+ { },
26514
+ null,
26515
+ ['PureCloud OAuth'],
26516
+ ['application/json'],
26517
+ ['application/json']
26518
+ );
26519
+ }
26520
+
26521
+ /**
26522
+ * Get a supported content profile
26523
+ *
26524
+ * @param {String} supportedContentId Supported Content ID
26525
+ */
26526
+ getMessagingSupportedcontentSupportedContentId(supportedContentId) {
26527
+ // verify the required parameter 'supportedContentId' is set
26528
+ if (supportedContentId === undefined || supportedContentId === null) {
26529
+ throw 'Missing the required parameter "supportedContentId" when calling getMessagingSupportedcontentSupportedContentId';
26530
+ }
26531
+
26532
+ return this.apiClient.callApi(
26533
+ '/api/v2/messaging/supportedcontent/{supportedContentId}',
26534
+ 'GET',
26535
+ { 'supportedContentId': supportedContentId },
26536
+ { },
26537
+ { },
26538
+ { },
26539
+ null,
26540
+ ['PureCloud OAuth'],
26541
+ ['application/json'],
26542
+ ['application/json']
26543
+ );
26544
+ }
26545
+
26546
+ /**
26547
+ * Update a supported content profile
26548
+ *
26549
+ * @param {String} supportedContentId Supported Content ID
26550
+ * @param {Object} body SupportedContent
26551
+ */
26552
+ patchMessagingSupportedcontentSupportedContentId(supportedContentId, body) {
26553
+ // verify the required parameter 'supportedContentId' is set
26554
+ if (supportedContentId === undefined || supportedContentId === null) {
26555
+ throw 'Missing the required parameter "supportedContentId" when calling patchMessagingSupportedcontentSupportedContentId';
26556
+ }
26557
+ // verify the required parameter 'body' is set
26558
+ if (body === undefined || body === null) {
26559
+ throw 'Missing the required parameter "body" when calling patchMessagingSupportedcontentSupportedContentId';
26560
+ }
26561
+
26562
+ return this.apiClient.callApi(
26563
+ '/api/v2/messaging/supportedcontent/{supportedContentId}',
26564
+ 'PATCH',
26565
+ { 'supportedContentId': supportedContentId },
26566
+ { },
26567
+ { },
26568
+ { },
26569
+ body,
26570
+ ['PureCloud OAuth'],
26571
+ ['application/json'],
26572
+ ['application/json']
26573
+ );
26574
+ }
26575
+
26576
+ /**
26577
+ * Create a Supported Content profile
26578
+ *
26579
+ * @param {Object} body SupportedContent
26580
+ */
26581
+ postMessagingSupportedcontent(body) {
26582
+ // verify the required parameter 'body' is set
26583
+ if (body === undefined || body === null) {
26584
+ throw 'Missing the required parameter "body" when calling postMessagingSupportedcontent';
26585
+ }
26586
+
26587
+ return this.apiClient.callApi(
26588
+ '/api/v2/messaging/supportedcontent',
26589
+ 'POST',
26590
+ { },
26591
+ { },
26592
+ { },
26593
+ { },
26594
+ body,
26595
+ ['PureCloud OAuth'],
26596
+ ['application/json'],
26597
+ ['application/json']
26598
+ );
26599
+ }
26600
+
26601
+ }
26602
+
26126
26603
  class MobileDevicesApi {
26127
26604
  /**
26128
26605
  * MobileDevices service.
26129
26606
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
26130
- * @version 127.0.0
26607
+ * @version 131.0.0
26131
26608
  */
26132
26609
 
26133
26610
  /**
@@ -26278,7 +26755,7 @@ class NotificationsApi {
26278
26755
  /**
26279
26756
  * Notifications service.
26280
26757
  * @module purecloud-platform-client-v2/api/NotificationsApi
26281
- * @version 127.0.0
26758
+ * @version 131.0.0
26282
26759
  */
26283
26760
 
26284
26761
  /**
@@ -26503,7 +26980,7 @@ class OAuthApi {
26503
26980
  /**
26504
26981
  * OAuth service.
26505
26982
  * @module purecloud-platform-client-v2/api/OAuthApi
26506
- * @version 127.0.0
26983
+ * @version 131.0.0
26507
26984
  */
26508
26985
 
26509
26986
  /**
@@ -26861,7 +27338,7 @@ class ObjectsApi {
26861
27338
  /**
26862
27339
  * Objects service.
26863
27340
  * @module purecloud-platform-client-v2/api/ObjectsApi
26864
- * @version 127.0.0
27341
+ * @version 131.0.0
26865
27342
  */
26866
27343
 
26867
27344
  /**
@@ -27132,7 +27609,7 @@ class OrganizationApi {
27132
27609
  /**
27133
27610
  * Organization service.
27134
27611
  * @module purecloud-platform-client-v2/api/OrganizationApi
27135
- * @version 127.0.0
27612
+ * @version 131.0.0
27136
27613
  */
27137
27614
 
27138
27615
  /**
@@ -27535,7 +28012,7 @@ class OrganizationAuthorizationApi {
27535
28012
  /**
27536
28013
  * OrganizationAuthorization service.
27537
28014
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
27538
- * @version 127.0.0
28015
+ * @version 131.0.0
27539
28016
  */
27540
28017
 
27541
28018
  /**
@@ -28460,7 +28937,7 @@ class OutboundApi {
28460
28937
  /**
28461
28938
  * Outbound service.
28462
28939
  * @module purecloud-platform-client-v2/api/OutboundApi
28463
- * @version 127.0.0
28940
+ * @version 131.0.0
28464
28941
  */
28465
28942
 
28466
28943
  /**
@@ -31486,7 +31963,7 @@ class PresenceApi {
31486
31963
  /**
31487
31964
  * Presence service.
31488
31965
  * @module purecloud-platform-client-v2/api/PresenceApi
31489
- * @version 127.0.0
31966
+ * @version 131.0.0
31490
31967
  */
31491
31968
 
31492
31969
  /**
@@ -31858,7 +32335,7 @@ class QualityApi {
31858
32335
  /**
31859
32336
  * Quality service.
31860
32337
  * @module purecloud-platform-client-v2/api/QualityApi
31861
- * @version 127.0.0
32338
+ * @version 131.0.0
31862
32339
  */
31863
32340
 
31864
32341
  /**
@@ -33386,7 +33863,7 @@ class RecordingApi {
33386
33863
  /**
33387
33864
  * Recording service.
33388
33865
  * @module purecloud-platform-client-v2/api/RecordingApi
33389
- * @version 127.0.0
33866
+ * @version 131.0.0
33390
33867
  */
33391
33868
 
33392
33869
  /**
@@ -33592,11 +34069,11 @@ class RecordingApi {
33592
34069
  * @param {String} conversationId Conversation ID
33593
34070
  * @param {String} recordingId Recording ID
33594
34071
  * @param {Object} opts Optional parameters
33595
- * @param {Object} opts.formatId The desired media format. (default to WEBM)
33596
- * @param {Object} opts.emailFormatId The desired media format when downloading an email recording. (default to EML)
33597
- * @param {Object} opts.chatFormatId The desired media format when downloading a chat recording. (default to ZIP)
33598
- * @param {Object} opts.messageFormatId The desired media format when downloading a message recording. (default to ZIP)
33599
- * @param {Boolean} opts.download requesting a download format of the recording (default to false)
34072
+ * @param {Object} opts.formatId The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE (default to WEBM)
34073
+ * @param {Object} opts.emailFormatId The desired media format when downloading an email recording. Valid values:EML,NONE (default to EML)
34074
+ * @param {Object} opts.chatFormatId The desired media format when downloading a chat recording. Valid values:ZIP,NONE (default to ZIP)
34075
+ * @param {Object} opts.messageFormatId The desired media format when downloading a message recording. Valid values:ZIP,NONE (default to ZIP)
34076
+ * @param {Boolean} opts.download requesting a download format of the recording. Valid values:true,false (default to false)
33600
34077
  * @param {String} opts.fileName the name of the downloaded fileName
33601
34078
  * @param {String} opts.locale The locale for the requested file when downloading, as an ISO 639-1 code
33602
34079
  */
@@ -33692,7 +34169,7 @@ class RecordingApi {
33692
34169
  }
33693
34170
 
33694
34171
  /**
33695
- * Get recording metadata for a conversation. Does not return playable media.
34172
+ * 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.
33696
34173
  *
33697
34174
  * @param {String} conversationId Conversation ID
33698
34175
  */
@@ -33752,7 +34229,7 @@ class RecordingApi {
33752
34229
  * @param {String} conversationId Conversation ID
33753
34230
  * @param {Object} opts Optional parameters
33754
34231
  * @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)
33755
- * @param {Object} opts.formatId The desired media format (default to WEBM)
34232
+ * @param {Object} opts.formatId The desired media format . Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. (default to WEBM)
33756
34233
  */
33757
34234
  getConversationRecordings(conversationId, opts) {
33758
34235
  opts = opts || {};
@@ -34909,7 +35386,7 @@ class ResponseManagementApi {
34909
35386
  /**
34910
35387
  * ResponseManagement service.
34911
35388
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
34912
- * @version 127.0.0
35389
+ * @version 131.0.0
34913
35390
  */
34914
35391
 
34915
35392
  /**
@@ -35234,7 +35711,7 @@ class RoutingApi {
35234
35711
  /**
35235
35712
  * Routing service.
35236
35713
  * @module purecloud-platform-client-v2/api/RoutingApi
35237
- * @version 127.0.0
35714
+ * @version 131.0.0
35238
35715
  */
35239
35716
 
35240
35717
  /**
@@ -36672,10 +37149,14 @@ class RoutingApi {
36672
37149
  *
36673
37150
  * @param {Object} opts Optional parameters
36674
37151
  * @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.
36675
- * @param {Object} opts.phoneNumberType Filter on phone number type
36676
- * @param {Object} opts.phoneNumberStatus Filter on phone number status
37152
+ * @param {Array.<String>} opts.phoneNumberType Filter on phone number type
37153
+ * @param {Array.<String>} opts.phoneNumberStatus Filter on phone number status
37154
+ * @param {Array.<String>} opts.countryCode Filter on country code
36677
37155
  * @param {Number} opts.pageSize Page size (default to 25)
36678
37156
  * @param {Number} opts.pageNumber Page number (default to 1)
37157
+ * @param {Object} opts.sortBy Optional field to sort results
37158
+ * @param {Object} opts.sortOrder Sort order
37159
+ * @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)
36679
37160
  */
36680
37161
  getRoutingSmsPhonenumbers(opts) {
36681
37162
  opts = opts || {};
@@ -36685,7 +37166,7 @@ class RoutingApi {
36685
37166
  '/api/v2/routing/sms/phonenumbers',
36686
37167
  'GET',
36687
37168
  { },
36688
- { 'phoneNumber': opts['phoneNumber'],'phoneNumberType': opts['phoneNumberType'],'phoneNumberStatus': opts['phoneNumberStatus'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
37169
+ { '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'] },
36689
37170
  { },
36690
37171
  { },
36691
37172
  null,
@@ -38153,7 +38634,7 @@ class SCIMApi {
38153
38634
  /**
38154
38635
  * SCIM service.
38155
38636
  * @module purecloud-platform-client-v2/api/SCIMApi
38156
- * @version 127.0.0
38637
+ * @version 131.0.0
38157
38638
  */
38158
38639
 
38159
38640
  /**
@@ -39030,7 +39511,7 @@ class ScriptsApi {
39030
39511
  /**
39031
39512
  * Scripts service.
39032
39513
  * @module purecloud-platform-client-v2/api/ScriptsApi
39033
- * @version 127.0.0
39514
+ * @version 131.0.0
39034
39515
  */
39035
39516
 
39036
39517
  /**
@@ -39383,7 +39864,7 @@ class SearchApi {
39383
39864
  /**
39384
39865
  * Search service.
39385
39866
  * @module purecloud-platform-client-v2/api/SearchApi
39386
- * @version 127.0.0
39867
+ * @version 131.0.0
39387
39868
  */
39388
39869
 
39389
39870
  /**
@@ -39918,7 +40399,7 @@ class SpeechTextAnalyticsApi {
39918
40399
  /**
39919
40400
  * SpeechTextAnalytics service.
39920
40401
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
39921
- * @version 127.0.0
40402
+ * @version 131.0.0
39922
40403
  */
39923
40404
 
39924
40405
  /**
@@ -40087,26 +40568,6 @@ class SpeechTextAnalyticsApi {
40087
40568
  );
40088
40569
  }
40089
40570
 
40090
- /**
40091
- * Get list of supported Speech &amp; Text Analytics dialects
40092
- * This api has been deprecated. Use api/v2/topics/dialects instead
40093
- */
40094
- getSpeechandtextanalyticsDialects() {
40095
-
40096
- return this.apiClient.callApi(
40097
- '/api/v2/speechandtextanalytics/dialects',
40098
- 'GET',
40099
- { },
40100
- { },
40101
- { },
40102
- { },
40103
- null,
40104
- ['PureCloud OAuth'],
40105
- ['application/json'],
40106
- ['application/json']
40107
- );
40108
- }
40109
-
40110
40571
  /**
40111
40572
  * Get a Speech &amp; Text Analytics program by id
40112
40573
  *
@@ -40791,7 +41252,7 @@ class StationsApi {
40791
41252
  /**
40792
41253
  * Stations service.
40793
41254
  * @module purecloud-platform-client-v2/api/StationsApi
40794
- * @version 127.0.0
41255
+ * @version 131.0.0
40795
41256
  */
40796
41257
 
40797
41258
  /**
@@ -40938,7 +41399,7 @@ class SuggestApi {
40938
41399
  /**
40939
41400
  * Suggest service.
40940
41401
  * @module purecloud-platform-client-v2/api/SuggestApi
40941
- * @version 127.0.0
41402
+ * @version 131.0.0
40942
41403
  */
40943
41404
 
40944
41405
  /**
@@ -41077,7 +41538,7 @@ class TelephonyApi {
41077
41538
  /**
41078
41539
  * Telephony service.
41079
41540
  * @module purecloud-platform-client-v2/api/TelephonyApi
41080
- * @version 127.0.0
41541
+ * @version 131.0.0
41081
41542
  */
41082
41543
 
41083
41544
  /**
@@ -41185,7 +41646,7 @@ class TelephonyProvidersEdgeApi {
41185
41646
  /**
41186
41647
  * TelephonyProvidersEdge service.
41187
41648
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
41188
- * @version 127.0.0
41649
+ * @version 131.0.0
41189
41650
  */
41190
41651
 
41191
41652
  /**
@@ -42523,6 +42984,26 @@ class TelephonyProvidersEdgeApi {
42523
42984
  );
42524
42985
  }
42525
42986
 
42987
+ /**
42988
+ * List of edges more than 4 edge versions behind the latest software.
42989
+ *
42990
+ */
42991
+ getTelephonyProvidersEdgesExpired() {
42992
+
42993
+ return this.apiClient.callApi(
42994
+ '/api/v2/telephony/providers/edges/expired',
42995
+ 'GET',
42996
+ { },
42997
+ { },
42998
+ { },
42999
+ { },
43000
+ null,
43001
+ ['PureCloud OAuth'],
43002
+ ['application/json'],
43003
+ ['application/json']
43004
+ );
43005
+ }
43006
+
42526
43007
  /**
42527
43008
  * Get an extension by ID.
42528
43009
  *
@@ -44798,7 +45279,7 @@ class TextbotsApi {
44798
45279
  /**
44799
45280
  * Textbots service.
44800
45281
  * @module purecloud-platform-client-v2/api/TextbotsApi
44801
- * @version 127.0.0
45282
+ * @version 131.0.0
44802
45283
  */
44803
45284
 
44804
45285
  /**
@@ -44813,6 +45294,33 @@ class TextbotsApi {
44813
45294
  }
44814
45295
 
44815
45296
 
45297
+ /**
45298
+ * Find bots using the currently configured friendly name or ID.
45299
+ * 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
45300
+ * @param {Object} opts Optional parameters
45301
+ * @param {Array.<String>} opts.botType Bot types
45302
+ * @param {String} opts.botName Bot name
45303
+ * @param {Array.<String>} opts.botId Bot IDs
45304
+ * @param {Number} opts.pageSize The maximum results to return (default to 25)
45305
+ */
45306
+ getTextbotsBotsSearch(opts) {
45307
+ opts = opts || {};
45308
+
45309
+
45310
+ return this.apiClient.callApi(
45311
+ '/api/v2/textbots/bots/search',
45312
+ 'GET',
45313
+ { },
45314
+ { 'botType': this.apiClient.buildCollectionParam(opts['botType'], 'multi'),'botName': opts['botName'],'botId': this.apiClient.buildCollectionParam(opts['botId'], 'multi'),'pageSize': opts['pageSize'] },
45315
+ { },
45316
+ { },
45317
+ null,
45318
+ ['PureCloud OAuth'],
45319
+ ['application/json'],
45320
+ ['application/json']
45321
+ );
45322
+ }
45323
+
44816
45324
  /**
44817
45325
  * Issue a bot flow turn event
44818
45326
  * Send a turn event to an executing bot flow and produce the next action to take.
@@ -44899,7 +45407,7 @@ class TokensApi {
44899
45407
  /**
44900
45408
  * Tokens service.
44901
45409
  * @module purecloud-platform-client-v2/api/TokensApi
44902
- * @version 127.0.0
45410
+ * @version 131.0.0
44903
45411
  */
44904
45412
 
44905
45413
  /**
@@ -45005,7 +45513,7 @@ class UploadsApi {
45005
45513
  /**
45006
45514
  * Uploads service.
45007
45515
  * @module purecloud-platform-client-v2/api/UploadsApi
45008
- * @version 127.0.0
45516
+ * @version 131.0.0
45009
45517
  */
45010
45518
 
45011
45519
  /**
@@ -45181,7 +45689,7 @@ class UsageApi {
45181
45689
  /**
45182
45690
  * Usage service.
45183
45691
  * @module purecloud-platform-client-v2/api/UsageApi
45184
- * @version 127.0.0
45692
+ * @version 131.0.0
45185
45693
  */
45186
45694
 
45187
45695
  /**
@@ -45252,7 +45760,7 @@ class UserRecordingsApi {
45252
45760
  /**
45253
45761
  * UserRecordings service.
45254
45762
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
45255
- * @version 127.0.0
45763
+ * @version 131.0.0
45256
45764
  */
45257
45765
 
45258
45766
  /**
@@ -45436,7 +45944,7 @@ class UsersApi {
45436
45944
  /**
45437
45945
  * Users service.
45438
45946
  * @module purecloud-platform-client-v2/api/UsersApi
45439
- * @version 127.0.0
45947
+ * @version 131.0.0
45440
45948
  */
45441
45949
 
45442
45950
  /**
@@ -47738,7 +48246,7 @@ class UtilitiesApi {
47738
48246
  /**
47739
48247
  * Utilities service.
47740
48248
  * @module purecloud-platform-client-v2/api/UtilitiesApi
47741
- * @version 127.0.0
48249
+ * @version 131.0.0
47742
48250
  */
47743
48251
 
47744
48252
  /**
@@ -47774,7 +48282,7 @@ class UtilitiesApi {
47774
48282
  }
47775
48283
 
47776
48284
  /**
47777
- * Get public ip address ranges for PureCloud
48285
+ * Get public ip address ranges for Genesys Cloud
47778
48286
  *
47779
48287
  */
47780
48288
  getIpranges() {
@@ -47849,7 +48357,7 @@ class VoicemailApi {
47849
48357
  /**
47850
48358
  * Voicemail service.
47851
48359
  * @module purecloud-platform-client-v2/api/VoicemailApi
47852
- * @version 127.0.0
48360
+ * @version 131.0.0
47853
48361
  */
47854
48362
 
47855
48363
  /**
@@ -48516,7 +49024,7 @@ class WebChatApi {
48516
49024
  /**
48517
49025
  * WebChat service.
48518
49026
  * @module purecloud-platform-client-v2/api/WebChatApi
48519
- * @version 127.0.0
49027
+ * @version 131.0.0
48520
49028
  */
48521
49029
 
48522
49030
  /**
@@ -49060,7 +49568,7 @@ class WebDeploymentsApi {
49060
49568
  /**
49061
49569
  * WebDeployments service.
49062
49570
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
49063
- * @version 127.0.0
49571
+ * @version 131.0.0
49064
49572
  */
49065
49573
 
49066
49574
  /**
@@ -49415,7 +49923,7 @@ class WebMessagingApi {
49415
49923
  /**
49416
49924
  * WebMessaging service.
49417
49925
  * @module purecloud-platform-client-v2/api/WebMessagingApi
49418
- * @version 127.0.0
49926
+ * @version 131.0.0
49419
49927
  */
49420
49928
 
49421
49929
  /**
@@ -49461,7 +49969,7 @@ class WidgetsApi {
49461
49969
  /**
49462
49970
  * Widgets service.
49463
49971
  * @module purecloud-platform-client-v2/api/WidgetsApi
49464
- * @version 127.0.0
49972
+ * @version 131.0.0
49465
49973
  */
49466
49974
 
49467
49975
  /**
@@ -49607,7 +50115,7 @@ class WorkforceManagementApi {
49607
50115
  /**
49608
50116
  * WorkforceManagement service.
49609
50117
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
49610
- * @version 127.0.0
50118
+ * @version 131.0.0
49611
50119
  */
49612
50120
 
49613
50121
  /**
@@ -53638,7 +54146,7 @@ class WorkforceManagementApi {
53638
54146
  * </pre>
53639
54147
  * </p>
53640
54148
  * @module purecloud-platform-client-v2/index
53641
- * @version 127.0.0
54149
+ * @version 131.0.0
53642
54150
  */
53643
54151
  class platformClient {
53644
54152
  constructor() {
@@ -53792,6 +54300,11 @@ class platformClient {
53792
54300
  * @property {module:purecloud-platform-client-v2/api/LocationsApi}
53793
54301
  */
53794
54302
  this.LocationsApi = LocationsApi;
54303
+ /**
54304
+ * The MessagingApi service constructor.
54305
+ * @property {module:purecloud-platform-client-v2/api/MessagingApi}
54306
+ */
54307
+ this.MessagingApi = MessagingApi;
53795
54308
  /**
53796
54309
  * The MobileDevicesApi service constructor.
53797
54310
  * @property {module:purecloud-platform-client-v2/api/MobileDevicesApi}