purecloud-platform-client-v2 166.0.0 → 167.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 (78) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +543 -153
  3. package/dist/web-amd/purecloud-platform-client-v2.js +543 -153
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +543 -153
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +543 -153
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +514 -208
  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/ChatApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/GamificationApi.js +470 -1
  28. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/RoutingApi.js +3 -2
  56. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -81
  65. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +2 -2
  78. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -9315,7 +9315,7 @@ class Configuration {
9315
9315
 
9316
9316
  /**
9317
9317
  * @module purecloud-platform-client-v2/ApiClient
9318
- * @version 166.0.0
9318
+ * @version 167.0.0
9319
9319
  */
9320
9320
  class ApiClient {
9321
9321
  /**
@@ -10394,7 +10394,7 @@ class AlertingApi {
10394
10394
  /**
10395
10395
  * Alerting service.
10396
10396
  * @module purecloud-platform-client-v2/api/AlertingApi
10397
- * @version 166.0.0
10397
+ * @version 167.0.0
10398
10398
  */
10399
10399
 
10400
10400
  /**
@@ -10708,7 +10708,7 @@ class AnalyticsApi {
10708
10708
  /**
10709
10709
  * Analytics service.
10710
10710
  * @module purecloud-platform-client-v2/api/AnalyticsApi
10711
- * @version 166.0.0
10711
+ * @version 167.0.0
10712
10712
  */
10713
10713
 
10714
10714
  /**
@@ -11962,7 +11962,7 @@ class ArchitectApi {
11962
11962
  /**
11963
11963
  * Architect service.
11964
11964
  * @module purecloud-platform-client-v2/api/ArchitectApi
11965
- * @version 166.0.0
11965
+ * @version 167.0.0
11966
11966
  */
11967
11967
 
11968
11968
  /**
@@ -15010,7 +15010,7 @@ class AuditApi {
15010
15010
  /**
15011
15011
  * Audit service.
15012
15012
  * @module purecloud-platform-client-v2/api/AuditApi
15013
- * @version 166.0.0
15013
+ * @version 167.0.0
15014
15014
  */
15015
15015
 
15016
15016
  /**
@@ -15123,7 +15123,7 @@ class AuditApi {
15123
15123
 
15124
15124
  /**
15125
15125
  * Create audit query execution
15126
- *
15126
+ * Use /api/v2/audits/query/servicemapping endpoint for a list of valid values
15127
15127
  * @param {Object} body query
15128
15128
  */
15129
15129
  postAuditsQuery(body) {
@@ -15148,7 +15148,7 @@ class AuditApi {
15148
15148
 
15149
15149
  /**
15150
15150
  * This endpoint will only retrieve 14 days worth of audits for certain services. Please use /query to get a full list and older audits.
15151
- *
15151
+ * Use /api/v2/audits/query/realtime/servicemapping endpoint for a list of valid values
15152
15152
  * @param {Object} body query
15153
15153
  * @param {Object} opts Optional parameters
15154
15154
  * @param {Array.<String>} opts.expand Which fields, if any, to expand
@@ -15181,7 +15181,7 @@ class AuthorizationApi {
15181
15181
  /**
15182
15182
  * Authorization service.
15183
15183
  * @module purecloud-platform-client-v2/api/AuthorizationApi
15184
- * @version 166.0.0
15184
+ * @version 167.0.0
15185
15185
  */
15186
15186
 
15187
15187
  /**
@@ -16410,7 +16410,7 @@ class BillingApi {
16410
16410
  /**
16411
16411
  * Billing service.
16412
16412
  * @module purecloud-platform-client-v2/api/BillingApi
16413
- * @version 166.0.0
16413
+ * @version 167.0.0
16414
16414
  */
16415
16415
 
16416
16416
  /**
@@ -16490,7 +16490,7 @@ class ChatApi {
16490
16490
  /**
16491
16491
  * Chat service.
16492
16492
  * @module purecloud-platform-client-v2/api/ChatApi
16493
- * @version 166.0.0
16493
+ * @version 167.0.0
16494
16494
  */
16495
16495
 
16496
16496
  /**
@@ -16651,7 +16651,7 @@ class CoachingApi {
16651
16651
  /**
16652
16652
  * Coaching service.
16653
16653
  * @module purecloud-platform-client-v2/api/CoachingApi
16654
- * @version 166.0.0
16654
+ * @version 167.0.0
16655
16655
  */
16656
16656
 
16657
16657
  /**
@@ -17228,7 +17228,7 @@ class ContentManagementApi {
17228
17228
  /**
17229
17229
  * ContentManagement service.
17230
17230
  * @module purecloud-platform-client-v2/api/ContentManagementApi
17231
- * @version 166.0.0
17231
+ * @version 167.0.0
17232
17232
  */
17233
17233
 
17234
17234
  /**
@@ -18368,7 +18368,7 @@ class ConversationsApi {
18368
18368
  /**
18369
18369
  * Conversations service.
18370
18370
  * @module purecloud-platform-client-v2/api/ConversationsApi
18371
- * @version 166.0.0
18371
+ * @version 167.0.0
18372
18372
  */
18373
18373
 
18374
18374
  /**
@@ -24428,7 +24428,7 @@ class DataExtensionsApi {
24428
24428
  /**
24429
24429
  * DataExtensions service.
24430
24430
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
24431
- * @version 166.0.0
24431
+ * @version 167.0.0
24432
24432
  */
24433
24433
 
24434
24434
  /**
@@ -24514,7 +24514,7 @@ class DownloadsApi {
24514
24514
  /**
24515
24515
  * Downloads service.
24516
24516
  * @module purecloud-platform-client-v2/api/DownloadsApi
24517
- * @version 166.0.0
24517
+ * @version 167.0.0
24518
24518
  */
24519
24519
 
24520
24520
  /**
@@ -24566,7 +24566,7 @@ class EventsApi {
24566
24566
  /**
24567
24567
  * Events service.
24568
24568
  * @module purecloud-platform-client-v2/api/EventsApi
24569
- * @version 166.0.0
24569
+ * @version 167.0.0
24570
24570
  */
24571
24571
 
24572
24572
  /**
@@ -24662,7 +24662,7 @@ class ExternalContactsApi {
24662
24662
  /**
24663
24663
  * ExternalContacts service.
24664
24664
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
24665
- * @version 166.0.0
24665
+ * @version 167.0.0
24666
24666
  */
24667
24667
 
24668
24668
  /**
@@ -26620,7 +26620,7 @@ class FaxApi {
26620
26620
  /**
26621
26621
  * Fax service.
26622
26622
  * @module purecloud-platform-client-v2/api/FaxApi
26623
- * @version 166.0.0
26623
+ * @version 167.0.0
26624
26624
  */
26625
26625
 
26626
26626
  /**
@@ -26791,7 +26791,7 @@ class FlowsApi {
26791
26791
  /**
26792
26792
  * Flows service.
26793
26793
  * @module purecloud-platform-client-v2/api/FlowsApi
26794
- * @version 166.0.0
26794
+ * @version 167.0.0
26795
26795
  */
26796
26796
 
26797
26797
  /**
@@ -26862,7 +26862,7 @@ class GamificationApi {
26862
26862
  /**
26863
26863
  * Gamification service.
26864
26864
  * @module purecloud-platform-client-v2/api/GamificationApi
26865
- * @version 166.0.0
26865
+ * @version 167.0.0
26866
26866
  */
26867
26867
 
26868
26868
  /**
@@ -26952,6 +26952,420 @@ class GamificationApi {
26952
26952
  );
26953
26953
  }
26954
26954
 
26955
+ /**
26956
+ * Get insights summary
26957
+ *
26958
+ * @param {Object} filterType Filter type for the query request.
26959
+ * @param {String} filterId ID for the filter type.
26960
+ * @param {Object} granularity Granularity
26961
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
26962
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
26963
+ * @param {Object} opts Optional parameters
26964
+ * @param {Number} opts.pageSize Page size (default to 25)
26965
+ * @param {Number} opts.pageNumber Page number (default to 1)
26966
+ * @param {Object} opts.sortKey Sort key
26967
+ * @param {String} opts.sortMetricId Sort Metric Id
26968
+ * @param {Object} opts.sortOrder Sort order (default to asc)
26969
+ * @param {String} opts.userIds A list of up to 100 comma-separated user Ids
26970
+ */
26971
+ getGamificationInsights(filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday, opts) {
26972
+ opts = opts || {};
26973
+
26974
+ // verify the required parameter 'filterType' is set
26975
+ if (filterType === undefined || filterType === null) {
26976
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsights';
26977
+ }
26978
+ // verify the required parameter 'filterId' is set
26979
+ if (filterId === undefined || filterId === null) {
26980
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsights';
26981
+ }
26982
+ // verify the required parameter 'granularity' is set
26983
+ if (granularity === undefined || granularity === null) {
26984
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsights';
26985
+ }
26986
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
26987
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
26988
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsights';
26989
+ }
26990
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
26991
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
26992
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsights';
26993
+ }
26994
+
26995
+ return this.apiClient.callApi(
26996
+ '/api/v2/gamification/insights',
26997
+ 'GET',
26998
+ { },
26999
+ { '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'] },
27000
+ { },
27001
+ { },
27002
+ null,
27003
+ ['PureCloud OAuth'],
27004
+ ['application/json'],
27005
+ ['application/json']
27006
+ );
27007
+ }
27008
+
27009
+ /**
27010
+ * Get insights details for the current user
27011
+ *
27012
+ * @param {Object} filterType Filter type for the query request.
27013
+ * @param {String} filterId ID for the filter type.
27014
+ * @param {Object} granularity Granularity
27015
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
27016
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
27017
+ */
27018
+ getGamificationInsightsDetails(filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday) {
27019
+ // verify the required parameter 'filterType' is set
27020
+ if (filterType === undefined || filterType === null) {
27021
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsDetails';
27022
+ }
27023
+ // verify the required parameter 'filterId' is set
27024
+ if (filterId === undefined || filterId === null) {
27025
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsDetails';
27026
+ }
27027
+ // verify the required parameter 'granularity' is set
27028
+ if (granularity === undefined || granularity === null) {
27029
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsDetails';
27030
+ }
27031
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
27032
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
27033
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsDetails';
27034
+ }
27035
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
27036
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
27037
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsDetails';
27038
+ }
27039
+
27040
+ return this.apiClient.callApi(
27041
+ '/api/v2/gamification/insights/details',
27042
+ 'GET',
27043
+ { },
27044
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday },
27045
+ { },
27046
+ { },
27047
+ null,
27048
+ ['PureCloud OAuth'],
27049
+ ['application/json'],
27050
+ ['application/json']
27051
+ );
27052
+ }
27053
+
27054
+ /**
27055
+ * Get insights overall trend for the current user
27056
+ *
27057
+ * @param {Object} filterType Filter type for the query request.
27058
+ * @param {String} filterId ID for the filter type.
27059
+ * @param {Object} granularity Granularity
27060
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
27061
+ * @param {String} comparativePeriodEndWorkday The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
27062
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
27063
+ * @param {String} primaryPeriodEndWorkday The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
27064
+ */
27065
+ getGamificationInsightsGroupsTrends(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday) {
27066
+ // verify the required parameter 'filterType' is set
27067
+ if (filterType === undefined || filterType === null) {
27068
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsGroupsTrends';
27069
+ }
27070
+ // verify the required parameter 'filterId' is set
27071
+ if (filterId === undefined || filterId === null) {
27072
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsGroupsTrends';
27073
+ }
27074
+ // verify the required parameter 'granularity' is set
27075
+ if (granularity === undefined || granularity === null) {
27076
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsGroupsTrends';
27077
+ }
27078
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
27079
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
27080
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsGroupsTrends';
27081
+ }
27082
+ // verify the required parameter 'comparativePeriodEndWorkday' is set
27083
+ if (comparativePeriodEndWorkday === undefined || comparativePeriodEndWorkday === null) {
27084
+ throw 'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsGroupsTrends';
27085
+ }
27086
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
27087
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
27088
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsGroupsTrends';
27089
+ }
27090
+ // verify the required parameter 'primaryPeriodEndWorkday' is set
27091
+ if (primaryPeriodEndWorkday === undefined || primaryPeriodEndWorkday === null) {
27092
+ throw 'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsGroupsTrends';
27093
+ }
27094
+
27095
+ return this.apiClient.callApi(
27096
+ '/api/v2/gamification/insights/groups/trends',
27097
+ 'GET',
27098
+ { },
27099
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'comparativePeriodEndWorkday': comparativePeriodEndWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'primaryPeriodEndWorkday': primaryPeriodEndWorkday },
27100
+ { },
27101
+ { },
27102
+ null,
27103
+ ['PureCloud OAuth'],
27104
+ ['application/json'],
27105
+ ['application/json']
27106
+ );
27107
+ }
27108
+
27109
+ /**
27110
+ * Get insights overall trend
27111
+ *
27112
+ * @param {Object} filterType Filter type for the query request.
27113
+ * @param {String} filterId ID for the filter type.
27114
+ * @param {Object} granularity Granularity
27115
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
27116
+ * @param {String} comparativePeriodEndWorkday The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
27117
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
27118
+ * @param {String} primaryPeriodEndWorkday The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
27119
+ */
27120
+ getGamificationInsightsGroupsTrendsAll(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday) {
27121
+ // verify the required parameter 'filterType' is set
27122
+ if (filterType === undefined || filterType === null) {
27123
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsGroupsTrendsAll';
27124
+ }
27125
+ // verify the required parameter 'filterId' is set
27126
+ if (filterId === undefined || filterId === null) {
27127
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsGroupsTrendsAll';
27128
+ }
27129
+ // verify the required parameter 'granularity' is set
27130
+ if (granularity === undefined || granularity === null) {
27131
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsGroupsTrendsAll';
27132
+ }
27133
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
27134
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
27135
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsGroupsTrendsAll';
27136
+ }
27137
+ // verify the required parameter 'comparativePeriodEndWorkday' is set
27138
+ if (comparativePeriodEndWorkday === undefined || comparativePeriodEndWorkday === null) {
27139
+ throw 'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsGroupsTrendsAll';
27140
+ }
27141
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
27142
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
27143
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsGroupsTrendsAll';
27144
+ }
27145
+ // verify the required parameter 'primaryPeriodEndWorkday' is set
27146
+ if (primaryPeriodEndWorkday === undefined || primaryPeriodEndWorkday === null) {
27147
+ throw 'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsGroupsTrendsAll';
27148
+ }
27149
+
27150
+ return this.apiClient.callApi(
27151
+ '/api/v2/gamification/insights/groups/trends/all',
27152
+ 'GET',
27153
+ { },
27154
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'comparativePeriodEndWorkday': comparativePeriodEndWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'primaryPeriodEndWorkday': primaryPeriodEndWorkday },
27155
+ { },
27156
+ { },
27157
+ null,
27158
+ ['PureCloud OAuth'],
27159
+ ['application/json'],
27160
+ ['application/json']
27161
+ );
27162
+ }
27163
+
27164
+ /**
27165
+ * Query users in a profile during a period of time
27166
+ *
27167
+ * @param {Object} filterType Filter type for the query request.
27168
+ * @param {String} filterId ID for the filter type.
27169
+ * @param {Object} granularity Granularity
27170
+ * @param {String} startWorkday The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
27171
+ */
27172
+ getGamificationInsightsMembers(filterType, filterId, granularity, startWorkday) {
27173
+ // verify the required parameter 'filterType' is set
27174
+ if (filterType === undefined || filterType === null) {
27175
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsMembers';
27176
+ }
27177
+ // verify the required parameter 'filterId' is set
27178
+ if (filterId === undefined || filterId === null) {
27179
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsMembers';
27180
+ }
27181
+ // verify the required parameter 'granularity' is set
27182
+ if (granularity === undefined || granularity === null) {
27183
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsMembers';
27184
+ }
27185
+ // verify the required parameter 'startWorkday' is set
27186
+ if (startWorkday === undefined || startWorkday === null) {
27187
+ throw 'Missing the required parameter "startWorkday" when calling getGamificationInsightsMembers';
27188
+ }
27189
+
27190
+ return this.apiClient.callApi(
27191
+ '/api/v2/gamification/insights/members',
27192
+ 'GET',
27193
+ { },
27194
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'startWorkday': startWorkday },
27195
+ { },
27196
+ { },
27197
+ null,
27198
+ ['PureCloud OAuth'],
27199
+ ['application/json'],
27200
+ ['application/json']
27201
+ );
27202
+ }
27203
+
27204
+ /**
27205
+ * Get insights user trend for the current user
27206
+ *
27207
+ * @param {Object} filterType Filter type for the query request.
27208
+ * @param {String} filterId ID for the filter type.
27209
+ * @param {Object} granularity Granularity
27210
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
27211
+ * @param {String} comparativePeriodEndWorkday The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
27212
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
27213
+ * @param {String} primaryPeriodEndWorkday The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
27214
+ */
27215
+ getGamificationInsightsTrends(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday) {
27216
+ // verify the required parameter 'filterType' is set
27217
+ if (filterType === undefined || filterType === null) {
27218
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsTrends';
27219
+ }
27220
+ // verify the required parameter 'filterId' is set
27221
+ if (filterId === undefined || filterId === null) {
27222
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsTrends';
27223
+ }
27224
+ // verify the required parameter 'granularity' is set
27225
+ if (granularity === undefined || granularity === null) {
27226
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsTrends';
27227
+ }
27228
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
27229
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
27230
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsTrends';
27231
+ }
27232
+ // verify the required parameter 'comparativePeriodEndWorkday' is set
27233
+ if (comparativePeriodEndWorkday === undefined || comparativePeriodEndWorkday === null) {
27234
+ throw 'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsTrends';
27235
+ }
27236
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
27237
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
27238
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsTrends';
27239
+ }
27240
+ // verify the required parameter 'primaryPeriodEndWorkday' is set
27241
+ if (primaryPeriodEndWorkday === undefined || primaryPeriodEndWorkday === null) {
27242
+ throw 'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsTrends';
27243
+ }
27244
+
27245
+ return this.apiClient.callApi(
27246
+ '/api/v2/gamification/insights/trends',
27247
+ 'GET',
27248
+ { },
27249
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'comparativePeriodEndWorkday': comparativePeriodEndWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'primaryPeriodEndWorkday': primaryPeriodEndWorkday },
27250
+ { },
27251
+ { },
27252
+ null,
27253
+ ['PureCloud OAuth'],
27254
+ ['application/json'],
27255
+ ['application/json']
27256
+ );
27257
+ }
27258
+
27259
+ /**
27260
+ * Get insights details for the user
27261
+ *
27262
+ * @param {String} userId The ID of a user.
27263
+ * @param {Object} filterType Filter type for the query request.
27264
+ * @param {String} filterId ID for the filter type.
27265
+ * @param {Object} granularity Granularity
27266
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
27267
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
27268
+ */
27269
+ getGamificationInsightsUserDetails(userId, filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday) {
27270
+ // verify the required parameter 'userId' is set
27271
+ if (userId === undefined || userId === null) {
27272
+ throw 'Missing the required parameter "userId" when calling getGamificationInsightsUserDetails';
27273
+ }
27274
+ // verify the required parameter 'filterType' is set
27275
+ if (filterType === undefined || filterType === null) {
27276
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsUserDetails';
27277
+ }
27278
+ // verify the required parameter 'filterId' is set
27279
+ if (filterId === undefined || filterId === null) {
27280
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsUserDetails';
27281
+ }
27282
+ // verify the required parameter 'granularity' is set
27283
+ if (granularity === undefined || granularity === null) {
27284
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsUserDetails';
27285
+ }
27286
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
27287
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
27288
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsUserDetails';
27289
+ }
27290
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
27291
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
27292
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsUserDetails';
27293
+ }
27294
+
27295
+ return this.apiClient.callApi(
27296
+ '/api/v2/gamification/insights/users/{userId}/details',
27297
+ 'GET',
27298
+ { 'userId': userId },
27299
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday },
27300
+ { },
27301
+ { },
27302
+ null,
27303
+ ['PureCloud OAuth'],
27304
+ ['application/json'],
27305
+ ['application/json']
27306
+ );
27307
+ }
27308
+
27309
+ /**
27310
+ * Get insights user trend for the user
27311
+ *
27312
+ * @param {String} userId The ID of a user.
27313
+ * @param {Object} filterType Filter type for the query request.
27314
+ * @param {String} filterId ID for the filter type.
27315
+ * @param {Object} granularity Granularity
27316
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
27317
+ * @param {String} comparativePeriodEndWorkday The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
27318
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
27319
+ * @param {String} primaryPeriodEndWorkday The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
27320
+ */
27321
+ getGamificationInsightsUserTrends(userId, filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday) {
27322
+ // verify the required parameter 'userId' is set
27323
+ if (userId === undefined || userId === null) {
27324
+ throw 'Missing the required parameter "userId" when calling getGamificationInsightsUserTrends';
27325
+ }
27326
+ // verify the required parameter 'filterType' is set
27327
+ if (filterType === undefined || filterType === null) {
27328
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsUserTrends';
27329
+ }
27330
+ // verify the required parameter 'filterId' is set
27331
+ if (filterId === undefined || filterId === null) {
27332
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsUserTrends';
27333
+ }
27334
+ // verify the required parameter 'granularity' is set
27335
+ if (granularity === undefined || granularity === null) {
27336
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsUserTrends';
27337
+ }
27338
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
27339
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
27340
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsUserTrends';
27341
+ }
27342
+ // verify the required parameter 'comparativePeriodEndWorkday' is set
27343
+ if (comparativePeriodEndWorkday === undefined || comparativePeriodEndWorkday === null) {
27344
+ throw 'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsUserTrends';
27345
+ }
27346
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
27347
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
27348
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsUserTrends';
27349
+ }
27350
+ // verify the required parameter 'primaryPeriodEndWorkday' is set
27351
+ if (primaryPeriodEndWorkday === undefined || primaryPeriodEndWorkday === null) {
27352
+ throw 'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsUserTrends';
27353
+ }
27354
+
27355
+ return this.apiClient.callApi(
27356
+ '/api/v2/gamification/insights/users/{userId}/trends',
27357
+ 'GET',
27358
+ { 'userId': userId },
27359
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'comparativePeriodEndWorkday': comparativePeriodEndWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'primaryPeriodEndWorkday': primaryPeriodEndWorkday },
27360
+ { },
27361
+ { },
27362
+ null,
27363
+ ['PureCloud OAuth'],
27364
+ ['application/json'],
27365
+ ['application/json']
27366
+ );
27367
+ }
27368
+
26955
27369
  /**
26956
27370
  * Leaderboard of the requesting user's division or performance profile
26957
27371
  *
@@ -28384,6 +28798,61 @@ class GamificationApi {
28384
28798
  );
28385
28799
  }
28386
28800
 
28801
+ /**
28802
+ * Query performance profiles in date range for a user
28803
+ *
28804
+ * @param {String} userId The ID of a user.
28805
+ * @param {Object} body The date range of work day.
28806
+ */
28807
+ postGamificationProfilesUserQuery(userId, body) {
28808
+ // verify the required parameter 'userId' is set
28809
+ if (userId === undefined || userId === null) {
28810
+ throw 'Missing the required parameter "userId" when calling postGamificationProfilesUserQuery';
28811
+ }
28812
+ // verify the required parameter 'body' is set
28813
+ if (body === undefined || body === null) {
28814
+ throw 'Missing the required parameter "body" when calling postGamificationProfilesUserQuery';
28815
+ }
28816
+
28817
+ return this.apiClient.callApi(
28818
+ '/api/v2/gamification/profiles/users/{userId}/query',
28819
+ 'POST',
28820
+ { 'userId': userId },
28821
+ { },
28822
+ { },
28823
+ { },
28824
+ body,
28825
+ ['PureCloud OAuth'],
28826
+ ['application/json'],
28827
+ ['application/json']
28828
+ );
28829
+ }
28830
+
28831
+ /**
28832
+ * Query performance profiles in date range for the current user
28833
+ *
28834
+ * @param {Object} body The date range of work day.
28835
+ */
28836
+ postGamificationProfilesUsersMeQuery(body) {
28837
+ // verify the required parameter 'body' is set
28838
+ if (body === undefined || body === null) {
28839
+ throw 'Missing the required parameter "body" when calling postGamificationProfilesUsersMeQuery';
28840
+ }
28841
+
28842
+ return this.apiClient.callApi(
28843
+ '/api/v2/gamification/profiles/users/me/query',
28844
+ 'POST',
28845
+ { },
28846
+ { },
28847
+ { },
28848
+ { },
28849
+ body,
28850
+ ['PureCloud OAuth'],
28851
+ ['application/json'],
28852
+ ['application/json']
28853
+ );
28854
+ }
28855
+
28387
28856
  /**
28388
28857
  * Updates a performance profile
28389
28858
  *
@@ -28479,7 +28948,7 @@ class GeneralDataProtectionRegulationApi {
28479
28948
  /**
28480
28949
  * GeneralDataProtectionRegulation service.
28481
28950
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
28482
- * @version 166.0.0
28951
+ * @version 167.0.0
28483
28952
  */
28484
28953
 
28485
28954
  /**
@@ -28609,7 +29078,7 @@ class GeolocationApi {
28609
29078
  /**
28610
29079
  * Geolocation service.
28611
29080
  * @module purecloud-platform-client-v2/api/GeolocationApi
28612
- * @version 166.0.0
29081
+ * @version 167.0.0
28613
29082
  */
28614
29083
 
28615
29084
  /**
@@ -28740,7 +29209,7 @@ class GreetingsApi {
28740
29209
  /**
28741
29210
  * Greetings service.
28742
29211
  * @module purecloud-platform-client-v2/api/GreetingsApi
28743
- * @version 166.0.0
29212
+ * @version 167.0.0
28744
29213
  */
28745
29214
 
28746
29215
  /**
@@ -29195,7 +29664,7 @@ class GroupsApi {
29195
29664
  /**
29196
29665
  * Groups service.
29197
29666
  * @module purecloud-platform-client-v2/api/GroupsApi
29198
- * @version 166.0.0
29667
+ * @version 167.0.0
29199
29668
  */
29200
29669
 
29201
29670
  /**
@@ -29601,7 +30070,7 @@ class IdentityProviderApi {
29601
30070
  /**
29602
30071
  * IdentityProvider service.
29603
30072
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
29604
- * @version 166.0.0
30073
+ * @version 167.0.0
29605
30074
  */
29606
30075
 
29607
30076
  /**
@@ -30357,7 +30826,7 @@ class InfrastructureAsCodeApi {
30357
30826
  /**
30358
30827
  * InfrastructureAsCode service.
30359
30828
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
30360
- * @version 166.0.0
30829
+ * @version 167.0.0
30361
30830
  */
30362
30831
 
30363
30832
  /**
@@ -30459,7 +30928,7 @@ class IntegrationsApi {
30459
30928
  /**
30460
30929
  * Integrations service.
30461
30930
  * @module purecloud-platform-client-v2/api/IntegrationsApi
30462
- * @version 166.0.0
30931
+ * @version 167.0.0
30463
30932
  */
30464
30933
 
30465
30934
  /**
@@ -32059,7 +32528,7 @@ class JourneyApi {
32059
32528
  /**
32060
32529
  * Journey service.
32061
32530
  * @module purecloud-platform-client-v2/api/JourneyApi
32062
- * @version 166.0.0
32531
+ * @version 167.0.0
32063
32532
  */
32064
32533
 
32065
32534
  /**
@@ -32939,7 +33408,7 @@ class KnowledgeApi {
32939
33408
  /**
32940
33409
  * Knowledge service.
32941
33410
  * @module purecloud-platform-client-v2/api/KnowledgeApi
32942
- * @version 166.0.0
33411
+ * @version 167.0.0
32943
33412
  */
32944
33413
 
32945
33414
  /**
@@ -35371,7 +35840,7 @@ class LanguageUnderstandingApi {
35371
35840
  /**
35372
35841
  * LanguageUnderstanding service.
35373
35842
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
35374
- * @version 166.0.0
35843
+ * @version 167.0.0
35375
35844
  */
35376
35845
 
35377
35846
  /**
@@ -36384,7 +36853,7 @@ class LanguagesApi {
36384
36853
  /**
36385
36854
  * Languages service.
36386
36855
  * @module purecloud-platform-client-v2/api/LanguagesApi
36387
- * @version 166.0.0
36856
+ * @version 167.0.0
36388
36857
  */
36389
36858
 
36390
36859
  /**
@@ -36602,7 +37071,7 @@ class LearningApi {
36602
37071
  /**
36603
37072
  * Learning service.
36604
37073
  * @module purecloud-platform-client-v2/api/LearningApi
36605
- * @version 166.0.0
37074
+ * @version 167.0.0
36606
37075
  */
36607
37076
 
36608
37077
  /**
@@ -37417,7 +37886,7 @@ class LicenseApi {
37417
37886
  /**
37418
37887
  * License service.
37419
37888
  * @module purecloud-platform-client-v2/api/LicenseApi
37420
- * @version 166.0.0
37889
+ * @version 167.0.0
37421
37890
  */
37422
37891
 
37423
37892
  /**
@@ -37655,7 +38124,7 @@ class LocationsApi {
37655
38124
  /**
37656
38125
  * Locations service.
37657
38126
  * @module purecloud-platform-client-v2/api/LocationsApi
37658
- * @version 166.0.0
38127
+ * @version 167.0.0
37659
38128
  */
37660
38129
 
37661
38130
  /**
@@ -37891,7 +38360,7 @@ class MessagingApi {
37891
38360
  /**
37892
38361
  * Messaging service.
37893
38362
  * @module purecloud-platform-client-v2/api/MessagingApi
37894
- * @version 166.0.0
38363
+ * @version 167.0.0
37895
38364
  */
37896
38365
 
37897
38366
  /**
@@ -38042,7 +38511,7 @@ class MobileDevicesApi {
38042
38511
  /**
38043
38512
  * MobileDevices service.
38044
38513
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
38045
- * @version 166.0.0
38514
+ * @version 167.0.0
38046
38515
  */
38047
38516
 
38048
38517
  /**
@@ -38193,7 +38662,7 @@ class NotificationsApi {
38193
38662
  /**
38194
38663
  * Notifications service.
38195
38664
  * @module purecloud-platform-client-v2/api/NotificationsApi
38196
- * @version 166.0.0
38665
+ * @version 167.0.0
38197
38666
  */
38198
38667
 
38199
38668
  /**
@@ -38426,7 +38895,7 @@ class OAuthApi {
38426
38895
  /**
38427
38896
  * OAuth service.
38428
38897
  * @module purecloud-platform-client-v2/api/OAuthApi
38429
- * @version 166.0.0
38898
+ * @version 167.0.0
38430
38899
  */
38431
38900
 
38432
38901
  /**
@@ -38792,7 +39261,7 @@ class ObjectsApi {
38792
39261
  /**
38793
39262
  * Objects service.
38794
39263
  * @module purecloud-platform-client-v2/api/ObjectsApi
38795
- * @version 166.0.0
39264
+ * @version 167.0.0
38796
39265
  */
38797
39266
 
38798
39267
  /**
@@ -39063,7 +39532,7 @@ class OrganizationApi {
39063
39532
  /**
39064
39533
  * Organization service.
39065
39534
  * @module purecloud-platform-client-v2/api/OrganizationApi
39066
- * @version 166.0.0
39535
+ * @version 167.0.0
39067
39536
  */
39068
39537
 
39069
39538
  /**
@@ -39466,7 +39935,7 @@ class OrganizationAuthorizationApi {
39466
39935
  /**
39467
39936
  * OrganizationAuthorization service.
39468
39937
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
39469
- * @version 166.0.0
39938
+ * @version 167.0.0
39470
39939
  */
39471
39940
 
39472
39941
  /**
@@ -40761,7 +41230,7 @@ class OutboundApi {
40761
41230
  /**
40762
41231
  * Outbound service.
40763
41232
  * @module purecloud-platform-client-v2/api/OutboundApi
40764
- * @version 166.0.0
41233
+ * @version 167.0.0
40765
41234
  */
40766
41235
 
40767
41236
  /**
@@ -44357,7 +44826,7 @@ class PresenceApi {
44357
44826
  /**
44358
44827
  * Presence service.
44359
44828
  * @module purecloud-platform-client-v2/api/PresenceApi
44360
- * @version 166.0.0
44829
+ * @version 167.0.0
44361
44830
  */
44362
44831
 
44363
44832
  /**
@@ -44908,7 +45377,7 @@ class ProcessAutomationApi {
44908
45377
  /**
44909
45378
  * ProcessAutomation service.
44910
45379
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
44911
- * @version 166.0.0
45380
+ * @version 167.0.0
44912
45381
  */
44913
45382
 
44914
45383
  /**
@@ -45147,7 +45616,7 @@ class QualityApi {
45147
45616
  /**
45148
45617
  * Quality service.
45149
45618
  * @module purecloud-platform-client-v2/api/QualityApi
45150
- * @version 166.0.0
45619
+ * @version 167.0.0
45151
45620
  */
45152
45621
 
45153
45622
  /**
@@ -46726,7 +47195,7 @@ class RecordingApi {
46726
47195
  /**
46727
47196
  * Recording service.
46728
47197
  * @module purecloud-platform-client-v2/api/RecordingApi
46729
- * @version 166.0.0
47198
+ * @version 167.0.0
46730
47199
  */
46731
47200
 
46732
47201
  /**
@@ -48363,7 +48832,7 @@ class ResponseManagementApi {
48363
48832
  /**
48364
48833
  * ResponseManagement service.
48365
48834
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
48366
- * @version 166.0.0
48835
+ * @version 167.0.0
48367
48836
  */
48368
48837
 
48369
48838
  /**
@@ -48847,7 +49316,7 @@ class RoutingApi {
48847
49316
  /**
48848
49317
  * Routing service.
48849
49318
  * @module purecloud-platform-client-v2/api/RoutingApi
48850
- * @version 166.0.0
49319
+ * @version 167.0.0
48851
49320
  */
48852
49321
 
48853
49322
  /**
@@ -49957,6 +50426,7 @@ class RoutingApi {
49957
50426
  *
49958
50427
  * @param {Object} opts Optional parameters
49959
50428
  * @param {Object} opts.kpiGroup The Group of Key Performance Indicators to return
50429
+ * @param {Array.<String>} opts.expand Parameter to request additional data to return in KPI payload
49960
50430
  */
49961
50431
  getRoutingPredictorsKeyperformanceindicators(opts) {
49962
50432
  opts = opts || {};
@@ -49966,7 +50436,7 @@ class RoutingApi {
49966
50436
  '/api/v2/routing/predictors/keyperformanceindicators',
49967
50437
  'GET',
49968
50438
  { },
49969
- { 'kpiGroup': opts['kpiGroup'] },
50439
+ { 'kpiGroup': opts['kpiGroup'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
49970
50440
  { },
49971
50441
  { },
49972
50442
  null,
@@ -52355,7 +52825,7 @@ class SCIMApi {
52355
52825
  /**
52356
52826
  * SCIM service.
52357
52827
  * @module purecloud-platform-client-v2/api/SCIMApi
52358
- * @version 166.0.0
52828
+ * @version 167.0.0
52359
52829
  */
52360
52830
 
52361
52831
  /**
@@ -53232,7 +53702,7 @@ class ScriptsApi {
53232
53702
  /**
53233
53703
  * Scripts service.
53234
53704
  * @module purecloud-platform-client-v2/api/ScriptsApi
53235
- * @version 166.0.0
53705
+ * @version 167.0.0
53236
53706
  */
53237
53707
 
53238
53708
  /**
@@ -53651,7 +54121,7 @@ class SearchApi {
53651
54121
  /**
53652
54122
  * Search service.
53653
54123
  * @module purecloud-platform-client-v2/api/SearchApi
53654
- * @version 166.0.0
54124
+ * @version 167.0.0
53655
54125
  */
53656
54126
 
53657
54127
  /**
@@ -54261,7 +54731,7 @@ class SpeechTextAnalyticsApi {
54261
54731
  /**
54262
54732
  * SpeechTextAnalytics service.
54263
54733
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
54264
- * @version 166.0.0
54734
+ * @version 167.0.0
54265
54735
  */
54266
54736
 
54267
54737
  /**
@@ -55190,7 +55660,7 @@ class StationsApi {
55190
55660
  /**
55191
55661
  * Stations service.
55192
55662
  * @module purecloud-platform-client-v2/api/StationsApi
55193
- * @version 166.0.0
55663
+ * @version 167.0.0
55194
55664
  */
55195
55665
 
55196
55666
  /**
@@ -55337,7 +55807,7 @@ class SuggestApi {
55337
55807
  /**
55338
55808
  * Suggest service.
55339
55809
  * @module purecloud-platform-client-v2/api/SuggestApi
55340
- * @version 166.0.0
55810
+ * @version 167.0.0
55341
55811
  */
55342
55812
 
55343
55813
  /**
@@ -55476,7 +55946,7 @@ class TeamsApi {
55476
55946
  /**
55477
55947
  * Teams service.
55478
55948
  * @module purecloud-platform-client-v2/api/TeamsApi
55479
- * @version 166.0.0
55949
+ * @version 167.0.0
55480
55950
  */
55481
55951
 
55482
55952
  /**
@@ -55747,7 +56217,7 @@ class TelephonyApi {
55747
56217
  /**
55748
56218
  * Telephony service.
55749
56219
  * @module purecloud-platform-client-v2/api/TelephonyApi
55750
- * @version 166.0.0
56220
+ * @version 167.0.0
55751
56221
  */
55752
56222
 
55753
56223
  /**
@@ -55875,7 +56345,7 @@ class TelephonyProvidersEdgeApi {
55875
56345
  /**
55876
56346
  * TelephonyProvidersEdge service.
55877
56347
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
55878
- * @version 166.0.0
56348
+ * @version 167.0.0
55879
56349
  */
55880
56350
 
55881
56351
  /**
@@ -56070,31 +56540,6 @@ class TelephonyProvidersEdgeApi {
56070
56540
  );
56071
56541
  }
56072
56542
 
56073
- /**
56074
- * Delete Outbound Route
56075
- * This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} instead.
56076
- * @param {String} outboundRouteId Outbound route ID
56077
- */
56078
- deleteTelephonyProvidersEdgesOutboundroute(outboundRouteId) {
56079
- // verify the required parameter 'outboundRouteId' is set
56080
- if (outboundRouteId === undefined || outboundRouteId === null) {
56081
- throw 'Missing the required parameter "outboundRouteId" when calling deleteTelephonyProvidersEdgesOutboundroute';
56082
- }
56083
-
56084
- return this.apiClient.callApi(
56085
- '/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}',
56086
- 'DELETE',
56087
- { 'outboundRouteId': outboundRouteId },
56088
- { },
56089
- { },
56090
- { },
56091
- null,
56092
- ['PureCloud OAuth'],
56093
- ['application/json'],
56094
- ['application/json']
56095
- );
56096
- }
56097
-
56098
56543
  /**
56099
56544
  * Delete a Phone by ID
56100
56545
  *
@@ -58509,31 +58954,6 @@ class TelephonyProvidersEdgeApi {
58509
58954
  );
58510
58955
  }
58511
58956
 
58512
- /**
58513
- * Create outbound rule
58514
- * This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes instead.
58515
- * @param {Object} body OutboundRoute
58516
- */
58517
- postTelephonyProvidersEdgesOutboundroutes(body) {
58518
- // verify the required parameter 'body' is set
58519
- if (body === undefined || body === null) {
58520
- throw 'Missing the required parameter "body" when calling postTelephonyProvidersEdgesOutboundroutes';
58521
- }
58522
-
58523
- return this.apiClient.callApi(
58524
- '/api/v2/telephony/providers/edges/outboundroutes',
58525
- 'POST',
58526
- { },
58527
- { },
58528
- { },
58529
- { },
58530
- body,
58531
- ['PureCloud OAuth'],
58532
- ['application/json'],
58533
- ['application/json']
58534
- );
58535
- }
58536
-
58537
58957
  /**
58538
58958
  * Reboot a Phone
58539
58959
  *
@@ -58934,36 +59354,6 @@ class TelephonyProvidersEdgeApi {
58934
59354
  );
58935
59355
  }
58936
59356
 
58937
- /**
58938
- * Update outbound route
58939
- * This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} instead.
58940
- * @param {String} outboundRouteId Outbound route ID
58941
- * @param {Object} body OutboundRoute
58942
- */
58943
- putTelephonyProvidersEdgesOutboundroute(outboundRouteId, body) {
58944
- // verify the required parameter 'outboundRouteId' is set
58945
- if (outboundRouteId === undefined || outboundRouteId === null) {
58946
- throw 'Missing the required parameter "outboundRouteId" when calling putTelephonyProvidersEdgesOutboundroute';
58947
- }
58948
- // verify the required parameter 'body' is set
58949
- if (body === undefined || body === null) {
58950
- throw 'Missing the required parameter "body" when calling putTelephonyProvidersEdgesOutboundroute';
58951
- }
58952
-
58953
- return this.apiClient.callApi(
58954
- '/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}',
58955
- 'PUT',
58956
- { 'outboundRouteId': outboundRouteId },
58957
- { },
58958
- { },
58959
- { },
58960
- body,
58961
- ['PureCloud OAuth'],
58962
- ['application/json'],
58963
- ['application/json']
58964
- );
58965
- }
58966
-
58967
59357
  /**
58968
59358
  * Update a Phone by ID
58969
59359
  *
@@ -59155,7 +59545,7 @@ class TextbotsApi {
59155
59545
  /**
59156
59546
  * Textbots service.
59157
59547
  * @module purecloud-platform-client-v2/api/TextbotsApi
59158
- * @version 166.0.0
59548
+ * @version 167.0.0
59159
59549
  */
59160
59550
 
59161
59551
  /**
@@ -59283,7 +59673,7 @@ class TokensApi {
59283
59673
  /**
59284
59674
  * Tokens service.
59285
59675
  * @module purecloud-platform-client-v2/api/TokensApi
59286
- * @version 166.0.0
59676
+ * @version 167.0.0
59287
59677
  */
59288
59678
 
59289
59679
  /**
@@ -59389,7 +59779,7 @@ class UploadsApi {
59389
59779
  /**
59390
59780
  * Uploads service.
59391
59781
  * @module purecloud-platform-client-v2/api/UploadsApi
59392
- * @version 166.0.0
59782
+ * @version 167.0.0
59393
59783
  */
59394
59784
 
59395
59785
  /**
@@ -59565,7 +59955,7 @@ class UsageApi {
59565
59955
  /**
59566
59956
  * Usage service.
59567
59957
  * @module purecloud-platform-client-v2/api/UsageApi
59568
- * @version 166.0.0
59958
+ * @version 167.0.0
59569
59959
  */
59570
59960
 
59571
59961
  /**
@@ -59725,7 +60115,7 @@ class UserRecordingsApi {
59725
60115
  /**
59726
60116
  * UserRecordings service.
59727
60117
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
59728
- * @version 166.0.0
60118
+ * @version 167.0.0
59729
60119
  */
59730
60120
 
59731
60121
  /**
@@ -59910,7 +60300,7 @@ class UsersApi {
59910
60300
  /**
59911
60301
  * Users service.
59912
60302
  * @module purecloud-platform-client-v2/api/UsersApi
59913
- * @version 166.0.0
60303
+ * @version 167.0.0
59914
60304
  */
59915
60305
 
59916
60306
  /**
@@ -62300,7 +62690,7 @@ class UtilitiesApi {
62300
62690
  /**
62301
62691
  * Utilities service.
62302
62692
  * @module purecloud-platform-client-v2/api/UtilitiesApi
62303
- * @version 166.0.0
62693
+ * @version 167.0.0
62304
62694
  */
62305
62695
 
62306
62696
  /**
@@ -62411,7 +62801,7 @@ class VoicemailApi {
62411
62801
  /**
62412
62802
  * Voicemail service.
62413
62803
  * @module purecloud-platform-client-v2/api/VoicemailApi
62414
- * @version 166.0.0
62804
+ * @version 167.0.0
62415
62805
  */
62416
62806
 
62417
62807
  /**
@@ -63078,7 +63468,7 @@ class WebChatApi {
63078
63468
  /**
63079
63469
  * WebChat service.
63080
63470
  * @module purecloud-platform-client-v2/api/WebChatApi
63081
- * @version 166.0.0
63471
+ * @version 167.0.0
63082
63472
  */
63083
63473
 
63084
63474
  /**
@@ -63622,7 +64012,7 @@ class WebDeploymentsApi {
63622
64012
  /**
63623
64013
  * WebDeployments service.
63624
64014
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
63625
- * @version 166.0.0
64015
+ * @version 167.0.0
63626
64016
  */
63627
64017
 
63628
64018
  /**
@@ -64144,7 +64534,7 @@ class WebMessagingApi {
64144
64534
  /**
64145
64535
  * WebMessaging service.
64146
64536
  * @module purecloud-platform-client-v2/api/WebMessagingApi
64147
- * @version 166.0.0
64537
+ * @version 167.0.0
64148
64538
  */
64149
64539
 
64150
64540
  /**
@@ -64190,7 +64580,7 @@ class WidgetsApi {
64190
64580
  /**
64191
64581
  * Widgets service.
64192
64582
  * @module purecloud-platform-client-v2/api/WidgetsApi
64193
- * @version 166.0.0
64583
+ * @version 167.0.0
64194
64584
  */
64195
64585
 
64196
64586
  /**
@@ -64336,7 +64726,7 @@ class WorkforceManagementApi {
64336
64726
  /**
64337
64727
  * WorkforceManagement service.
64338
64728
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
64339
- * @version 166.0.0
64729
+ * @version 167.0.0
64340
64730
  */
64341
64731
 
64342
64732
  /**
@@ -67259,7 +67649,7 @@ class WorkforceManagementApi {
67259
67649
  }
67260
67650
 
67261
67651
  /**
67262
- * Request a historical adherence report for users across management units
67652
+ * Deprecated. Use bulk routes instead (/adherence/historical/bulk)
67263
67653
  *
67264
67654
  * @param {Object} opts Optional parameters
67265
67655
  * @param {Object} opts.body body
@@ -69080,7 +69470,7 @@ class WorkforceManagementApi {
69080
69470
  * </pre>
69081
69471
  * </p>
69082
69472
  * @module purecloud-platform-client-v2/index
69083
- * @version 166.0.0
69473
+ * @version 167.0.0
69084
69474
  */
69085
69475
  class platformClient {
69086
69476
  constructor() {