purecloud-platform-client-v2 166.0.0 → 168.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (79) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +747 -205
  3. package/dist/web-amd/purecloud-platform-client-v2.js +747 -205
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +747 -205
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +747 -205
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +885 -413
  9. package/package.json +7 -7
  10. package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
  11. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +3 -3
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +75 -0
  18. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +32 -1
  22. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +2 -2
  26. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/GamificationApi.js +470 -1
  29. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +69 -4
  35. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/OutboundApi.js +26 -1
  51. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/QualityApi.js +2 -2
  54. package/src/purecloud-platform-client-v2/api/RecordingApi.js +2 -2
  55. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +3 -2
  56. package/src/purecloud-platform-client-v2/api/RoutingApi.js +3 -2
  57. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -46
  62. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -81
  66. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +2 -2
  79. package/src/purecloud-platform-client-v2/index.js +7 -1
@@ -2279,7 +2279,7 @@ class Configuration {
2279
2279
 
2280
2280
  /**
2281
2281
  * @module purecloud-platform-client-v2/ApiClient
2282
- * @version 166.0.0
2282
+ * @version 168.0.0
2283
2283
  */
2284
2284
  class ApiClient {
2285
2285
  /**
@@ -3358,7 +3358,7 @@ class AlertingApi {
3358
3358
  /**
3359
3359
  * Alerting service.
3360
3360
  * @module purecloud-platform-client-v2/api/AlertingApi
3361
- * @version 166.0.0
3361
+ * @version 168.0.0
3362
3362
  */
3363
3363
 
3364
3364
  /**
@@ -3672,7 +3672,7 @@ class AnalyticsApi {
3672
3672
  /**
3673
3673
  * Analytics service.
3674
3674
  * @module purecloud-platform-client-v2/api/AnalyticsApi
3675
- * @version 166.0.0
3675
+ * @version 168.0.0
3676
3676
  */
3677
3677
 
3678
3678
  /**
@@ -4926,7 +4926,7 @@ class ArchitectApi {
4926
4926
  /**
4927
4927
  * Architect service.
4928
4928
  * @module purecloud-platform-client-v2/api/ArchitectApi
4929
- * @version 166.0.0
4929
+ * @version 168.0.0
4930
4930
  */
4931
4931
 
4932
4932
  /**
@@ -7974,7 +7974,7 @@ class AuditApi {
7974
7974
  /**
7975
7975
  * Audit service.
7976
7976
  * @module purecloud-platform-client-v2/api/AuditApi
7977
- * @version 166.0.0
7977
+ * @version 168.0.0
7978
7978
  */
7979
7979
 
7980
7980
  /**
@@ -8087,7 +8087,7 @@ class AuditApi {
8087
8087
 
8088
8088
  /**
8089
8089
  * Create audit query execution
8090
- *
8090
+ * Use /api/v2/audits/query/servicemapping endpoint for a list of valid values
8091
8091
  * @param {Object} body query
8092
8092
  */
8093
8093
  postAuditsQuery(body) {
@@ -8112,7 +8112,7 @@ class AuditApi {
8112
8112
 
8113
8113
  /**
8114
8114
  * This endpoint will only retrieve 14 days worth of audits for certain services. Please use /query to get a full list and older audits.
8115
- *
8115
+ * Use /api/v2/audits/query/realtime/servicemapping endpoint for a list of valid values
8116
8116
  * @param {Object} body query
8117
8117
  * @param {Object} opts Optional parameters
8118
8118
  * @param {Array.<String>} opts.expand Which fields, if any, to expand
@@ -8145,7 +8145,7 @@ class AuthorizationApi {
8145
8145
  /**
8146
8146
  * Authorization service.
8147
8147
  * @module purecloud-platform-client-v2/api/AuthorizationApi
8148
- * @version 166.0.0
8148
+ * @version 168.0.0
8149
8149
  */
8150
8150
 
8151
8151
  /**
@@ -9374,7 +9374,7 @@ class BillingApi {
9374
9374
  /**
9375
9375
  * Billing service.
9376
9376
  * @module purecloud-platform-client-v2/api/BillingApi
9377
- * @version 166.0.0
9377
+ * @version 168.0.0
9378
9378
  */
9379
9379
 
9380
9380
  /**
@@ -9450,11 +9450,81 @@ class BillingApi {
9450
9450
 
9451
9451
  }
9452
9452
 
9453
+ class CarrierServicesApi {
9454
+ /**
9455
+ * CarrierServices service.
9456
+ * @module purecloud-platform-client-v2/api/CarrierServicesApi
9457
+ * @version 168.0.0
9458
+ */
9459
+
9460
+ /**
9461
+ * Constructs a new CarrierServicesApi.
9462
+ * @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
9463
+ * @class
9464
+ * @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
9465
+ * default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
9466
+ */
9467
+ constructor(apiClient) {
9468
+ this.apiClient = apiClient || ApiClient.instance;
9469
+ }
9470
+
9471
+
9472
+ /**
9473
+ * Get location for the logged in user
9474
+ *
9475
+ * @param {String} phoneNumber Phone number in E164 format
9476
+ */
9477
+ getCarrierservicesIntegrationsEmergencylocationsMe(phoneNumber) {
9478
+ // verify the required parameter 'phoneNumber' is set
9479
+ if (phoneNumber === undefined || phoneNumber === null) {
9480
+ throw 'Missing the required parameter "phoneNumber" when calling getCarrierservicesIntegrationsEmergencylocationsMe';
9481
+ }
9482
+
9483
+ return this.apiClient.callApi(
9484
+ '/api/v2/carrierservices/integrations/emergencylocations/me',
9485
+ 'GET',
9486
+ { },
9487
+ { 'phoneNumber': phoneNumber },
9488
+ { },
9489
+ { },
9490
+ null,
9491
+ ['PureCloud OAuth'],
9492
+ ['application/json'],
9493
+ ['application/json']
9494
+ );
9495
+ }
9496
+
9497
+ /**
9498
+ * Set current location for the logged in user
9499
+ *
9500
+ * @param {Object} opts Optional parameters
9501
+ * @param {Object} opts.body
9502
+ */
9503
+ postCarrierservicesIntegrationsEmergencylocationsMe(opts) {
9504
+ opts = opts || {};
9505
+
9506
+
9507
+ return this.apiClient.callApi(
9508
+ '/api/v2/carrierservices/integrations/emergencylocations/me',
9509
+ 'POST',
9510
+ { },
9511
+ { },
9512
+ { },
9513
+ { },
9514
+ opts['body'],
9515
+ ['PureCloud OAuth'],
9516
+ ['application/json'],
9517
+ ['application/json']
9518
+ );
9519
+ }
9520
+
9521
+ }
9522
+
9453
9523
  class ChatApi {
9454
9524
  /**
9455
9525
  * Chat service.
9456
9526
  * @module purecloud-platform-client-v2/api/ChatApi
9457
- * @version 166.0.0
9527
+ * @version 168.0.0
9458
9528
  */
9459
9529
 
9460
9530
  /**
@@ -9615,7 +9685,7 @@ class CoachingApi {
9615
9685
  /**
9616
9686
  * Coaching service.
9617
9687
  * @module purecloud-platform-client-v2/api/CoachingApi
9618
- * @version 166.0.0
9688
+ * @version 168.0.0
9619
9689
  */
9620
9690
 
9621
9691
  /**
@@ -10192,7 +10262,7 @@ class ContentManagementApi {
10192
10262
  /**
10193
10263
  * ContentManagement service.
10194
10264
  * @module purecloud-platform-client-v2/api/ContentManagementApi
10195
- * @version 166.0.0
10265
+ * @version 168.0.0
10196
10266
  */
10197
10267
 
10198
10268
  /**
@@ -11332,7 +11402,7 @@ class ConversationsApi {
11332
11402
  /**
11333
11403
  * Conversations service.
11334
11404
  * @module purecloud-platform-client-v2/api/ConversationsApi
11335
- * @version 166.0.0
11405
+ * @version 168.0.0
11336
11406
  */
11337
11407
 
11338
11408
  /**
@@ -14597,6 +14667,37 @@ class ConversationsApi {
14597
14667
  );
14598
14668
  }
14599
14669
 
14670
+ /**
14671
+ * Reset conversation draft to its initial state and/or auto-fill draft content
14672
+ *
14673
+ * @param {String} conversationId conversationId
14674
+ * @param {Object} opts Optional parameters
14675
+ * @param {Boolean} opts.autoFill autoFill
14676
+ * @param {Boolean} opts.discard discard
14677
+ * @param {Object} opts.body Draft Manipulation Request
14678
+ */
14679
+ patchConversationsEmailMessagesDraft(conversationId, opts) {
14680
+ opts = opts || {};
14681
+
14682
+ // verify the required parameter 'conversationId' is set
14683
+ if (conversationId === undefined || conversationId === null) {
14684
+ throw 'Missing the required parameter "conversationId" when calling patchConversationsEmailMessagesDraft';
14685
+ }
14686
+
14687
+ return this.apiClient.callApi(
14688
+ '/api/v2/conversations/emails/{conversationId}/messages/draft',
14689
+ 'PATCH',
14690
+ { 'conversationId': conversationId },
14691
+ { 'autoFill': opts['autoFill'],'discard': opts['discard'] },
14692
+ { },
14693
+ { },
14694
+ opts['body'],
14695
+ ['PureCloud OAuth'],
14696
+ ['application/json'],
14697
+ ['application/json']
14698
+ );
14699
+ }
14700
+
14600
14701
  /**
14601
14702
  * Update conversation participant
14602
14703
  *
@@ -17392,7 +17493,7 @@ class DataExtensionsApi {
17392
17493
  /**
17393
17494
  * DataExtensions service.
17394
17495
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
17395
- * @version 166.0.0
17496
+ * @version 168.0.0
17396
17497
  */
17397
17498
 
17398
17499
  /**
@@ -17478,7 +17579,7 @@ class DownloadsApi {
17478
17579
  /**
17479
17580
  * Downloads service.
17480
17581
  * @module purecloud-platform-client-v2/api/DownloadsApi
17481
- * @version 166.0.0
17582
+ * @version 168.0.0
17482
17583
  */
17483
17584
 
17484
17585
  /**
@@ -17530,7 +17631,7 @@ class EventsApi {
17530
17631
  /**
17531
17632
  * Events service.
17532
17633
  * @module purecloud-platform-client-v2/api/EventsApi
17533
- * @version 166.0.0
17634
+ * @version 168.0.0
17534
17635
  */
17535
17636
 
17536
17637
  /**
@@ -17626,7 +17727,7 @@ class ExternalContactsApi {
17626
17727
  /**
17627
17728
  * ExternalContacts service.
17628
17729
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
17629
- * @version 166.0.0
17730
+ * @version 168.0.0
17630
17731
  */
17631
17732
 
17632
17733
  /**
@@ -19170,7 +19271,7 @@ class ExternalContactsApi {
19170
19271
 
19171
19272
  /**
19172
19273
  * Merge two contacts into a new contact record
19173
- *
19274
+ * Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
19174
19275
  * @param {Object} body MergeRequest
19175
19276
  */
19176
19277
  postExternalcontactsMergeContacts(body) {
@@ -19584,7 +19685,7 @@ class FaxApi {
19584
19685
  /**
19585
19686
  * Fax service.
19586
19687
  * @module purecloud-platform-client-v2/api/FaxApi
19587
- * @version 166.0.0
19688
+ * @version 168.0.0
19588
19689
  */
19589
19690
 
19590
19691
  /**
@@ -19755,7 +19856,7 @@ class FlowsApi {
19755
19856
  /**
19756
19857
  * Flows service.
19757
19858
  * @module purecloud-platform-client-v2/api/FlowsApi
19758
- * @version 166.0.0
19859
+ * @version 168.0.0
19759
19860
  */
19760
19861
 
19761
19862
  /**
@@ -19826,7 +19927,7 @@ class GamificationApi {
19826
19927
  /**
19827
19928
  * Gamification service.
19828
19929
  * @module purecloud-platform-client-v2/api/GamificationApi
19829
- * @version 166.0.0
19930
+ * @version 168.0.0
19830
19931
  */
19831
19932
 
19832
19933
  /**
@@ -19916,6 +20017,420 @@ class GamificationApi {
19916
20017
  );
19917
20018
  }
19918
20019
 
20020
+ /**
20021
+ * Get insights summary
20022
+ *
20023
+ * @param {Object} filterType Filter type for the query request.
20024
+ * @param {String} filterId ID for the filter type.
20025
+ * @param {Object} granularity Granularity
20026
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20027
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20028
+ * @param {Object} opts Optional parameters
20029
+ * @param {Number} opts.pageSize Page size (default to 25)
20030
+ * @param {Number} opts.pageNumber Page number (default to 1)
20031
+ * @param {Object} opts.sortKey Sort key
20032
+ * @param {String} opts.sortMetricId Sort Metric Id
20033
+ * @param {Object} opts.sortOrder Sort order (default to asc)
20034
+ * @param {String} opts.userIds A list of up to 100 comma-separated user Ids
20035
+ */
20036
+ getGamificationInsights(filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday, opts) {
20037
+ opts = opts || {};
20038
+
20039
+ // verify the required parameter 'filterType' is set
20040
+ if (filterType === undefined || filterType === null) {
20041
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsights';
20042
+ }
20043
+ // verify the required parameter 'filterId' is set
20044
+ if (filterId === undefined || filterId === null) {
20045
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsights';
20046
+ }
20047
+ // verify the required parameter 'granularity' is set
20048
+ if (granularity === undefined || granularity === null) {
20049
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsights';
20050
+ }
20051
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
20052
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
20053
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsights';
20054
+ }
20055
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
20056
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
20057
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsights';
20058
+ }
20059
+
20060
+ return this.apiClient.callApi(
20061
+ '/api/v2/gamification/insights',
20062
+ 'GET',
20063
+ { },
20064
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortKey': opts['sortKey'],'sortMetricId': opts['sortMetricId'],'sortOrder': opts['sortOrder'],'userIds': opts['userIds'] },
20065
+ { },
20066
+ { },
20067
+ null,
20068
+ ['PureCloud OAuth'],
20069
+ ['application/json'],
20070
+ ['application/json']
20071
+ );
20072
+ }
20073
+
20074
+ /**
20075
+ * Get insights details for the current user
20076
+ *
20077
+ * @param {Object} filterType Filter type for the query request.
20078
+ * @param {String} filterId ID for the filter type.
20079
+ * @param {Object} granularity Granularity
20080
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20081
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20082
+ */
20083
+ getGamificationInsightsDetails(filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday) {
20084
+ // verify the required parameter 'filterType' is set
20085
+ if (filterType === undefined || filterType === null) {
20086
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsDetails';
20087
+ }
20088
+ // verify the required parameter 'filterId' is set
20089
+ if (filterId === undefined || filterId === null) {
20090
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsDetails';
20091
+ }
20092
+ // verify the required parameter 'granularity' is set
20093
+ if (granularity === undefined || granularity === null) {
20094
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsDetails';
20095
+ }
20096
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
20097
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
20098
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsDetails';
20099
+ }
20100
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
20101
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
20102
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsDetails';
20103
+ }
20104
+
20105
+ return this.apiClient.callApi(
20106
+ '/api/v2/gamification/insights/details',
20107
+ 'GET',
20108
+ { },
20109
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday },
20110
+ { },
20111
+ { },
20112
+ null,
20113
+ ['PureCloud OAuth'],
20114
+ ['application/json'],
20115
+ ['application/json']
20116
+ );
20117
+ }
20118
+
20119
+ /**
20120
+ * Get insights overall trend for the current user
20121
+ *
20122
+ * @param {Object} filterType Filter type for the query request.
20123
+ * @param {String} filterId ID for the filter type.
20124
+ * @param {Object} granularity Granularity
20125
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20126
+ * @param {String} comparativePeriodEndWorkday The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20127
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20128
+ * @param {String} primaryPeriodEndWorkday The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20129
+ */
20130
+ getGamificationInsightsGroupsTrends(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday) {
20131
+ // verify the required parameter 'filterType' is set
20132
+ if (filterType === undefined || filterType === null) {
20133
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsGroupsTrends';
20134
+ }
20135
+ // verify the required parameter 'filterId' is set
20136
+ if (filterId === undefined || filterId === null) {
20137
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsGroupsTrends';
20138
+ }
20139
+ // verify the required parameter 'granularity' is set
20140
+ if (granularity === undefined || granularity === null) {
20141
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsGroupsTrends';
20142
+ }
20143
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
20144
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
20145
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsGroupsTrends';
20146
+ }
20147
+ // verify the required parameter 'comparativePeriodEndWorkday' is set
20148
+ if (comparativePeriodEndWorkday === undefined || comparativePeriodEndWorkday === null) {
20149
+ throw 'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsGroupsTrends';
20150
+ }
20151
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
20152
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
20153
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsGroupsTrends';
20154
+ }
20155
+ // verify the required parameter 'primaryPeriodEndWorkday' is set
20156
+ if (primaryPeriodEndWorkday === undefined || primaryPeriodEndWorkday === null) {
20157
+ throw 'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsGroupsTrends';
20158
+ }
20159
+
20160
+ return this.apiClient.callApi(
20161
+ '/api/v2/gamification/insights/groups/trends',
20162
+ 'GET',
20163
+ { },
20164
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'comparativePeriodEndWorkday': comparativePeriodEndWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'primaryPeriodEndWorkday': primaryPeriodEndWorkday },
20165
+ { },
20166
+ { },
20167
+ null,
20168
+ ['PureCloud OAuth'],
20169
+ ['application/json'],
20170
+ ['application/json']
20171
+ );
20172
+ }
20173
+
20174
+ /**
20175
+ * Get insights overall trend
20176
+ *
20177
+ * @param {Object} filterType Filter type for the query request.
20178
+ * @param {String} filterId ID for the filter type.
20179
+ * @param {Object} granularity Granularity
20180
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20181
+ * @param {String} comparativePeriodEndWorkday The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20182
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20183
+ * @param {String} primaryPeriodEndWorkday The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20184
+ */
20185
+ getGamificationInsightsGroupsTrendsAll(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday) {
20186
+ // verify the required parameter 'filterType' is set
20187
+ if (filterType === undefined || filterType === null) {
20188
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsGroupsTrendsAll';
20189
+ }
20190
+ // verify the required parameter 'filterId' is set
20191
+ if (filterId === undefined || filterId === null) {
20192
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsGroupsTrendsAll';
20193
+ }
20194
+ // verify the required parameter 'granularity' is set
20195
+ if (granularity === undefined || granularity === null) {
20196
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsGroupsTrendsAll';
20197
+ }
20198
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
20199
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
20200
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsGroupsTrendsAll';
20201
+ }
20202
+ // verify the required parameter 'comparativePeriodEndWorkday' is set
20203
+ if (comparativePeriodEndWorkday === undefined || comparativePeriodEndWorkday === null) {
20204
+ throw 'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsGroupsTrendsAll';
20205
+ }
20206
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
20207
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
20208
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsGroupsTrendsAll';
20209
+ }
20210
+ // verify the required parameter 'primaryPeriodEndWorkday' is set
20211
+ if (primaryPeriodEndWorkday === undefined || primaryPeriodEndWorkday === null) {
20212
+ throw 'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsGroupsTrendsAll';
20213
+ }
20214
+
20215
+ return this.apiClient.callApi(
20216
+ '/api/v2/gamification/insights/groups/trends/all',
20217
+ 'GET',
20218
+ { },
20219
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'comparativePeriodEndWorkday': comparativePeriodEndWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'primaryPeriodEndWorkday': primaryPeriodEndWorkday },
20220
+ { },
20221
+ { },
20222
+ null,
20223
+ ['PureCloud OAuth'],
20224
+ ['application/json'],
20225
+ ['application/json']
20226
+ );
20227
+ }
20228
+
20229
+ /**
20230
+ * Query users in a profile during a period of time
20231
+ *
20232
+ * @param {Object} filterType Filter type for the query request.
20233
+ * @param {String} filterId ID for the filter type.
20234
+ * @param {Object} granularity Granularity
20235
+ * @param {String} startWorkday The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20236
+ */
20237
+ getGamificationInsightsMembers(filterType, filterId, granularity, startWorkday) {
20238
+ // verify the required parameter 'filterType' is set
20239
+ if (filterType === undefined || filterType === null) {
20240
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsMembers';
20241
+ }
20242
+ // verify the required parameter 'filterId' is set
20243
+ if (filterId === undefined || filterId === null) {
20244
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsMembers';
20245
+ }
20246
+ // verify the required parameter 'granularity' is set
20247
+ if (granularity === undefined || granularity === null) {
20248
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsMembers';
20249
+ }
20250
+ // verify the required parameter 'startWorkday' is set
20251
+ if (startWorkday === undefined || startWorkday === null) {
20252
+ throw 'Missing the required parameter "startWorkday" when calling getGamificationInsightsMembers';
20253
+ }
20254
+
20255
+ return this.apiClient.callApi(
20256
+ '/api/v2/gamification/insights/members',
20257
+ 'GET',
20258
+ { },
20259
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'startWorkday': startWorkday },
20260
+ { },
20261
+ { },
20262
+ null,
20263
+ ['PureCloud OAuth'],
20264
+ ['application/json'],
20265
+ ['application/json']
20266
+ );
20267
+ }
20268
+
20269
+ /**
20270
+ * Get insights user trend for the current user
20271
+ *
20272
+ * @param {Object} filterType Filter type for the query request.
20273
+ * @param {String} filterId ID for the filter type.
20274
+ * @param {Object} granularity Granularity
20275
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20276
+ * @param {String} comparativePeriodEndWorkday The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20277
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20278
+ * @param {String} primaryPeriodEndWorkday The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20279
+ */
20280
+ getGamificationInsightsTrends(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday) {
20281
+ // verify the required parameter 'filterType' is set
20282
+ if (filterType === undefined || filterType === null) {
20283
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsTrends';
20284
+ }
20285
+ // verify the required parameter 'filterId' is set
20286
+ if (filterId === undefined || filterId === null) {
20287
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsTrends';
20288
+ }
20289
+ // verify the required parameter 'granularity' is set
20290
+ if (granularity === undefined || granularity === null) {
20291
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsTrends';
20292
+ }
20293
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
20294
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
20295
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsTrends';
20296
+ }
20297
+ // verify the required parameter 'comparativePeriodEndWorkday' is set
20298
+ if (comparativePeriodEndWorkday === undefined || comparativePeriodEndWorkday === null) {
20299
+ throw 'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsTrends';
20300
+ }
20301
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
20302
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
20303
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsTrends';
20304
+ }
20305
+ // verify the required parameter 'primaryPeriodEndWorkday' is set
20306
+ if (primaryPeriodEndWorkday === undefined || primaryPeriodEndWorkday === null) {
20307
+ throw 'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsTrends';
20308
+ }
20309
+
20310
+ return this.apiClient.callApi(
20311
+ '/api/v2/gamification/insights/trends',
20312
+ 'GET',
20313
+ { },
20314
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'comparativePeriodEndWorkday': comparativePeriodEndWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'primaryPeriodEndWorkday': primaryPeriodEndWorkday },
20315
+ { },
20316
+ { },
20317
+ null,
20318
+ ['PureCloud OAuth'],
20319
+ ['application/json'],
20320
+ ['application/json']
20321
+ );
20322
+ }
20323
+
20324
+ /**
20325
+ * Get insights details for the user
20326
+ *
20327
+ * @param {String} userId The ID of a user.
20328
+ * @param {Object} filterType Filter type for the query request.
20329
+ * @param {String} filterId ID for the filter type.
20330
+ * @param {Object} granularity Granularity
20331
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20332
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20333
+ */
20334
+ getGamificationInsightsUserDetails(userId, filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday) {
20335
+ // verify the required parameter 'userId' is set
20336
+ if (userId === undefined || userId === null) {
20337
+ throw 'Missing the required parameter "userId" when calling getGamificationInsightsUserDetails';
20338
+ }
20339
+ // verify the required parameter 'filterType' is set
20340
+ if (filterType === undefined || filterType === null) {
20341
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsUserDetails';
20342
+ }
20343
+ // verify the required parameter 'filterId' is set
20344
+ if (filterId === undefined || filterId === null) {
20345
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsUserDetails';
20346
+ }
20347
+ // verify the required parameter 'granularity' is set
20348
+ if (granularity === undefined || granularity === null) {
20349
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsUserDetails';
20350
+ }
20351
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
20352
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
20353
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsUserDetails';
20354
+ }
20355
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
20356
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
20357
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsUserDetails';
20358
+ }
20359
+
20360
+ return this.apiClient.callApi(
20361
+ '/api/v2/gamification/insights/users/{userId}/details',
20362
+ 'GET',
20363
+ { 'userId': userId },
20364
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday },
20365
+ { },
20366
+ { },
20367
+ null,
20368
+ ['PureCloud OAuth'],
20369
+ ['application/json'],
20370
+ ['application/json']
20371
+ );
20372
+ }
20373
+
20374
+ /**
20375
+ * Get insights user trend for the user
20376
+ *
20377
+ * @param {String} userId The ID of a user.
20378
+ * @param {Object} filterType Filter type for the query request.
20379
+ * @param {String} filterId ID for the filter type.
20380
+ * @param {Object} granularity Granularity
20381
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20382
+ * @param {String} comparativePeriodEndWorkday The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20383
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20384
+ * @param {String} primaryPeriodEndWorkday The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20385
+ */
20386
+ getGamificationInsightsUserTrends(userId, filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday) {
20387
+ // verify the required parameter 'userId' is set
20388
+ if (userId === undefined || userId === null) {
20389
+ throw 'Missing the required parameter "userId" when calling getGamificationInsightsUserTrends';
20390
+ }
20391
+ // verify the required parameter 'filterType' is set
20392
+ if (filterType === undefined || filterType === null) {
20393
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsUserTrends';
20394
+ }
20395
+ // verify the required parameter 'filterId' is set
20396
+ if (filterId === undefined || filterId === null) {
20397
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsUserTrends';
20398
+ }
20399
+ // verify the required parameter 'granularity' is set
20400
+ if (granularity === undefined || granularity === null) {
20401
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsUserTrends';
20402
+ }
20403
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
20404
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
20405
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsUserTrends';
20406
+ }
20407
+ // verify the required parameter 'comparativePeriodEndWorkday' is set
20408
+ if (comparativePeriodEndWorkday === undefined || comparativePeriodEndWorkday === null) {
20409
+ throw 'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsUserTrends';
20410
+ }
20411
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
20412
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
20413
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsUserTrends';
20414
+ }
20415
+ // verify the required parameter 'primaryPeriodEndWorkday' is set
20416
+ if (primaryPeriodEndWorkday === undefined || primaryPeriodEndWorkday === null) {
20417
+ throw 'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsUserTrends';
20418
+ }
20419
+
20420
+ return this.apiClient.callApi(
20421
+ '/api/v2/gamification/insights/users/{userId}/trends',
20422
+ 'GET',
20423
+ { 'userId': userId },
20424
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'comparativePeriodEndWorkday': comparativePeriodEndWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'primaryPeriodEndWorkday': primaryPeriodEndWorkday },
20425
+ { },
20426
+ { },
20427
+ null,
20428
+ ['PureCloud OAuth'],
20429
+ ['application/json'],
20430
+ ['application/json']
20431
+ );
20432
+ }
20433
+
19919
20434
  /**
19920
20435
  * Leaderboard of the requesting user's division or performance profile
19921
20436
  *
@@ -21348,6 +21863,61 @@ class GamificationApi {
21348
21863
  );
21349
21864
  }
21350
21865
 
21866
+ /**
21867
+ * Query performance profiles in date range for a user
21868
+ *
21869
+ * @param {String} userId The ID of a user.
21870
+ * @param {Object} body The date range of work day.
21871
+ */
21872
+ postGamificationProfilesUserQuery(userId, body) {
21873
+ // verify the required parameter 'userId' is set
21874
+ if (userId === undefined || userId === null) {
21875
+ throw 'Missing the required parameter "userId" when calling postGamificationProfilesUserQuery';
21876
+ }
21877
+ // verify the required parameter 'body' is set
21878
+ if (body === undefined || body === null) {
21879
+ throw 'Missing the required parameter "body" when calling postGamificationProfilesUserQuery';
21880
+ }
21881
+
21882
+ return this.apiClient.callApi(
21883
+ '/api/v2/gamification/profiles/users/{userId}/query',
21884
+ 'POST',
21885
+ { 'userId': userId },
21886
+ { },
21887
+ { },
21888
+ { },
21889
+ body,
21890
+ ['PureCloud OAuth'],
21891
+ ['application/json'],
21892
+ ['application/json']
21893
+ );
21894
+ }
21895
+
21896
+ /**
21897
+ * Query performance profiles in date range for the current user
21898
+ *
21899
+ * @param {Object} body The date range of work day.
21900
+ */
21901
+ postGamificationProfilesUsersMeQuery(body) {
21902
+ // verify the required parameter 'body' is set
21903
+ if (body === undefined || body === null) {
21904
+ throw 'Missing the required parameter "body" when calling postGamificationProfilesUsersMeQuery';
21905
+ }
21906
+
21907
+ return this.apiClient.callApi(
21908
+ '/api/v2/gamification/profiles/users/me/query',
21909
+ 'POST',
21910
+ { },
21911
+ { },
21912
+ { },
21913
+ { },
21914
+ body,
21915
+ ['PureCloud OAuth'],
21916
+ ['application/json'],
21917
+ ['application/json']
21918
+ );
21919
+ }
21920
+
21351
21921
  /**
21352
21922
  * Updates a performance profile
21353
21923
  *
@@ -21443,7 +22013,7 @@ class GeneralDataProtectionRegulationApi {
21443
22013
  /**
21444
22014
  * GeneralDataProtectionRegulation service.
21445
22015
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
21446
- * @version 166.0.0
22016
+ * @version 168.0.0
21447
22017
  */
21448
22018
 
21449
22019
  /**
@@ -21573,7 +22143,7 @@ class GeolocationApi {
21573
22143
  /**
21574
22144
  * Geolocation service.
21575
22145
  * @module purecloud-platform-client-v2/api/GeolocationApi
21576
- * @version 166.0.0
22146
+ * @version 168.0.0
21577
22147
  */
21578
22148
 
21579
22149
  /**
@@ -21704,7 +22274,7 @@ class GreetingsApi {
21704
22274
  /**
21705
22275
  * Greetings service.
21706
22276
  * @module purecloud-platform-client-v2/api/GreetingsApi
21707
- * @version 166.0.0
22277
+ * @version 168.0.0
21708
22278
  */
21709
22279
 
21710
22280
  /**
@@ -22159,7 +22729,7 @@ class GroupsApi {
22159
22729
  /**
22160
22730
  * Groups service.
22161
22731
  * @module purecloud-platform-client-v2/api/GroupsApi
22162
- * @version 166.0.0
22732
+ * @version 168.0.0
22163
22733
  */
22164
22734
 
22165
22735
  /**
@@ -22565,7 +23135,7 @@ class IdentityProviderApi {
22565
23135
  /**
22566
23136
  * IdentityProvider service.
22567
23137
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
22568
- * @version 166.0.0
23138
+ * @version 168.0.0
22569
23139
  */
22570
23140
 
22571
23141
  /**
@@ -23321,7 +23891,7 @@ class InfrastructureAsCodeApi {
23321
23891
  /**
23322
23892
  * InfrastructureAsCode service.
23323
23893
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
23324
- * @version 166.0.0
23894
+ * @version 168.0.0
23325
23895
  */
23326
23896
 
23327
23897
  /**
@@ -23336,6 +23906,68 @@ class InfrastructureAsCodeApi {
23336
23906
  }
23337
23907
 
23338
23908
 
23909
+ /**
23910
+ * Get information about an accelerator
23911
+ * Get the complete metadata specification for an accelerator, including requirements and parameters.
23912
+ * @param {String} acceleratorId Accelerator ID
23913
+ * @param {Object} opts Optional parameters
23914
+ * @param {Object} opts.preferredLanguage Preferred Language (default to en-US)
23915
+ */
23916
+ getInfrastructureascodeAccelerator(acceleratorId, opts) {
23917
+ opts = opts || {};
23918
+
23919
+ // verify the required parameter 'acceleratorId' is set
23920
+ if (acceleratorId === undefined || acceleratorId === null) {
23921
+ throw 'Missing the required parameter "acceleratorId" when calling getInfrastructureascodeAccelerator';
23922
+ }
23923
+
23924
+ return this.apiClient.callApi(
23925
+ '/api/v2/infrastructureascode/accelerators/{acceleratorId}',
23926
+ 'GET',
23927
+ { 'acceleratorId': acceleratorId },
23928
+ { 'preferredLanguage': opts['preferredLanguage'] },
23929
+ { },
23930
+ { },
23931
+ null,
23932
+ ['PureCloud OAuth'],
23933
+ ['application/json'],
23934
+ ['application/json']
23935
+ );
23936
+ }
23937
+
23938
+ /**
23939
+ * Get a list of available accelerators
23940
+ * Search for accelerators that can be run.
23941
+ * @param {Object} opts Optional parameters
23942
+ * @param {Number} opts.pageSize The total page size requested (default to 25)
23943
+ * @param {Number} opts.pageNumber The page number requested (default to 1)
23944
+ * @param {String} opts.sortBy variable name requested to sort by
23945
+ * @param {Object} opts.sortOrder Sort order (default to asc)
23946
+ * @param {String} opts.name Filter by name
23947
+ * @param {String} opts.description Filter by description
23948
+ * @param {Object} opts.origin Filter by origin
23949
+ * @param {Object} opts.type Filter by type
23950
+ * @param {String} opts.classification Filter by classification
23951
+ * @param {String} opts.tags Filter by tags
23952
+ */
23953
+ getInfrastructureascodeAccelerators(opts) {
23954
+ opts = opts || {};
23955
+
23956
+
23957
+ return this.apiClient.callApi(
23958
+ '/api/v2/infrastructureascode/accelerators',
23959
+ 'GET',
23960
+ { },
23961
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'description': opts['description'],'origin': opts['origin'],'type': opts['type'],'classification': opts['classification'],'tags': opts['tags'] },
23962
+ { },
23963
+ { },
23964
+ null,
23965
+ ['PureCloud OAuth'],
23966
+ ['application/json'],
23967
+ ['application/json']
23968
+ );
23969
+ }
23970
+
23339
23971
  /**
23340
23972
  * Get job status and results
23341
23973
  * Get the execution status of a submitted job, optionally including results and error details.
@@ -23371,8 +24003,11 @@ class InfrastructureAsCodeApi {
23371
24003
  * @param {Object} opts Optional parameters
23372
24004
  * @param {Number} opts.maxResults Number of jobs to show (default to 1)
23373
24005
  * @param {Boolean} opts.includeErrors Include error messages (default to false)
23374
- * @param {Object} opts.sortBy Sort by (default to id)
23375
- * @param {Object} opts.sortOrder Sort order (default to asc)
24006
+ * @param {Object} opts.sortBy Sort by (default to dateSubmitted)
24007
+ * @param {Object} opts.sortOrder Sort order (default to desc)
24008
+ * @param {String} opts.acceleratorId Find only jobs associated with this accelerator
24009
+ * @param {String} opts.submittedBy Find only jobs submitted by this user
24010
+ * @param {Object} opts.status Find only jobs in this state
23376
24011
  */
23377
24012
  getInfrastructureascodeJobs(opts) {
23378
24013
  opts = opts || {};
@@ -23382,7 +24017,7 @@ class InfrastructureAsCodeApi {
23382
24017
  '/api/v2/infrastructureascode/jobs',
23383
24018
  'GET',
23384
24019
  { },
23385
- { 'maxResults': opts['maxResults'],'includeErrors': opts['includeErrors'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
24020
+ { 'maxResults': opts['maxResults'],'includeErrors': opts['includeErrors'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'acceleratorId': opts['acceleratorId'],'submittedBy': opts['submittedBy'],'status': opts['status'] },
23386
24021
  { },
23387
24022
  { },
23388
24023
  null,
@@ -23423,7 +24058,7 @@ class IntegrationsApi {
23423
24058
  /**
23424
24059
  * Integrations service.
23425
24060
  * @module purecloud-platform-client-v2/api/IntegrationsApi
23426
- * @version 166.0.0
24061
+ * @version 168.0.0
23427
24062
  */
23428
24063
 
23429
24064
  /**
@@ -25023,7 +25658,7 @@ class JourneyApi {
25023
25658
  /**
25024
25659
  * Journey service.
25025
25660
  * @module purecloud-platform-client-v2/api/JourneyApi
25026
- * @version 166.0.0
25661
+ * @version 168.0.0
25027
25662
  */
25028
25663
 
25029
25664
  /**
@@ -25903,7 +26538,7 @@ class KnowledgeApi {
25903
26538
  /**
25904
26539
  * Knowledge service.
25905
26540
  * @module purecloud-platform-client-v2/api/KnowledgeApi
25906
- * @version 166.0.0
26541
+ * @version 168.0.0
25907
26542
  */
25908
26543
 
25909
26544
  /**
@@ -28335,7 +28970,7 @@ class LanguageUnderstandingApi {
28335
28970
  /**
28336
28971
  * LanguageUnderstanding service.
28337
28972
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
28338
- * @version 166.0.0
28973
+ * @version 168.0.0
28339
28974
  */
28340
28975
 
28341
28976
  /**
@@ -29348,7 +29983,7 @@ class LanguagesApi {
29348
29983
  /**
29349
29984
  * Languages service.
29350
29985
  * @module purecloud-platform-client-v2/api/LanguagesApi
29351
- * @version 166.0.0
29986
+ * @version 168.0.0
29352
29987
  */
29353
29988
 
29354
29989
  /**
@@ -29566,7 +30201,7 @@ class LearningApi {
29566
30201
  /**
29567
30202
  * Learning service.
29568
30203
  * @module purecloud-platform-client-v2/api/LearningApi
29569
- * @version 166.0.0
30204
+ * @version 168.0.0
29570
30205
  */
29571
30206
 
29572
30207
  /**
@@ -30381,7 +31016,7 @@ class LicenseApi {
30381
31016
  /**
30382
31017
  * License service.
30383
31018
  * @module purecloud-platform-client-v2/api/LicenseApi
30384
- * @version 166.0.0
31019
+ * @version 168.0.0
30385
31020
  */
30386
31021
 
30387
31022
  /**
@@ -30619,7 +31254,7 @@ class LocationsApi {
30619
31254
  /**
30620
31255
  * Locations service.
30621
31256
  * @module purecloud-platform-client-v2/api/LocationsApi
30622
- * @version 166.0.0
31257
+ * @version 168.0.0
30623
31258
  */
30624
31259
 
30625
31260
  /**
@@ -30855,7 +31490,7 @@ class MessagingApi {
30855
31490
  /**
30856
31491
  * Messaging service.
30857
31492
  * @module purecloud-platform-client-v2/api/MessagingApi
30858
- * @version 166.0.0
31493
+ * @version 168.0.0
30859
31494
  */
30860
31495
 
30861
31496
  /**
@@ -31006,7 +31641,7 @@ class MobileDevicesApi {
31006
31641
  /**
31007
31642
  * MobileDevices service.
31008
31643
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
31009
- * @version 166.0.0
31644
+ * @version 168.0.0
31010
31645
  */
31011
31646
 
31012
31647
  /**
@@ -31157,7 +31792,7 @@ class NotificationsApi {
31157
31792
  /**
31158
31793
  * Notifications service.
31159
31794
  * @module purecloud-platform-client-v2/api/NotificationsApi
31160
- * @version 166.0.0
31795
+ * @version 168.0.0
31161
31796
  */
31162
31797
 
31163
31798
  /**
@@ -31390,7 +32025,7 @@ class OAuthApi {
31390
32025
  /**
31391
32026
  * OAuth service.
31392
32027
  * @module purecloud-platform-client-v2/api/OAuthApi
31393
- * @version 166.0.0
32028
+ * @version 168.0.0
31394
32029
  */
31395
32030
 
31396
32031
  /**
@@ -31756,7 +32391,7 @@ class ObjectsApi {
31756
32391
  /**
31757
32392
  * Objects service.
31758
32393
  * @module purecloud-platform-client-v2/api/ObjectsApi
31759
- * @version 166.0.0
32394
+ * @version 168.0.0
31760
32395
  */
31761
32396
 
31762
32397
  /**
@@ -32027,7 +32662,7 @@ class OrganizationApi {
32027
32662
  /**
32028
32663
  * Organization service.
32029
32664
  * @module purecloud-platform-client-v2/api/OrganizationApi
32030
- * @version 166.0.0
32665
+ * @version 168.0.0
32031
32666
  */
32032
32667
 
32033
32668
  /**
@@ -32430,7 +33065,7 @@ class OrganizationAuthorizationApi {
32430
33065
  /**
32431
33066
  * OrganizationAuthorization service.
32432
33067
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
32433
- * @version 166.0.0
33068
+ * @version 168.0.0
32434
33069
  */
32435
33070
 
32436
33071
  /**
@@ -33725,7 +34360,7 @@ class OutboundApi {
33725
34360
  /**
33726
34361
  * Outbound service.
33727
34362
  * @module purecloud-platform-client-v2/api/OutboundApi
33728
- * @version 166.0.0
34363
+ * @version 168.0.0
33729
34364
  */
33730
34365
 
33731
34366
  /**
@@ -35489,6 +36124,31 @@ class OutboundApi {
35489
36124
  );
35490
36125
  }
35491
36126
 
36127
+ /**
36128
+ * Get messaging campaign diagnostics
36129
+ *
36130
+ * @param {String} messagingCampaignId The Messaging Campaign ID
36131
+ */
36132
+ getOutboundMessagingcampaignDiagnostics(messagingCampaignId) {
36133
+ // verify the required parameter 'messagingCampaignId' is set
36134
+ if (messagingCampaignId === undefined || messagingCampaignId === null) {
36135
+ throw 'Missing the required parameter "messagingCampaignId" when calling getOutboundMessagingcampaignDiagnostics';
36136
+ }
36137
+
36138
+ return this.apiClient.callApi(
36139
+ '/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/diagnostics',
36140
+ 'GET',
36141
+ { 'messagingCampaignId': messagingCampaignId },
36142
+ { },
36143
+ { },
36144
+ { },
36145
+ null,
36146
+ ['PureCloud OAuth'],
36147
+ ['application/json'],
36148
+ ['application/json']
36149
+ );
36150
+ }
36151
+
35492
36152
  /**
35493
36153
  * Get messaging campaign's progress
35494
36154
  *
@@ -37321,7 +37981,7 @@ class PresenceApi {
37321
37981
  /**
37322
37982
  * Presence service.
37323
37983
  * @module purecloud-platform-client-v2/api/PresenceApi
37324
- * @version 166.0.0
37984
+ * @version 168.0.0
37325
37985
  */
37326
37986
 
37327
37987
  /**
@@ -37872,7 +38532,7 @@ class ProcessAutomationApi {
37872
38532
  /**
37873
38533
  * ProcessAutomation service.
37874
38534
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
37875
- * @version 166.0.0
38535
+ * @version 168.0.0
37876
38536
  */
37877
38537
 
37878
38538
  /**
@@ -38111,7 +38771,7 @@ class QualityApi {
38111
38771
  /**
38112
38772
  * Quality service.
38113
38773
  * @module purecloud-platform-client-v2/api/QualityApi
38114
- * @version 166.0.0
38774
+ * @version 168.0.0
38115
38775
  */
38116
38776
 
38117
38777
  /**
@@ -39532,7 +40192,7 @@ class QualityApi {
39532
40192
  * @param {String} evaluationId evaluationId
39533
40193
  * @param {Object} body evaluation
39534
40194
  * @param {Object} opts Optional parameters
39535
- * @param {String} opts.expand evaluatorId, evaluationForm
40195
+ * @param {String} opts.expand evaluatorId, evaluationForm, assignee
39536
40196
  */
39537
40197
  putQualityConversationEvaluation(conversationId, evaluationId, body, opts) {
39538
40198
  opts = opts || {};
@@ -39690,7 +40350,7 @@ class RecordingApi {
39690
40350
  /**
39691
40351
  * Recording service.
39692
40352
  * @module purecloud-platform-client-v2/api/RecordingApi
39693
- * @version 166.0.0
40353
+ * @version 168.0.0
39694
40354
  */
39695
40355
 
39696
40356
  /**
@@ -39997,7 +40657,7 @@ class RecordingApi {
39997
40657
  }
39998
40658
 
39999
40659
  /**
40000
- * Get recording metadata for a conversation. Does not return playable media. Annotations won't be included in the response if recording:recording:view permission is missing.
40660
+ * Get recording metadata for a conversation. Does not return playable media. Annotations won't be included in the response if either recording:recording:view or recording:annotation:view permission is missing.
40001
40661
  *
40002
40662
  * @param {String} conversationId Conversation ID
40003
40663
  */
@@ -41327,7 +41987,7 @@ class ResponseManagementApi {
41327
41987
  /**
41328
41988
  * ResponseManagement service.
41329
41989
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
41330
- * @version 166.0.0
41990
+ * @version 168.0.0
41331
41991
  */
41332
41992
 
41333
41993
  /**
@@ -41424,6 +42084,7 @@ class ResponseManagementApi {
41424
42084
  * @param {Number} opts.pageNumber Page number (default to 1)
41425
42085
  * @param {Number} opts.pageSize Page size (default to 25)
41426
42086
  * @param {Object} opts.messagingTemplateFilter Returns a list of libraries that contain responses with at least one messaging template defined for a specific message channel
42087
+ * @param {String} opts.libraryPrefix Returns a list of libraries that contain the prefix provided
41427
42088
  */
41428
42089
  getResponsemanagementLibraries(opts) {
41429
42090
  opts = opts || {};
@@ -41433,7 +42094,7 @@ class ResponseManagementApi {
41433
42094
  '/api/v2/responsemanagement/libraries',
41434
42095
  'GET',
41435
42096
  { },
41436
- { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'messagingTemplateFilter': opts['messagingTemplateFilter'] },
42097
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'messagingTemplateFilter': opts['messagingTemplateFilter'],'libraryPrefix': opts['libraryPrefix'] },
41437
42098
  { },
41438
42099
  { },
41439
42100
  null,
@@ -41811,7 +42472,7 @@ class RoutingApi {
41811
42472
  /**
41812
42473
  * Routing service.
41813
42474
  * @module purecloud-platform-client-v2/api/RoutingApi
41814
- * @version 166.0.0
42475
+ * @version 168.0.0
41815
42476
  */
41816
42477
 
41817
42478
  /**
@@ -42921,6 +43582,7 @@ class RoutingApi {
42921
43582
  *
42922
43583
  * @param {Object} opts Optional parameters
42923
43584
  * @param {Object} opts.kpiGroup The Group of Key Performance Indicators to return
43585
+ * @param {Array.<String>} opts.expand Parameter to request additional data to return in KPI payload
42924
43586
  */
42925
43587
  getRoutingPredictorsKeyperformanceindicators(opts) {
42926
43588
  opts = opts || {};
@@ -42930,7 +43592,7 @@ class RoutingApi {
42930
43592
  '/api/v2/routing/predictors/keyperformanceindicators',
42931
43593
  'GET',
42932
43594
  { },
42933
- { 'kpiGroup': opts['kpiGroup'] },
43595
+ { 'kpiGroup': opts['kpiGroup'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
42934
43596
  { },
42935
43597
  { },
42936
43598
  null,
@@ -45319,7 +45981,7 @@ class SCIMApi {
45319
45981
  /**
45320
45982
  * SCIM service.
45321
45983
  * @module purecloud-platform-client-v2/api/SCIMApi
45322
- * @version 166.0.0
45984
+ * @version 168.0.0
45323
45985
  */
45324
45986
 
45325
45987
  /**
@@ -46196,7 +46858,7 @@ class ScriptsApi {
46196
46858
  /**
46197
46859
  * Scripts service.
46198
46860
  * @module purecloud-platform-client-v2/api/ScriptsApi
46199
- * @version 166.0.0
46861
+ * @version 168.0.0
46200
46862
  */
46201
46863
 
46202
46864
  /**
@@ -46615,7 +47277,7 @@ class SearchApi {
46615
47277
  /**
46616
47278
  * Search service.
46617
47279
  * @module purecloud-platform-client-v2/api/SearchApi
46618
- * @version 166.0.0
47280
+ * @version 168.0.0
46619
47281
  */
46620
47282
 
46621
47283
  /**
@@ -47225,7 +47887,7 @@ class SpeechTextAnalyticsApi {
47225
47887
  /**
47226
47888
  * SpeechTextAnalytics service.
47227
47889
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
47228
- * @version 166.0.0
47890
+ * @version 168.0.0
47229
47891
  */
47230
47892
 
47231
47893
  /**
@@ -48154,7 +48816,7 @@ class StationsApi {
48154
48816
  /**
48155
48817
  * Stations service.
48156
48818
  * @module purecloud-platform-client-v2/api/StationsApi
48157
- * @version 166.0.0
48819
+ * @version 168.0.0
48158
48820
  */
48159
48821
 
48160
48822
  /**
@@ -48250,58 +48912,13 @@ class StationsApi {
48250
48912
  );
48251
48913
  }
48252
48914
 
48253
- /**
48254
- * Get an organization's StationSettings
48255
- * This route is deprecated as the FreeSeatingConfiguration feature it references has been removed
48256
- */
48257
- getStationsSettings() {
48258
-
48259
- return this.apiClient.callApi(
48260
- '/api/v2/stations/settings',
48261
- 'GET',
48262
- { },
48263
- { },
48264
- { },
48265
- { },
48266
- null,
48267
- ['PureCloud OAuth'],
48268
- ['application/json'],
48269
- ['application/json']
48270
- );
48271
- }
48272
-
48273
- /**
48274
- * Patch an organization's StationSettings
48275
- * This route is deprecated as the FreeSeatingConfiguration feature it references has been removed
48276
- * @param {Object} body Station settings
48277
- */
48278
- patchStationsSettings(body) {
48279
- // verify the required parameter 'body' is set
48280
- if (body === undefined || body === null) {
48281
- throw 'Missing the required parameter "body" when calling patchStationsSettings';
48282
- }
48283
-
48284
- return this.apiClient.callApi(
48285
- '/api/v2/stations/settings',
48286
- 'PATCH',
48287
- { },
48288
- { },
48289
- { },
48290
- { },
48291
- body,
48292
- ['PureCloud OAuth'],
48293
- ['application/json'],
48294
- ['application/json']
48295
- );
48296
- }
48297
-
48298
48915
  }
48299
48916
 
48300
48917
  class SuggestApi {
48301
48918
  /**
48302
48919
  * Suggest service.
48303
48920
  * @module purecloud-platform-client-v2/api/SuggestApi
48304
- * @version 166.0.0
48921
+ * @version 168.0.0
48305
48922
  */
48306
48923
 
48307
48924
  /**
@@ -48440,7 +49057,7 @@ class TeamsApi {
48440
49057
  /**
48441
49058
  * Teams service.
48442
49059
  * @module purecloud-platform-client-v2/api/TeamsApi
48443
- * @version 166.0.0
49060
+ * @version 168.0.0
48444
49061
  */
48445
49062
 
48446
49063
  /**
@@ -48711,7 +49328,7 @@ class TelephonyApi {
48711
49328
  /**
48712
49329
  * Telephony service.
48713
49330
  * @module purecloud-platform-client-v2/api/TelephonyApi
48714
- * @version 166.0.0
49331
+ * @version 168.0.0
48715
49332
  */
48716
49333
 
48717
49334
  /**
@@ -48839,7 +49456,7 @@ class TelephonyProvidersEdgeApi {
48839
49456
  /**
48840
49457
  * TelephonyProvidersEdge service.
48841
49458
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
48842
- * @version 166.0.0
49459
+ * @version 168.0.0
48843
49460
  */
48844
49461
 
48845
49462
  /**
@@ -49034,31 +49651,6 @@ class TelephonyProvidersEdgeApi {
49034
49651
  );
49035
49652
  }
49036
49653
 
49037
- /**
49038
- * Delete Outbound Route
49039
- * This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} instead.
49040
- * @param {String} outboundRouteId Outbound route ID
49041
- */
49042
- deleteTelephonyProvidersEdgesOutboundroute(outboundRouteId) {
49043
- // verify the required parameter 'outboundRouteId' is set
49044
- if (outboundRouteId === undefined || outboundRouteId === null) {
49045
- throw 'Missing the required parameter "outboundRouteId" when calling deleteTelephonyProvidersEdgesOutboundroute';
49046
- }
49047
-
49048
- return this.apiClient.callApi(
49049
- '/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}',
49050
- 'DELETE',
49051
- { 'outboundRouteId': outboundRouteId },
49052
- { },
49053
- { },
49054
- { },
49055
- null,
49056
- ['PureCloud OAuth'],
49057
- ['application/json'],
49058
- ['application/json']
49059
- );
49060
- }
49061
-
49062
49654
  /**
49063
49655
  * Delete a Phone by ID
49064
49656
  *
@@ -51473,31 +52065,6 @@ class TelephonyProvidersEdgeApi {
51473
52065
  );
51474
52066
  }
51475
52067
 
51476
- /**
51477
- * Create outbound rule
51478
- * This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes instead.
51479
- * @param {Object} body OutboundRoute
51480
- */
51481
- postTelephonyProvidersEdgesOutboundroutes(body) {
51482
- // verify the required parameter 'body' is set
51483
- if (body === undefined || body === null) {
51484
- throw 'Missing the required parameter "body" when calling postTelephonyProvidersEdgesOutboundroutes';
51485
- }
51486
-
51487
- return this.apiClient.callApi(
51488
- '/api/v2/telephony/providers/edges/outboundroutes',
51489
- 'POST',
51490
- { },
51491
- { },
51492
- { },
51493
- { },
51494
- body,
51495
- ['PureCloud OAuth'],
51496
- ['application/json'],
51497
- ['application/json']
51498
- );
51499
- }
51500
-
51501
52068
  /**
51502
52069
  * Reboot a Phone
51503
52070
  *
@@ -51898,36 +52465,6 @@ class TelephonyProvidersEdgeApi {
51898
52465
  );
51899
52466
  }
51900
52467
 
51901
- /**
51902
- * Update outbound route
51903
- * This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} instead.
51904
- * @param {String} outboundRouteId Outbound route ID
51905
- * @param {Object} body OutboundRoute
51906
- */
51907
- putTelephonyProvidersEdgesOutboundroute(outboundRouteId, body) {
51908
- // verify the required parameter 'outboundRouteId' is set
51909
- if (outboundRouteId === undefined || outboundRouteId === null) {
51910
- throw 'Missing the required parameter "outboundRouteId" when calling putTelephonyProvidersEdgesOutboundroute';
51911
- }
51912
- // verify the required parameter 'body' is set
51913
- if (body === undefined || body === null) {
51914
- throw 'Missing the required parameter "body" when calling putTelephonyProvidersEdgesOutboundroute';
51915
- }
51916
-
51917
- return this.apiClient.callApi(
51918
- '/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}',
51919
- 'PUT',
51920
- { 'outboundRouteId': outboundRouteId },
51921
- { },
51922
- { },
51923
- { },
51924
- body,
51925
- ['PureCloud OAuth'],
51926
- ['application/json'],
51927
- ['application/json']
51928
- );
51929
- }
51930
-
51931
52468
  /**
51932
52469
  * Update a Phone by ID
51933
52470
  *
@@ -52119,7 +52656,7 @@ class TextbotsApi {
52119
52656
  /**
52120
52657
  * Textbots service.
52121
52658
  * @module purecloud-platform-client-v2/api/TextbotsApi
52122
- * @version 166.0.0
52659
+ * @version 168.0.0
52123
52660
  */
52124
52661
 
52125
52662
  /**
@@ -52247,7 +52784,7 @@ class TokensApi {
52247
52784
  /**
52248
52785
  * Tokens service.
52249
52786
  * @module purecloud-platform-client-v2/api/TokensApi
52250
- * @version 166.0.0
52787
+ * @version 168.0.0
52251
52788
  */
52252
52789
 
52253
52790
  /**
@@ -52353,7 +52890,7 @@ class UploadsApi {
52353
52890
  /**
52354
52891
  * Uploads service.
52355
52892
  * @module purecloud-platform-client-v2/api/UploadsApi
52356
- * @version 166.0.0
52893
+ * @version 168.0.0
52357
52894
  */
52358
52895
 
52359
52896
  /**
@@ -52529,7 +53066,7 @@ class UsageApi {
52529
53066
  /**
52530
53067
  * Usage service.
52531
53068
  * @module purecloud-platform-client-v2/api/UsageApi
52532
- * @version 166.0.0
53069
+ * @version 168.0.0
52533
53070
  */
52534
53071
 
52535
53072
  /**
@@ -52689,7 +53226,7 @@ class UserRecordingsApi {
52689
53226
  /**
52690
53227
  * UserRecordings service.
52691
53228
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
52692
- * @version 166.0.0
53229
+ * @version 168.0.0
52693
53230
  */
52694
53231
 
52695
53232
  /**
@@ -52874,7 +53411,7 @@ class UsersApi {
52874
53411
  /**
52875
53412
  * Users service.
52876
53413
  * @module purecloud-platform-client-v2/api/UsersApi
52877
- * @version 166.0.0
53414
+ * @version 168.0.0
52878
53415
  */
52879
53416
 
52880
53417
  /**
@@ -55264,7 +55801,7 @@ class UtilitiesApi {
55264
55801
  /**
55265
55802
  * Utilities service.
55266
55803
  * @module purecloud-platform-client-v2/api/UtilitiesApi
55267
- * @version 166.0.0
55804
+ * @version 168.0.0
55268
55805
  */
55269
55806
 
55270
55807
  /**
@@ -55375,7 +55912,7 @@ class VoicemailApi {
55375
55912
  /**
55376
55913
  * Voicemail service.
55377
55914
  * @module purecloud-platform-client-v2/api/VoicemailApi
55378
- * @version 166.0.0
55915
+ * @version 168.0.0
55379
55916
  */
55380
55917
 
55381
55918
  /**
@@ -56042,7 +56579,7 @@ class WebChatApi {
56042
56579
  /**
56043
56580
  * WebChat service.
56044
56581
  * @module purecloud-platform-client-v2/api/WebChatApi
56045
- * @version 166.0.0
56582
+ * @version 168.0.0
56046
56583
  */
56047
56584
 
56048
56585
  /**
@@ -56586,7 +57123,7 @@ class WebDeploymentsApi {
56586
57123
  /**
56587
57124
  * WebDeployments service.
56588
57125
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
56589
- * @version 166.0.0
57126
+ * @version 168.0.0
56590
57127
  */
56591
57128
 
56592
57129
  /**
@@ -57108,7 +57645,7 @@ class WebMessagingApi {
57108
57645
  /**
57109
57646
  * WebMessaging service.
57110
57647
  * @module purecloud-platform-client-v2/api/WebMessagingApi
57111
- * @version 166.0.0
57648
+ * @version 168.0.0
57112
57649
  */
57113
57650
 
57114
57651
  /**
@@ -57154,7 +57691,7 @@ class WidgetsApi {
57154
57691
  /**
57155
57692
  * Widgets service.
57156
57693
  * @module purecloud-platform-client-v2/api/WidgetsApi
57157
- * @version 166.0.0
57694
+ * @version 168.0.0
57158
57695
  */
57159
57696
 
57160
57697
  /**
@@ -57300,7 +57837,7 @@ class WorkforceManagementApi {
57300
57837
  /**
57301
57838
  * WorkforceManagement service.
57302
57839
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
57303
- * @version 166.0.0
57840
+ * @version 168.0.0
57304
57841
  */
57305
57842
 
57306
57843
  /**
@@ -60223,7 +60760,7 @@ class WorkforceManagementApi {
60223
60760
  }
60224
60761
 
60225
60762
  /**
60226
- * Request a historical adherence report for users across management units
60763
+ * Deprecated. Use bulk routes instead (/adherence/historical/bulk)
60227
60764
  *
60228
60765
  * @param {Object} opts Optional parameters
60229
60766
  * @param {Object} opts.body body
@@ -62044,7 +62581,7 @@ class WorkforceManagementApi {
62044
62581
  * </pre>
62045
62582
  * </p>
62046
62583
  * @module purecloud-platform-client-v2/index
62047
- * @version 166.0.0
62584
+ * @version 168.0.0
62048
62585
  */
62049
62586
  class platformClient {
62050
62587
  constructor() {
@@ -62088,6 +62625,11 @@ class platformClient {
62088
62625
  * @property {module:purecloud-platform-client-v2/api/BillingApi}
62089
62626
  */
62090
62627
  this.BillingApi = BillingApi;
62628
+ /**
62629
+ * The CarrierServicesApi service constructor.
62630
+ * @property {module:purecloud-platform-client-v2/api/CarrierServicesApi}
62631
+ */
62632
+ this.CarrierServicesApi = CarrierServicesApi;
62091
62633
  /**
62092
62634
  * The ChatApi service constructor.
62093
62635
  * @property {module:purecloud-platform-client-v2/api/ChatApi}