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
@@ -391,7 +391,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
391
391
 
392
392
  /**
393
393
  * @module purecloud-platform-client-v2/ApiClient
394
- * @version 127.0.0
394
+ * @version 131.0.0
395
395
  */
396
396
  class ApiClient {
397
397
  /**
@@ -1338,7 +1338,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
1338
1338
 
1339
1339
  // set header parameters
1340
1340
  request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
1341
- //request.set({ 'purecloud-sdk': '127.0.0' });
1341
+ //request.set({ 'purecloud-sdk': '131.0.0' });
1342
1342
 
1343
1343
  // set request timeout
1344
1344
  request.timeout(that.timeout);
@@ -1438,7 +1438,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
1438
1438
  /**
1439
1439
  * Alerting service.
1440
1440
  * @module purecloud-platform-client-v2/api/AlertingApi
1441
- * @version 127.0.0
1441
+ * @version 131.0.0
1442
1442
  */
1443
1443
 
1444
1444
  /**
@@ -1752,7 +1752,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
1752
1752
  /**
1753
1753
  * Analytics service.
1754
1754
  * @module purecloud-platform-client-v2/api/AnalyticsApi
1755
- * @version 127.0.0
1755
+ * @version 131.0.0
1756
1756
  */
1757
1757
 
1758
1758
  /**
@@ -2889,7 +2889,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2889
2889
  /**
2890
2890
  * Architect service.
2891
2891
  * @module purecloud-platform-client-v2/api/ArchitectApi
2892
- * @version 127.0.0
2892
+ * @version 131.0.0
2893
2893
  */
2894
2894
 
2895
2895
  /**
@@ -5885,7 +5885,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
5885
5885
  /**
5886
5886
  * Audit service.
5887
5887
  * @module purecloud-platform-client-v2/api/AuditApi
5888
- * @version 127.0.0
5888
+ * @version 131.0.0
5889
5889
  */
5890
5890
 
5891
5891
  /**
@@ -6056,7 +6056,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
6056
6056
  /**
6057
6057
  * Authorization service.
6058
6058
  * @module purecloud-platform-client-v2/api/AuthorizationApi
6059
- * @version 127.0.0
6059
+ * @version 131.0.0
6060
6060
  */
6061
6061
 
6062
6062
  /**
@@ -7239,7 +7239,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
7239
7239
  /**
7240
7240
  * Billing service.
7241
7241
  * @module purecloud-platform-client-v2/api/BillingApi
7242
- * @version 127.0.0
7242
+ * @version 131.0.0
7243
7243
  */
7244
7244
 
7245
7245
  /**
@@ -7319,7 +7319,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
7319
7319
  /**
7320
7320
  * Chat service.
7321
7321
  * @module purecloud-platform-client-v2/api/ChatApi
7322
- * @version 127.0.0
7322
+ * @version 131.0.0
7323
7323
  */
7324
7324
 
7325
7325
  /**
@@ -7410,7 +7410,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
7410
7410
  /**
7411
7411
  * Coaching service.
7412
7412
  * @module purecloud-platform-client-v2/api/CoachingApi
7413
- * @version 127.0.0
7413
+ * @version 131.0.0
7414
7414
  */
7415
7415
 
7416
7416
  /**
@@ -7609,6 +7609,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
7609
7609
  * @param {Array.<String>} opts.relationships Relationships to filter by
7610
7610
  * @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
7611
7611
  * @param {Object} opts.overdue Overdue status to filter by
7612
+ * @param {Object} opts.intervalCondition Filter condition for interval
7612
7613
  */
7613
7614
  getCoachingAppointments(userIds, opts) {
7614
7615
  opts = opts || {};
@@ -7622,7 +7623,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
7622
7623
  '/api/v2/coaching/appointments',
7623
7624
  'GET',
7624
7625
  { },
7625
- { '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'] },
7626
+ { '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'] },
7626
7627
  { },
7627
7628
  { },
7628
7629
  null,
@@ -7645,6 +7646,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
7645
7646
  * @param {Array.<String>} opts.relationships Relationships to filter by
7646
7647
  * @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
7647
7648
  * @param {Object} opts.overdue Overdue status to filter by
7649
+ * @param {Object} opts.intervalCondition Filter condition for interval
7648
7650
  */
7649
7651
  getCoachingAppointmentsMe(opts) {
7650
7652
  opts = opts || {};
@@ -7654,7 +7656,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
7654
7656
  '/api/v2/coaching/appointments/me',
7655
7657
  'GET',
7656
7658
  { },
7657
- { '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'] },
7659
+ { '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'] },
7658
7660
  { },
7659
7661
  { },
7660
7662
  null,
@@ -7985,7 +7987,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
7985
7987
  /**
7986
7988
  * ContentManagement service.
7987
7989
  * @module purecloud-platform-client-v2/api/ContentManagementApi
7988
- * @version 127.0.0
7990
+ * @version 131.0.0
7989
7991
  */
7990
7992
 
7991
7993
  /**
@@ -9125,7 +9127,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9125
9127
  /**
9126
9128
  * Conversations service.
9127
9129
  * @module purecloud-platform-client-v2/api/ConversationsApi
9128
- * @version 127.0.0
9130
+ * @version 131.0.0
9129
9131
  */
9130
9132
 
9131
9133
  /**
@@ -9415,6 +9417,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9415
9417
  );
9416
9418
  }
9417
9419
 
9420
+ /**
9421
+ * Delete a supported content profile
9422
+ *
9423
+ * @param {String} supportedContentId Supported Content ID
9424
+ */
9425
+ deleteConversationsMessagingSupportedcontentSupportedContentId(supportedContentId) {
9426
+ // verify the required parameter 'supportedContentId' is set
9427
+ if (supportedContentId === undefined || supportedContentId === null) {
9428
+ throw 'Missing the required parameter "supportedContentId" when calling deleteConversationsMessagingSupportedcontentSupportedContentId';
9429
+ }
9430
+
9431
+ return this.apiClient.callApi(
9432
+ '/api/v2/conversations/messaging/supportedcontent/{supportedContentId}',
9433
+ 'DELETE',
9434
+ { 'supportedContentId': supportedContentId },
9435
+ { },
9436
+ { },
9437
+ { },
9438
+ null,
9439
+ ['PureCloud OAuth'],
9440
+ ['application/json'],
9441
+ ['application/json']
9442
+ );
9443
+ }
9444
+
9418
9445
  /**
9419
9446
  * Get a conversation by id
9420
9447
  *
@@ -11007,6 +11034,76 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11007
11034
  );
11008
11035
  }
11009
11036
 
11037
+ /**
11038
+ * Get a list of Supported Content profiles
11039
+ *
11040
+ * @param {Object} opts Optional parameters
11041
+ * @param {Number} opts.pageSize Page size (default to 25)
11042
+ * @param {Number} opts.pageNumber Page number (default to 1)
11043
+ */
11044
+ getConversationsMessagingSupportedcontent(opts) {
11045
+ opts = opts || {};
11046
+
11047
+
11048
+ return this.apiClient.callApi(
11049
+ '/api/v2/conversations/messaging/supportedcontent',
11050
+ 'GET',
11051
+ { },
11052
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
11053
+ { },
11054
+ { },
11055
+ null,
11056
+ ['PureCloud OAuth'],
11057
+ ['application/json'],
11058
+ ['application/json']
11059
+ );
11060
+ }
11061
+
11062
+ /**
11063
+ * Get the organization&#39;s default supported content profile that will be used as the default when creating an integration.
11064
+ * 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.
11065
+ */
11066
+ getConversationsMessagingSupportedcontentDefault() {
11067
+
11068
+ return this.apiClient.callApi(
11069
+ '/api/v2/conversations/messaging/supportedcontent/default',
11070
+ 'GET',
11071
+ { },
11072
+ { },
11073
+ { },
11074
+ { },
11075
+ null,
11076
+ ['PureCloud OAuth'],
11077
+ ['application/json'],
11078
+ ['application/json']
11079
+ );
11080
+ }
11081
+
11082
+ /**
11083
+ * Get a supported content profile
11084
+ *
11085
+ * @param {String} supportedContentId Supported Content ID
11086
+ */
11087
+ getConversationsMessagingSupportedcontentSupportedContentId(supportedContentId) {
11088
+ // verify the required parameter 'supportedContentId' is set
11089
+ if (supportedContentId === undefined || supportedContentId === null) {
11090
+ throw 'Missing the required parameter "supportedContentId" when calling getConversationsMessagingSupportedcontentSupportedContentId';
11091
+ }
11092
+
11093
+ return this.apiClient.callApi(
11094
+ '/api/v2/conversations/messaging/supportedcontent/{supportedContentId}',
11095
+ 'GET',
11096
+ { 'supportedContentId': supportedContentId },
11097
+ { },
11098
+ { },
11099
+ { },
11100
+ null,
11101
+ ['PureCloud OAuth'],
11102
+ ['application/json'],
11103
+ ['application/json']
11104
+ );
11105
+ }
11106
+
11010
11107
  /**
11011
11108
  * Get conversation threading window timeline for each messaging type
11012
11109
  * 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.
@@ -12088,6 +12185,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
12088
12185
  );
12089
12186
  }
12090
12187
 
12188
+ /**
12189
+ * Update a supported content profile
12190
+ *
12191
+ * @param {String} supportedContentId Supported Content ID
12192
+ * @param {Object} body SupportedContent
12193
+ */
12194
+ patchConversationsMessagingSupportedcontentSupportedContentId(supportedContentId, body) {
12195
+ // verify the required parameter 'supportedContentId' is set
12196
+ if (supportedContentId === undefined || supportedContentId === null) {
12197
+ throw 'Missing the required parameter "supportedContentId" when calling patchConversationsMessagingSupportedcontentSupportedContentId';
12198
+ }
12199
+ // verify the required parameter 'body' is set
12200
+ if (body === undefined || body === null) {
12201
+ throw 'Missing the required parameter "body" when calling patchConversationsMessagingSupportedcontentSupportedContentId';
12202
+ }
12203
+
12204
+ return this.apiClient.callApi(
12205
+ '/api/v2/conversations/messaging/supportedcontent/{supportedContentId}',
12206
+ 'PATCH',
12207
+ { 'supportedContentId': supportedContentId },
12208
+ { },
12209
+ { },
12210
+ { },
12211
+ body,
12212
+ ['PureCloud OAuth'],
12213
+ ['application/json'],
12214
+ ['application/json']
12215
+ );
12216
+ }
12217
+
12091
12218
  /**
12092
12219
  * Index conversation properties
12093
12220
  *
@@ -13323,6 +13450,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
13323
13450
  );
13324
13451
  }
13325
13452
 
13453
+ /**
13454
+ * Create a Supported Content profile
13455
+ *
13456
+ * @param {Object} body SupportedContent
13457
+ */
13458
+ postConversationsMessagingSupportedcontent(body) {
13459
+ // verify the required parameter 'body' is set
13460
+ if (body === undefined || body === null) {
13461
+ throw 'Missing the required parameter "body" when calling postConversationsMessagingSupportedcontent';
13462
+ }
13463
+
13464
+ return this.apiClient.callApi(
13465
+ '/api/v2/conversations/messaging/supportedcontent',
13466
+ 'POST',
13467
+ { },
13468
+ { },
13469
+ { },
13470
+ { },
13471
+ body,
13472
+ ['PureCloud OAuth'],
13473
+ ['application/json'],
13474
+ ['application/json']
13475
+ );
13476
+ }
13477
+
13326
13478
  /**
13327
13479
  * Set flagged reason on conversation participant to indicate bad conversation quality.
13328
13480
  *
@@ -13483,6 +13635,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
13483
13635
  );
13484
13636
  }
13485
13637
 
13638
+ /**
13639
+ * Set the organization&#39;s default supported content profile that may be assigned to an integration when it is created.
13640
+ * 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.
13641
+ * @param {Object} body SupportedContent
13642
+ */
13643
+ putConversationsMessagingSupportedcontentDefault(body) {
13644
+ // verify the required parameter 'body' is set
13645
+ if (body === undefined || body === null) {
13646
+ throw 'Missing the required parameter "body" when calling putConversationsMessagingSupportedcontentDefault';
13647
+ }
13648
+
13649
+ return this.apiClient.callApi(
13650
+ '/api/v2/conversations/messaging/supportedcontent/default',
13651
+ 'PUT',
13652
+ { },
13653
+ { },
13654
+ { },
13655
+ { },
13656
+ body,
13657
+ ['PureCloud OAuth'],
13658
+ ['application/json'],
13659
+ ['application/json']
13660
+ );
13661
+ }
13662
+
13486
13663
  /**
13487
13664
  * Update conversation threading window timeline for each messaging type
13488
13665
  * 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.
@@ -13514,7 +13691,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
13514
13691
  /**
13515
13692
  * DataExtensions service.
13516
13693
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
13517
- * @version 127.0.0
13694
+ * @version 131.0.0
13518
13695
  */
13519
13696
 
13520
13697
  /**
@@ -13600,7 +13777,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
13600
13777
  /**
13601
13778
  * ExternalContacts service.
13602
13779
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
13603
- * @version 127.0.0
13780
+ * @version 131.0.0
13604
13781
  */
13605
13782
 
13606
13783
  /**
@@ -15343,7 +15520,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15343
15520
  /**
15344
15521
  * Fax service.
15345
15522
  * @module purecloud-platform-client-v2/api/FaxApi
15346
- * @version 127.0.0
15523
+ * @version 131.0.0
15347
15524
  */
15348
15525
 
15349
15526
  /**
@@ -15514,7 +15691,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15514
15691
  /**
15515
15692
  * Flows service.
15516
15693
  * @module purecloud-platform-client-v2/api/FlowsApi
15517
- * @version 127.0.0
15694
+ * @version 131.0.0
15518
15695
  */
15519
15696
 
15520
15697
  /**
@@ -15585,7 +15762,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15585
15762
  /**
15586
15763
  * Gamification service.
15587
15764
  * @module purecloud-platform-client-v2/api/GamificationApi
15588
- * @version 127.0.0
15765
+ * @version 131.0.0
15589
15766
  */
15590
15767
 
15591
15768
  /**
@@ -15853,6 +16030,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15853
16030
  );
15854
16031
  }
15855
16032
 
16033
+ /**
16034
+ * Members of a given performance profile
16035
+ *
16036
+ * @param {String} performanceProfileId Performance Profile Id
16037
+ */
16038
+ getGamificationProfileMembers(performanceProfileId) {
16039
+ // verify the required parameter 'performanceProfileId' is set
16040
+ if (performanceProfileId === undefined || performanceProfileId === null) {
16041
+ throw 'Missing the required parameter "performanceProfileId" when calling getGamificationProfileMembers';
16042
+ }
16043
+
16044
+ return this.apiClient.callApi(
16045
+ '/api/v2/gamification/profiles/{performanceProfileId}/members',
16046
+ 'GET',
16047
+ { 'performanceProfileId': performanceProfileId },
16048
+ { },
16049
+ { },
16050
+ { },
16051
+ null,
16052
+ ['PureCloud OAuth'],
16053
+ ['application/json'],
16054
+ ['application/json']
16055
+ );
16056
+ }
16057
+
15856
16058
  /**
15857
16059
  * Performance profile gamified metric by id
15858
16060
  *
@@ -16707,6 +16909,101 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
16707
16909
  );
16708
16910
  }
16709
16911
 
16912
+ /**
16913
+ * Assign members to a given performance profile
16914
+ *
16915
+ * @param {String} performanceProfileId Performance Profile Id
16916
+ * @param {Object} body assignUsers
16917
+ */
16918
+ postGamificationProfileMembers(performanceProfileId, body) {
16919
+ // verify the required parameter 'performanceProfileId' is set
16920
+ if (performanceProfileId === undefined || performanceProfileId === null) {
16921
+ throw 'Missing the required parameter "performanceProfileId" when calling postGamificationProfileMembers';
16922
+ }
16923
+ // verify the required parameter 'body' is set
16924
+ if (body === undefined || body === null) {
16925
+ throw 'Missing the required parameter "body" when calling postGamificationProfileMembers';
16926
+ }
16927
+
16928
+ return this.apiClient.callApi(
16929
+ '/api/v2/gamification/profiles/{performanceProfileId}/members',
16930
+ 'POST',
16931
+ { 'performanceProfileId': performanceProfileId },
16932
+ { },
16933
+ { },
16934
+ { },
16935
+ body,
16936
+ ['PureCloud OAuth'],
16937
+ ['application/json'],
16938
+ ['application/json']
16939
+ );
16940
+ }
16941
+
16942
+ /**
16943
+ * Validate member assignment
16944
+ *
16945
+ * @param {String} performanceProfileId Performance Profile Id
16946
+ * @param {Object} body memberAssignments
16947
+ */
16948
+ postGamificationProfileMembersValidate(performanceProfileId, body) {
16949
+ // verify the required parameter 'performanceProfileId' is set
16950
+ if (performanceProfileId === undefined || performanceProfileId === null) {
16951
+ throw 'Missing the required parameter "performanceProfileId" when calling postGamificationProfileMembersValidate';
16952
+ }
16953
+ // verify the required parameter 'body' is set
16954
+ if (body === undefined || body === null) {
16955
+ throw 'Missing the required parameter "body" when calling postGamificationProfileMembersValidate';
16956
+ }
16957
+
16958
+ return this.apiClient.callApi(
16959
+ '/api/v2/gamification/profiles/{performanceProfileId}/members/validate',
16960
+ 'POST',
16961
+ { 'performanceProfileId': performanceProfileId },
16962
+ { },
16963
+ { },
16964
+ { },
16965
+ body,
16966
+ ['PureCloud OAuth'],
16967
+ ['application/json'],
16968
+ ['application/json']
16969
+ );
16970
+ }
16971
+
16972
+ /**
16973
+ * Creates a linked metric
16974
+ *
16975
+ * @param {String} sourceProfileId Source Performance Profile Id
16976
+ * @param {String} sourceMetricId Source Metric Id
16977
+ * @param {Object} body linkedMetric
16978
+ */
16979
+ postGamificationProfileMetricLink(sourceProfileId, sourceMetricId, body) {
16980
+ // verify the required parameter 'sourceProfileId' is set
16981
+ if (sourceProfileId === undefined || sourceProfileId === null) {
16982
+ throw 'Missing the required parameter "sourceProfileId" when calling postGamificationProfileMetricLink';
16983
+ }
16984
+ // verify the required parameter 'sourceMetricId' is set
16985
+ if (sourceMetricId === undefined || sourceMetricId === null) {
16986
+ throw 'Missing the required parameter "sourceMetricId" when calling postGamificationProfileMetricLink';
16987
+ }
16988
+ // verify the required parameter 'body' is set
16989
+ if (body === undefined || body === null) {
16990
+ throw 'Missing the required parameter "body" when calling postGamificationProfileMetricLink';
16991
+ }
16992
+
16993
+ return this.apiClient.callApi(
16994
+ '/api/v2/gamification/profiles/{sourceProfileId}/metrics/{sourceMetricId}/link',
16995
+ 'POST',
16996
+ { 'sourceProfileId': sourceProfileId,'sourceMetricId': sourceMetricId },
16997
+ { },
16998
+ { },
16999
+ { },
17000
+ body,
17001
+ ['PureCloud OAuth'],
17002
+ ['application/json'],
17003
+ ['application/json']
17004
+ );
17005
+ }
17006
+
16710
17007
  /**
16711
17008
  * Creates a gamified metric with a given metric definition and metric objective under in a performance profile
16712
17009
  *
@@ -16891,7 +17188,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
16891
17188
  /**
16892
17189
  * GeneralDataProtectionRegulation service.
16893
17190
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
16894
- * @version 127.0.0
17191
+ * @version 131.0.0
16895
17192
  */
16896
17193
 
16897
17194
  /**
@@ -17021,7 +17318,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17021
17318
  /**
17022
17319
  * Geolocation service.
17023
17320
  * @module purecloud-platform-client-v2/api/GeolocationApi
17024
- * @version 127.0.0
17321
+ * @version 131.0.0
17025
17322
  */
17026
17323
 
17027
17324
  /**
@@ -17152,7 +17449,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17152
17449
  /**
17153
17450
  * Greetings service.
17154
17451
  * @module purecloud-platform-client-v2/api/GreetingsApi
17155
- * @version 127.0.0
17452
+ * @version 131.0.0
17156
17453
  */
17157
17454
 
17158
17455
  /**
@@ -17607,7 +17904,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17607
17904
  /**
17608
17905
  * Groups service.
17609
17906
  * @module purecloud-platform-client-v2/api/GroupsApi
17610
- * @version 127.0.0
17907
+ * @version 131.0.0
17611
17908
  */
17612
17909
 
17613
17910
  /**
@@ -18012,7 +18309,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
18012
18309
  /**
18013
18310
  * IdentityProvider service.
18014
18311
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
18015
- * @version 127.0.0
18312
+ * @version 131.0.0
18016
18313
  */
18017
18314
 
18018
18315
  /**
@@ -18768,7 +19065,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
18768
19065
  /**
18769
19066
  * Integrations service.
18770
19067
  * @module purecloud-platform-client-v2/api/IntegrationsApi
18771
- * @version 127.0.0
19068
+ * @version 131.0.0
18772
19069
  */
18773
19070
 
18774
19071
  /**
@@ -19425,6 +19722,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19425
19722
  );
19426
19723
  }
19427
19724
 
19725
+ /**
19726
+ * UC integration client application configuration.
19727
+ * This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled for the current organization.
19728
+ * @param {Object} opts Optional parameters
19729
+ * @param {Number} opts.pageSize The total page size requested (default to 25)
19730
+ * @param {Number} opts.pageNumber The page number requested (default to 1)
19731
+ * @param {String} opts.sortBy variable name requested to sort by
19732
+ * @param {Array.<String>} opts.expand variable name requested by expand list
19733
+ * @param {String} opts.nextPage next page token
19734
+ * @param {String} opts.previousPage Previous page token
19735
+ */
19736
+ getIntegrationsClientappsUnifiedcommunications(opts) {
19737
+ opts = opts || {};
19738
+
19739
+
19740
+ return this.apiClient.callApi(
19741
+ '/api/v2/integrations/clientapps/unifiedcommunications',
19742
+ 'GET',
19743
+ { },
19744
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'] },
19745
+ { },
19746
+ { },
19747
+ null,
19748
+ ['PureCloud OAuth'],
19749
+ ['application/json'],
19750
+ ['application/json']
19751
+ );
19752
+ }
19753
+
19428
19754
  /**
19429
19755
  * Get a single credential with sensitive fields redacted
19430
19756
  *
@@ -20414,7 +20740,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20414
20740
  /**
20415
20741
  * Journey service.
20416
20742
  * @module purecloud-platform-client-v2/api/JourneyApi
20417
- * @version 127.0.0
20743
+ * @version 131.0.0
20418
20744
  */
20419
20745
 
20420
20746
  /**
@@ -21125,7 +21451,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21125
21451
  /**
21126
21452
  * Knowledge service.
21127
21453
  * @module purecloud-platform-client-v2/api/KnowledgeApi
21128
- * @version 127.0.0
21454
+ * @version 131.0.0
21129
21455
  */
21130
21456
 
21131
21457
  /**
@@ -22025,7 +22351,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22025
22351
  /**
22026
22352
  * LanguageUnderstanding service.
22027
22353
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
22028
- * @version 127.0.0
22354
+ * @version 131.0.0
22029
22355
  */
22030
22356
 
22031
22357
  /**
@@ -22929,7 +23255,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22929
23255
  /**
22930
23256
  * Languages service.
22931
23257
  * @module purecloud-platform-client-v2/api/LanguagesApi
22932
- * @version 127.0.0
23258
+ * @version 131.0.0
22933
23259
  */
22934
23260
 
22935
23261
  /**
@@ -23197,7 +23523,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23197
23523
  /**
23198
23524
  * Learning service.
23199
23525
  * @module purecloud-platform-client-v2/api/LearningApi
23200
- * @version 127.0.0
23526
+ * @version 131.0.0
23201
23527
  */
23202
23528
 
23203
23529
  /**
@@ -23788,7 +24114,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23788
24114
  /**
23789
24115
  * License service.
23790
24116
  * @module purecloud-platform-client-v2/api/LicenseApi
23791
- * @version 127.0.0
24117
+ * @version 131.0.0
23792
24118
  */
23793
24119
 
23794
24120
  /**
@@ -24026,7 +24352,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24026
24352
  /**
24027
24353
  * Locations service.
24028
24354
  * @module purecloud-platform-client-v2/api/LocationsApi
24029
- * @version 127.0.0
24355
+ * @version 131.0.0
24030
24356
  */
24031
24357
 
24032
24358
  /**
@@ -24258,11 +24584,162 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24258
24584
 
24259
24585
  }
24260
24586
 
24587
+ class MessagingApi {
24588
+ /**
24589
+ * Messaging service.
24590
+ * @module purecloud-platform-client-v2/api/MessagingApi
24591
+ * @version 131.0.0
24592
+ */
24593
+
24594
+ /**
24595
+ * Constructs a new MessagingApi.
24596
+ * @alias module:purecloud-platform-client-v2/api/MessagingApi
24597
+ * @class
24598
+ * @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
24599
+ * default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
24600
+ */
24601
+ constructor(apiClient) {
24602
+ this.apiClient = apiClient || ApiClient.instance;
24603
+ }
24604
+
24605
+
24606
+ /**
24607
+ * Delete a supported content profile
24608
+ *
24609
+ * @param {String} supportedContentId Supported Content ID
24610
+ */
24611
+ deleteMessagingSupportedcontentSupportedContentId(supportedContentId) {
24612
+ // verify the required parameter 'supportedContentId' is set
24613
+ if (supportedContentId === undefined || supportedContentId === null) {
24614
+ throw 'Missing the required parameter "supportedContentId" when calling deleteMessagingSupportedcontentSupportedContentId';
24615
+ }
24616
+
24617
+ return this.apiClient.callApi(
24618
+ '/api/v2/messaging/supportedcontent/{supportedContentId}',
24619
+ 'DELETE',
24620
+ { 'supportedContentId': supportedContentId },
24621
+ { },
24622
+ { },
24623
+ { },
24624
+ null,
24625
+ ['PureCloud OAuth'],
24626
+ ['application/json'],
24627
+ ['application/json']
24628
+ );
24629
+ }
24630
+
24631
+ /**
24632
+ * Get a list of Supported Content profiles
24633
+ *
24634
+ * @param {Object} opts Optional parameters
24635
+ * @param {Number} opts.pageSize Page size (default to 25)
24636
+ * @param {Number} opts.pageNumber Page number (default to 1)
24637
+ */
24638
+ getMessagingSupportedcontent(opts) {
24639
+ opts = opts || {};
24640
+
24641
+
24642
+ return this.apiClient.callApi(
24643
+ '/api/v2/messaging/supportedcontent',
24644
+ 'GET',
24645
+ { },
24646
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
24647
+ { },
24648
+ { },
24649
+ null,
24650
+ ['PureCloud OAuth'],
24651
+ ['application/json'],
24652
+ ['application/json']
24653
+ );
24654
+ }
24655
+
24656
+ /**
24657
+ * Get a supported content profile
24658
+ *
24659
+ * @param {String} supportedContentId Supported Content ID
24660
+ */
24661
+ getMessagingSupportedcontentSupportedContentId(supportedContentId) {
24662
+ // verify the required parameter 'supportedContentId' is set
24663
+ if (supportedContentId === undefined || supportedContentId === null) {
24664
+ throw 'Missing the required parameter "supportedContentId" when calling getMessagingSupportedcontentSupportedContentId';
24665
+ }
24666
+
24667
+ return this.apiClient.callApi(
24668
+ '/api/v2/messaging/supportedcontent/{supportedContentId}',
24669
+ 'GET',
24670
+ { 'supportedContentId': supportedContentId },
24671
+ { },
24672
+ { },
24673
+ { },
24674
+ null,
24675
+ ['PureCloud OAuth'],
24676
+ ['application/json'],
24677
+ ['application/json']
24678
+ );
24679
+ }
24680
+
24681
+ /**
24682
+ * Update a supported content profile
24683
+ *
24684
+ * @param {String} supportedContentId Supported Content ID
24685
+ * @param {Object} body SupportedContent
24686
+ */
24687
+ patchMessagingSupportedcontentSupportedContentId(supportedContentId, body) {
24688
+ // verify the required parameter 'supportedContentId' is set
24689
+ if (supportedContentId === undefined || supportedContentId === null) {
24690
+ throw 'Missing the required parameter "supportedContentId" when calling patchMessagingSupportedcontentSupportedContentId';
24691
+ }
24692
+ // verify the required parameter 'body' is set
24693
+ if (body === undefined || body === null) {
24694
+ throw 'Missing the required parameter "body" when calling patchMessagingSupportedcontentSupportedContentId';
24695
+ }
24696
+
24697
+ return this.apiClient.callApi(
24698
+ '/api/v2/messaging/supportedcontent/{supportedContentId}',
24699
+ 'PATCH',
24700
+ { 'supportedContentId': supportedContentId },
24701
+ { },
24702
+ { },
24703
+ { },
24704
+ body,
24705
+ ['PureCloud OAuth'],
24706
+ ['application/json'],
24707
+ ['application/json']
24708
+ );
24709
+ }
24710
+
24711
+ /**
24712
+ * Create a Supported Content profile
24713
+ *
24714
+ * @param {Object} body SupportedContent
24715
+ */
24716
+ postMessagingSupportedcontent(body) {
24717
+ // verify the required parameter 'body' is set
24718
+ if (body === undefined || body === null) {
24719
+ throw 'Missing the required parameter "body" when calling postMessagingSupportedcontent';
24720
+ }
24721
+
24722
+ return this.apiClient.callApi(
24723
+ '/api/v2/messaging/supportedcontent',
24724
+ 'POST',
24725
+ { },
24726
+ { },
24727
+ { },
24728
+ { },
24729
+ body,
24730
+ ['PureCloud OAuth'],
24731
+ ['application/json'],
24732
+ ['application/json']
24733
+ );
24734
+ }
24735
+
24736
+ }
24737
+
24261
24738
  class MobileDevicesApi {
24262
24739
  /**
24263
24740
  * MobileDevices service.
24264
24741
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
24265
- * @version 127.0.0
24742
+ * @version 131.0.0
24266
24743
  */
24267
24744
 
24268
24745
  /**
@@ -24413,7 +24890,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24413
24890
  /**
24414
24891
  * Notifications service.
24415
24892
  * @module purecloud-platform-client-v2/api/NotificationsApi
24416
- * @version 127.0.0
24893
+ * @version 131.0.0
24417
24894
  */
24418
24895
 
24419
24896
  /**
@@ -24638,7 +25115,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24638
25115
  /**
24639
25116
  * OAuth service.
24640
25117
  * @module purecloud-platform-client-v2/api/OAuthApi
24641
- * @version 127.0.0
25118
+ * @version 131.0.0
24642
25119
  */
24643
25120
 
24644
25121
  /**
@@ -24996,7 +25473,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24996
25473
  /**
24997
25474
  * Objects service.
24998
25475
  * @module purecloud-platform-client-v2/api/ObjectsApi
24999
- * @version 127.0.0
25476
+ * @version 131.0.0
25000
25477
  */
25001
25478
 
25002
25479
  /**
@@ -25267,7 +25744,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25267
25744
  /**
25268
25745
  * Organization service.
25269
25746
  * @module purecloud-platform-client-v2/api/OrganizationApi
25270
- * @version 127.0.0
25747
+ * @version 131.0.0
25271
25748
  */
25272
25749
 
25273
25750
  /**
@@ -25670,7 +26147,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25670
26147
  /**
25671
26148
  * OrganizationAuthorization service.
25672
26149
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
25673
- * @version 127.0.0
26150
+ * @version 131.0.0
25674
26151
  */
25675
26152
 
25676
26153
  /**
@@ -26595,7 +27072,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26595
27072
  /**
26596
27073
  * Outbound service.
26597
27074
  * @module purecloud-platform-client-v2/api/OutboundApi
26598
- * @version 127.0.0
27075
+ * @version 131.0.0
26599
27076
  */
26600
27077
 
26601
27078
  /**
@@ -29621,7 +30098,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29621
30098
  /**
29622
30099
  * Presence service.
29623
30100
  * @module purecloud-platform-client-v2/api/PresenceApi
29624
- * @version 127.0.0
30101
+ * @version 131.0.0
29625
30102
  */
29626
30103
 
29627
30104
  /**
@@ -29993,7 +30470,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29993
30470
  /**
29994
30471
  * Quality service.
29995
30472
  * @module purecloud-platform-client-v2/api/QualityApi
29996
- * @version 127.0.0
30473
+ * @version 131.0.0
29997
30474
  */
29998
30475
 
29999
30476
  /**
@@ -31521,7 +31998,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
31521
31998
  /**
31522
31999
  * Recording service.
31523
32000
  * @module purecloud-platform-client-v2/api/RecordingApi
31524
- * @version 127.0.0
32001
+ * @version 131.0.0
31525
32002
  */
31526
32003
 
31527
32004
  /**
@@ -31727,11 +32204,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
31727
32204
  * @param {String} conversationId Conversation ID
31728
32205
  * @param {String} recordingId Recording ID
31729
32206
  * @param {Object} opts Optional parameters
31730
- * @param {Object} opts.formatId The desired media format. (default to WEBM)
31731
- * @param {Object} opts.emailFormatId The desired media format when downloading an email recording. (default to EML)
31732
- * @param {Object} opts.chatFormatId The desired media format when downloading a chat recording. (default to ZIP)
31733
- * @param {Object} opts.messageFormatId The desired media format when downloading a message recording. (default to ZIP)
31734
- * @param {Boolean} opts.download requesting a download format of the recording (default to false)
32207
+ * @param {Object} opts.formatId The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE (default to WEBM)
32208
+ * @param {Object} opts.emailFormatId The desired media format when downloading an email recording. Valid values:EML,NONE (default to EML)
32209
+ * @param {Object} opts.chatFormatId The desired media format when downloading a chat recording. Valid values:ZIP,NONE (default to ZIP)
32210
+ * @param {Object} opts.messageFormatId The desired media format when downloading a message recording. Valid values:ZIP,NONE (default to ZIP)
32211
+ * @param {Boolean} opts.download requesting a download format of the recording. Valid values:true,false (default to false)
31735
32212
  * @param {String} opts.fileName the name of the downloaded fileName
31736
32213
  * @param {String} opts.locale The locale for the requested file when downloading, as an ISO 639-1 code
31737
32214
  */
@@ -31827,7 +32304,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
31827
32304
  }
31828
32305
 
31829
32306
  /**
31830
- * Get recording metadata for a conversation. Does not return playable media.
32307
+ * 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.
31831
32308
  *
31832
32309
  * @param {String} conversationId Conversation ID
31833
32310
  */
@@ -31887,7 +32364,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
31887
32364
  * @param {String} conversationId Conversation ID
31888
32365
  * @param {Object} opts Optional parameters
31889
32366
  * @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)
31890
- * @param {Object} opts.formatId The desired media format (default to WEBM)
32367
+ * @param {Object} opts.formatId The desired media format . Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. (default to WEBM)
31891
32368
  */
31892
32369
  getConversationRecordings(conversationId, opts) {
31893
32370
  opts = opts || {};
@@ -33044,7 +33521,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33044
33521
  /**
33045
33522
  * ResponseManagement service.
33046
33523
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
33047
- * @version 127.0.0
33524
+ * @version 131.0.0
33048
33525
  */
33049
33526
 
33050
33527
  /**
@@ -33369,7 +33846,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33369
33846
  /**
33370
33847
  * Routing service.
33371
33848
  * @module purecloud-platform-client-v2/api/RoutingApi
33372
- * @version 127.0.0
33849
+ * @version 131.0.0
33373
33850
  */
33374
33851
 
33375
33852
  /**
@@ -34807,10 +35284,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
34807
35284
  *
34808
35285
  * @param {Object} opts Optional parameters
34809
35286
  * @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.
34810
- * @param {Object} opts.phoneNumberType Filter on phone number type
34811
- * @param {Object} opts.phoneNumberStatus Filter on phone number status
35287
+ * @param {Array.<String>} opts.phoneNumberType Filter on phone number type
35288
+ * @param {Array.<String>} opts.phoneNumberStatus Filter on phone number status
35289
+ * @param {Array.<String>} opts.countryCode Filter on country code
34812
35290
  * @param {Number} opts.pageSize Page size (default to 25)
34813
35291
  * @param {Number} opts.pageNumber Page number (default to 1)
35292
+ * @param {Object} opts.sortBy Optional field to sort results
35293
+ * @param {Object} opts.sortOrder Sort order
35294
+ * @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)
34814
35295
  */
34815
35296
  getRoutingSmsPhonenumbers(opts) {
34816
35297
  opts = opts || {};
@@ -34820,7 +35301,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
34820
35301
  '/api/v2/routing/sms/phonenumbers',
34821
35302
  'GET',
34822
35303
  { },
34823
- { 'phoneNumber': opts['phoneNumber'],'phoneNumberType': opts['phoneNumberType'],'phoneNumberStatus': opts['phoneNumberStatus'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
35304
+ { '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'] },
34824
35305
  { },
34825
35306
  { },
34826
35307
  null,
@@ -36288,7 +36769,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36288
36769
  /**
36289
36770
  * SCIM service.
36290
36771
  * @module purecloud-platform-client-v2/api/SCIMApi
36291
- * @version 127.0.0
36772
+ * @version 131.0.0
36292
36773
  */
36293
36774
 
36294
36775
  /**
@@ -37165,7 +37646,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37165
37646
  /**
37166
37647
  * Scripts service.
37167
37648
  * @module purecloud-platform-client-v2/api/ScriptsApi
37168
- * @version 127.0.0
37649
+ * @version 131.0.0
37169
37650
  */
37170
37651
 
37171
37652
  /**
@@ -37518,7 +37999,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37518
37999
  /**
37519
38000
  * Search service.
37520
38001
  * @module purecloud-platform-client-v2/api/SearchApi
37521
- * @version 127.0.0
38002
+ * @version 131.0.0
37522
38003
  */
37523
38004
 
37524
38005
  /**
@@ -38053,7 +38534,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38053
38534
  /**
38054
38535
  * SpeechTextAnalytics service.
38055
38536
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
38056
- * @version 127.0.0
38537
+ * @version 131.0.0
38057
38538
  */
38058
38539
 
38059
38540
  /**
@@ -38222,26 +38703,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38222
38703
  );
38223
38704
  }
38224
38705
 
38225
- /**
38226
- * Get list of supported Speech &amp; Text Analytics dialects
38227
- * This api has been deprecated. Use api/v2/topics/dialects instead
38228
- */
38229
- getSpeechandtextanalyticsDialects() {
38230
-
38231
- return this.apiClient.callApi(
38232
- '/api/v2/speechandtextanalytics/dialects',
38233
- 'GET',
38234
- { },
38235
- { },
38236
- { },
38237
- { },
38238
- null,
38239
- ['PureCloud OAuth'],
38240
- ['application/json'],
38241
- ['application/json']
38242
- );
38243
- }
38244
-
38245
38706
  /**
38246
38707
  * Get a Speech &amp; Text Analytics program by id
38247
38708
  *
@@ -38926,7 +39387,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38926
39387
  /**
38927
39388
  * Stations service.
38928
39389
  * @module purecloud-platform-client-v2/api/StationsApi
38929
- * @version 127.0.0
39390
+ * @version 131.0.0
38930
39391
  */
38931
39392
 
38932
39393
  /**
@@ -39073,7 +39534,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39073
39534
  /**
39074
39535
  * Suggest service.
39075
39536
  * @module purecloud-platform-client-v2/api/SuggestApi
39076
- * @version 127.0.0
39537
+ * @version 131.0.0
39077
39538
  */
39078
39539
 
39079
39540
  /**
@@ -39212,7 +39673,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39212
39673
  /**
39213
39674
  * Telephony service.
39214
39675
  * @module purecloud-platform-client-v2/api/TelephonyApi
39215
- * @version 127.0.0
39676
+ * @version 131.0.0
39216
39677
  */
39217
39678
 
39218
39679
  /**
@@ -39320,7 +39781,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39320
39781
  /**
39321
39782
  * TelephonyProvidersEdge service.
39322
39783
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
39323
- * @version 127.0.0
39784
+ * @version 131.0.0
39324
39785
  */
39325
39786
 
39326
39787
  /**
@@ -40658,6 +41119,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
40658
41119
  );
40659
41120
  }
40660
41121
 
41122
+ /**
41123
+ * List of edges more than 4 edge versions behind the latest software.
41124
+ *
41125
+ */
41126
+ getTelephonyProvidersEdgesExpired() {
41127
+
41128
+ return this.apiClient.callApi(
41129
+ '/api/v2/telephony/providers/edges/expired',
41130
+ 'GET',
41131
+ { },
41132
+ { },
41133
+ { },
41134
+ { },
41135
+ null,
41136
+ ['PureCloud OAuth'],
41137
+ ['application/json'],
41138
+ ['application/json']
41139
+ );
41140
+ }
41141
+
40661
41142
  /**
40662
41143
  * Get an extension by ID.
40663
41144
  *
@@ -42933,7 +43414,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
42933
43414
  /**
42934
43415
  * Textbots service.
42935
43416
  * @module purecloud-platform-client-v2/api/TextbotsApi
42936
- * @version 127.0.0
43417
+ * @version 131.0.0
42937
43418
  */
42938
43419
 
42939
43420
  /**
@@ -42948,6 +43429,33 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
42948
43429
  }
42949
43430
 
42950
43431
 
43432
+ /**
43433
+ * Find bots using the currently configured friendly name or ID.
43434
+ * 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
43435
+ * @param {Object} opts Optional parameters
43436
+ * @param {Array.<String>} opts.botType Bot types
43437
+ * @param {String} opts.botName Bot name
43438
+ * @param {Array.<String>} opts.botId Bot IDs
43439
+ * @param {Number} opts.pageSize The maximum results to return (default to 25)
43440
+ */
43441
+ getTextbotsBotsSearch(opts) {
43442
+ opts = opts || {};
43443
+
43444
+
43445
+ return this.apiClient.callApi(
43446
+ '/api/v2/textbots/bots/search',
43447
+ 'GET',
43448
+ { },
43449
+ { 'botType': this.apiClient.buildCollectionParam(opts['botType'], 'multi'),'botName': opts['botName'],'botId': this.apiClient.buildCollectionParam(opts['botId'], 'multi'),'pageSize': opts['pageSize'] },
43450
+ { },
43451
+ { },
43452
+ null,
43453
+ ['PureCloud OAuth'],
43454
+ ['application/json'],
43455
+ ['application/json']
43456
+ );
43457
+ }
43458
+
42951
43459
  /**
42952
43460
  * Issue a bot flow turn event
42953
43461
  * Send a turn event to an executing bot flow and produce the next action to take.
@@ -43034,7 +43542,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
43034
43542
  /**
43035
43543
  * Tokens service.
43036
43544
  * @module purecloud-platform-client-v2/api/TokensApi
43037
- * @version 127.0.0
43545
+ * @version 131.0.0
43038
43546
  */
43039
43547
 
43040
43548
  /**
@@ -43140,7 +43648,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
43140
43648
  /**
43141
43649
  * Uploads service.
43142
43650
  * @module purecloud-platform-client-v2/api/UploadsApi
43143
- * @version 127.0.0
43651
+ * @version 131.0.0
43144
43652
  */
43145
43653
 
43146
43654
  /**
@@ -43316,7 +43824,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
43316
43824
  /**
43317
43825
  * Usage service.
43318
43826
  * @module purecloud-platform-client-v2/api/UsageApi
43319
- * @version 127.0.0
43827
+ * @version 131.0.0
43320
43828
  */
43321
43829
 
43322
43830
  /**
@@ -43387,7 +43895,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
43387
43895
  /**
43388
43896
  * UserRecordings service.
43389
43897
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
43390
- * @version 127.0.0
43898
+ * @version 131.0.0
43391
43899
  */
43392
43900
 
43393
43901
  /**
@@ -43571,7 +44079,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
43571
44079
  /**
43572
44080
  * Users service.
43573
44081
  * @module purecloud-platform-client-v2/api/UsersApi
43574
- * @version 127.0.0
44082
+ * @version 131.0.0
43575
44083
  */
43576
44084
 
43577
44085
  /**
@@ -45873,7 +46381,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45873
46381
  /**
45874
46382
  * Utilities service.
45875
46383
  * @module purecloud-platform-client-v2/api/UtilitiesApi
45876
- * @version 127.0.0
46384
+ * @version 131.0.0
45877
46385
  */
45878
46386
 
45879
46387
  /**
@@ -45909,7 +46417,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45909
46417
  }
45910
46418
 
45911
46419
  /**
45912
- * Get public ip address ranges for PureCloud
46420
+ * Get public ip address ranges for Genesys Cloud
45913
46421
  *
45914
46422
  */
45915
46423
  getIpranges() {
@@ -45984,7 +46492,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45984
46492
  /**
45985
46493
  * Voicemail service.
45986
46494
  * @module purecloud-platform-client-v2/api/VoicemailApi
45987
- * @version 127.0.0
46495
+ * @version 131.0.0
45988
46496
  */
45989
46497
 
45990
46498
  /**
@@ -46651,7 +47159,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46651
47159
  /**
46652
47160
  * WebChat service.
46653
47161
  * @module purecloud-platform-client-v2/api/WebChatApi
46654
- * @version 127.0.0
47162
+ * @version 131.0.0
46655
47163
  */
46656
47164
 
46657
47165
  /**
@@ -47195,7 +47703,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47195
47703
  /**
47196
47704
  * WebDeployments service.
47197
47705
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
47198
- * @version 127.0.0
47706
+ * @version 131.0.0
47199
47707
  */
47200
47708
 
47201
47709
  /**
@@ -47550,7 +48058,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47550
48058
  /**
47551
48059
  * WebMessaging service.
47552
48060
  * @module purecloud-platform-client-v2/api/WebMessagingApi
47553
- * @version 127.0.0
48061
+ * @version 131.0.0
47554
48062
  */
47555
48063
 
47556
48064
  /**
@@ -47596,7 +48104,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47596
48104
  /**
47597
48105
  * Widgets service.
47598
48106
  * @module purecloud-platform-client-v2/api/WidgetsApi
47599
- * @version 127.0.0
48107
+ * @version 131.0.0
47600
48108
  */
47601
48109
 
47602
48110
  /**
@@ -47742,7 +48250,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47742
48250
  /**
47743
48251
  * WorkforceManagement service.
47744
48252
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
47745
- * @version 127.0.0
48253
+ * @version 131.0.0
47746
48254
  */
47747
48255
 
47748
48256
  /**
@@ -51773,7 +52281,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51773
52281
  * </pre>
51774
52282
  * </p>
51775
52283
  * @module purecloud-platform-client-v2/index
51776
- * @version 127.0.0
52284
+ * @version 131.0.0
51777
52285
  */
51778
52286
  class platformClient {
51779
52287
  constructor() {
@@ -51927,6 +52435,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51927
52435
  * @property {module:purecloud-platform-client-v2/api/LocationsApi}
51928
52436
  */
51929
52437
  this.LocationsApi = LocationsApi;
52438
+ /**
52439
+ * The MessagingApi service constructor.
52440
+ * @property {module:purecloud-platform-client-v2/api/MessagingApi}
52441
+ */
52442
+ this.MessagingApi = MessagingApi;
51930
52443
  /**
51931
52444
  * The MobileDevicesApi service constructor.
51932
52445
  * @property {module:purecloud-platform-client-v2/api/MobileDevicesApi}