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
@@ -402,7 +402,7 @@ class Configuration {
402
402
 
403
403
  /**
404
404
  * @module purecloud-platform-client-v2/ApiClient
405
- * @version 166.0.0
405
+ * @version 167.0.0
406
406
  */
407
407
  class ApiClient {
408
408
  /**
@@ -1488,7 +1488,7 @@ class AlertingApi {
1488
1488
  /**
1489
1489
  * Alerting service.
1490
1490
  * @module purecloud-platform-client-v2/api/AlertingApi
1491
- * @version 166.0.0
1491
+ * @version 167.0.0
1492
1492
  */
1493
1493
 
1494
1494
  /**
@@ -1802,7 +1802,7 @@ class AnalyticsApi {
1802
1802
  /**
1803
1803
  * Analytics service.
1804
1804
  * @module purecloud-platform-client-v2/api/AnalyticsApi
1805
- * @version 166.0.0
1805
+ * @version 167.0.0
1806
1806
  */
1807
1807
 
1808
1808
  /**
@@ -3056,7 +3056,7 @@ class ArchitectApi {
3056
3056
  /**
3057
3057
  * Architect service.
3058
3058
  * @module purecloud-platform-client-v2/api/ArchitectApi
3059
- * @version 166.0.0
3059
+ * @version 167.0.0
3060
3060
  */
3061
3061
 
3062
3062
  /**
@@ -6104,7 +6104,7 @@ class AuditApi {
6104
6104
  /**
6105
6105
  * Audit service.
6106
6106
  * @module purecloud-platform-client-v2/api/AuditApi
6107
- * @version 166.0.0
6107
+ * @version 167.0.0
6108
6108
  */
6109
6109
 
6110
6110
  /**
@@ -6217,7 +6217,7 @@ class AuditApi {
6217
6217
 
6218
6218
  /**
6219
6219
  * Create audit query execution
6220
- *
6220
+ * Use /api/v2/audits/query/servicemapping endpoint for a list of valid values
6221
6221
  * @param {Object} body query
6222
6222
  */
6223
6223
  postAuditsQuery(body) {
@@ -6242,7 +6242,7 @@ class AuditApi {
6242
6242
 
6243
6243
  /**
6244
6244
  * This endpoint will only retrieve 14 days worth of audits for certain services. Please use /query to get a full list and older audits.
6245
- *
6245
+ * Use /api/v2/audits/query/realtime/servicemapping endpoint for a list of valid values
6246
6246
  * @param {Object} body query
6247
6247
  * @param {Object} opts Optional parameters
6248
6248
  * @param {Array.<String>} opts.expand Which fields, if any, to expand
@@ -6275,7 +6275,7 @@ class AuthorizationApi {
6275
6275
  /**
6276
6276
  * Authorization service.
6277
6277
  * @module purecloud-platform-client-v2/api/AuthorizationApi
6278
- * @version 166.0.0
6278
+ * @version 167.0.0
6279
6279
  */
6280
6280
 
6281
6281
  /**
@@ -7504,7 +7504,7 @@ class BillingApi {
7504
7504
  /**
7505
7505
  * Billing service.
7506
7506
  * @module purecloud-platform-client-v2/api/BillingApi
7507
- * @version 166.0.0
7507
+ * @version 167.0.0
7508
7508
  */
7509
7509
 
7510
7510
  /**
@@ -7584,7 +7584,7 @@ class ChatApi {
7584
7584
  /**
7585
7585
  * Chat service.
7586
7586
  * @module purecloud-platform-client-v2/api/ChatApi
7587
- * @version 166.0.0
7587
+ * @version 167.0.0
7588
7588
  */
7589
7589
 
7590
7590
  /**
@@ -7745,7 +7745,7 @@ class CoachingApi {
7745
7745
  /**
7746
7746
  * Coaching service.
7747
7747
  * @module purecloud-platform-client-v2/api/CoachingApi
7748
- * @version 166.0.0
7748
+ * @version 167.0.0
7749
7749
  */
7750
7750
 
7751
7751
  /**
@@ -8322,7 +8322,7 @@ class ContentManagementApi {
8322
8322
  /**
8323
8323
  * ContentManagement service.
8324
8324
  * @module purecloud-platform-client-v2/api/ContentManagementApi
8325
- * @version 166.0.0
8325
+ * @version 167.0.0
8326
8326
  */
8327
8327
 
8328
8328
  /**
@@ -9462,7 +9462,7 @@ class ConversationsApi {
9462
9462
  /**
9463
9463
  * Conversations service.
9464
9464
  * @module purecloud-platform-client-v2/api/ConversationsApi
9465
- * @version 166.0.0
9465
+ * @version 167.0.0
9466
9466
  */
9467
9467
 
9468
9468
  /**
@@ -15522,7 +15522,7 @@ class DataExtensionsApi {
15522
15522
  /**
15523
15523
  * DataExtensions service.
15524
15524
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
15525
- * @version 166.0.0
15525
+ * @version 167.0.0
15526
15526
  */
15527
15527
 
15528
15528
  /**
@@ -15608,7 +15608,7 @@ class DownloadsApi {
15608
15608
  /**
15609
15609
  * Downloads service.
15610
15610
  * @module purecloud-platform-client-v2/api/DownloadsApi
15611
- * @version 166.0.0
15611
+ * @version 167.0.0
15612
15612
  */
15613
15613
 
15614
15614
  /**
@@ -15660,7 +15660,7 @@ class EventsApi {
15660
15660
  /**
15661
15661
  * Events service.
15662
15662
  * @module purecloud-platform-client-v2/api/EventsApi
15663
- * @version 166.0.0
15663
+ * @version 167.0.0
15664
15664
  */
15665
15665
 
15666
15666
  /**
@@ -15756,7 +15756,7 @@ class ExternalContactsApi {
15756
15756
  /**
15757
15757
  * ExternalContacts service.
15758
15758
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
15759
- * @version 166.0.0
15759
+ * @version 167.0.0
15760
15760
  */
15761
15761
 
15762
15762
  /**
@@ -17714,7 +17714,7 @@ class FaxApi {
17714
17714
  /**
17715
17715
  * Fax service.
17716
17716
  * @module purecloud-platform-client-v2/api/FaxApi
17717
- * @version 166.0.0
17717
+ * @version 167.0.0
17718
17718
  */
17719
17719
 
17720
17720
  /**
@@ -17885,7 +17885,7 @@ class FlowsApi {
17885
17885
  /**
17886
17886
  * Flows service.
17887
17887
  * @module purecloud-platform-client-v2/api/FlowsApi
17888
- * @version 166.0.0
17888
+ * @version 167.0.0
17889
17889
  */
17890
17890
 
17891
17891
  /**
@@ -17956,7 +17956,7 @@ class GamificationApi {
17956
17956
  /**
17957
17957
  * Gamification service.
17958
17958
  * @module purecloud-platform-client-v2/api/GamificationApi
17959
- * @version 166.0.0
17959
+ * @version 167.0.0
17960
17960
  */
17961
17961
 
17962
17962
  /**
@@ -18046,6 +18046,420 @@ class GamificationApi {
18046
18046
  );
18047
18047
  }
18048
18048
 
18049
+ /**
18050
+ * Get insights summary
18051
+ *
18052
+ * @param {Object} filterType Filter type for the query request.
18053
+ * @param {String} filterId ID for the filter type.
18054
+ * @param {Object} granularity Granularity
18055
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18056
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18057
+ * @param {Object} opts Optional parameters
18058
+ * @param {Number} opts.pageSize Page size (default to 25)
18059
+ * @param {Number} opts.pageNumber Page number (default to 1)
18060
+ * @param {Object} opts.sortKey Sort key
18061
+ * @param {String} opts.sortMetricId Sort Metric Id
18062
+ * @param {Object} opts.sortOrder Sort order (default to asc)
18063
+ * @param {String} opts.userIds A list of up to 100 comma-separated user Ids
18064
+ */
18065
+ getGamificationInsights(filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday, opts) {
18066
+ opts = opts || {};
18067
+
18068
+ // verify the required parameter 'filterType' is set
18069
+ if (filterType === undefined || filterType === null) {
18070
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsights';
18071
+ }
18072
+ // verify the required parameter 'filterId' is set
18073
+ if (filterId === undefined || filterId === null) {
18074
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsights';
18075
+ }
18076
+ // verify the required parameter 'granularity' is set
18077
+ if (granularity === undefined || granularity === null) {
18078
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsights';
18079
+ }
18080
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
18081
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
18082
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsights';
18083
+ }
18084
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
18085
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
18086
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsights';
18087
+ }
18088
+
18089
+ return this.apiClient.callApi(
18090
+ '/api/v2/gamification/insights',
18091
+ 'GET',
18092
+ { },
18093
+ { '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'] },
18094
+ { },
18095
+ { },
18096
+ null,
18097
+ ['PureCloud OAuth'],
18098
+ ['application/json'],
18099
+ ['application/json']
18100
+ );
18101
+ }
18102
+
18103
+ /**
18104
+ * Get insights details for the current user
18105
+ *
18106
+ * @param {Object} filterType Filter type for the query request.
18107
+ * @param {String} filterId ID for the filter type.
18108
+ * @param {Object} granularity Granularity
18109
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18110
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18111
+ */
18112
+ getGamificationInsightsDetails(filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday) {
18113
+ // verify the required parameter 'filterType' is set
18114
+ if (filterType === undefined || filterType === null) {
18115
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsDetails';
18116
+ }
18117
+ // verify the required parameter 'filterId' is set
18118
+ if (filterId === undefined || filterId === null) {
18119
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsDetails';
18120
+ }
18121
+ // verify the required parameter 'granularity' is set
18122
+ if (granularity === undefined || granularity === null) {
18123
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsDetails';
18124
+ }
18125
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
18126
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
18127
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsDetails';
18128
+ }
18129
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
18130
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
18131
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsDetails';
18132
+ }
18133
+
18134
+ return this.apiClient.callApi(
18135
+ '/api/v2/gamification/insights/details',
18136
+ 'GET',
18137
+ { },
18138
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday },
18139
+ { },
18140
+ { },
18141
+ null,
18142
+ ['PureCloud OAuth'],
18143
+ ['application/json'],
18144
+ ['application/json']
18145
+ );
18146
+ }
18147
+
18148
+ /**
18149
+ * Get insights overall trend for the current user
18150
+ *
18151
+ * @param {Object} filterType Filter type for the query request.
18152
+ * @param {String} filterId ID for the filter type.
18153
+ * @param {Object} granularity Granularity
18154
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18155
+ * @param {String} comparativePeriodEndWorkday The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18156
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18157
+ * @param {String} primaryPeriodEndWorkday The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18158
+ */
18159
+ getGamificationInsightsGroupsTrends(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday) {
18160
+ // verify the required parameter 'filterType' is set
18161
+ if (filterType === undefined || filterType === null) {
18162
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsGroupsTrends';
18163
+ }
18164
+ // verify the required parameter 'filterId' is set
18165
+ if (filterId === undefined || filterId === null) {
18166
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsGroupsTrends';
18167
+ }
18168
+ // verify the required parameter 'granularity' is set
18169
+ if (granularity === undefined || granularity === null) {
18170
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsGroupsTrends';
18171
+ }
18172
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
18173
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
18174
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsGroupsTrends';
18175
+ }
18176
+ // verify the required parameter 'comparativePeriodEndWorkday' is set
18177
+ if (comparativePeriodEndWorkday === undefined || comparativePeriodEndWorkday === null) {
18178
+ throw 'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsGroupsTrends';
18179
+ }
18180
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
18181
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
18182
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsGroupsTrends';
18183
+ }
18184
+ // verify the required parameter 'primaryPeriodEndWorkday' is set
18185
+ if (primaryPeriodEndWorkday === undefined || primaryPeriodEndWorkday === null) {
18186
+ throw 'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsGroupsTrends';
18187
+ }
18188
+
18189
+ return this.apiClient.callApi(
18190
+ '/api/v2/gamification/insights/groups/trends',
18191
+ 'GET',
18192
+ { },
18193
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'comparativePeriodEndWorkday': comparativePeriodEndWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'primaryPeriodEndWorkday': primaryPeriodEndWorkday },
18194
+ { },
18195
+ { },
18196
+ null,
18197
+ ['PureCloud OAuth'],
18198
+ ['application/json'],
18199
+ ['application/json']
18200
+ );
18201
+ }
18202
+
18203
+ /**
18204
+ * Get insights overall trend
18205
+ *
18206
+ * @param {Object} filterType Filter type for the query request.
18207
+ * @param {String} filterId ID for the filter type.
18208
+ * @param {Object} granularity Granularity
18209
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18210
+ * @param {String} comparativePeriodEndWorkday The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18211
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18212
+ * @param {String} primaryPeriodEndWorkday The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18213
+ */
18214
+ getGamificationInsightsGroupsTrendsAll(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday) {
18215
+ // verify the required parameter 'filterType' is set
18216
+ if (filterType === undefined || filterType === null) {
18217
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsGroupsTrendsAll';
18218
+ }
18219
+ // verify the required parameter 'filterId' is set
18220
+ if (filterId === undefined || filterId === null) {
18221
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsGroupsTrendsAll';
18222
+ }
18223
+ // verify the required parameter 'granularity' is set
18224
+ if (granularity === undefined || granularity === null) {
18225
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsGroupsTrendsAll';
18226
+ }
18227
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
18228
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
18229
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsGroupsTrendsAll';
18230
+ }
18231
+ // verify the required parameter 'comparativePeriodEndWorkday' is set
18232
+ if (comparativePeriodEndWorkday === undefined || comparativePeriodEndWorkday === null) {
18233
+ throw 'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsGroupsTrendsAll';
18234
+ }
18235
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
18236
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
18237
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsGroupsTrendsAll';
18238
+ }
18239
+ // verify the required parameter 'primaryPeriodEndWorkday' is set
18240
+ if (primaryPeriodEndWorkday === undefined || primaryPeriodEndWorkday === null) {
18241
+ throw 'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsGroupsTrendsAll';
18242
+ }
18243
+
18244
+ return this.apiClient.callApi(
18245
+ '/api/v2/gamification/insights/groups/trends/all',
18246
+ 'GET',
18247
+ { },
18248
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'comparativePeriodEndWorkday': comparativePeriodEndWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'primaryPeriodEndWorkday': primaryPeriodEndWorkday },
18249
+ { },
18250
+ { },
18251
+ null,
18252
+ ['PureCloud OAuth'],
18253
+ ['application/json'],
18254
+ ['application/json']
18255
+ );
18256
+ }
18257
+
18258
+ /**
18259
+ * Query users in a profile during a period of time
18260
+ *
18261
+ * @param {Object} filterType Filter type for the query request.
18262
+ * @param {String} filterId ID for the filter type.
18263
+ * @param {Object} granularity Granularity
18264
+ * @param {String} startWorkday The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18265
+ */
18266
+ getGamificationInsightsMembers(filterType, filterId, granularity, startWorkday) {
18267
+ // verify the required parameter 'filterType' is set
18268
+ if (filterType === undefined || filterType === null) {
18269
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsMembers';
18270
+ }
18271
+ // verify the required parameter 'filterId' is set
18272
+ if (filterId === undefined || filterId === null) {
18273
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsMembers';
18274
+ }
18275
+ // verify the required parameter 'granularity' is set
18276
+ if (granularity === undefined || granularity === null) {
18277
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsMembers';
18278
+ }
18279
+ // verify the required parameter 'startWorkday' is set
18280
+ if (startWorkday === undefined || startWorkday === null) {
18281
+ throw 'Missing the required parameter "startWorkday" when calling getGamificationInsightsMembers';
18282
+ }
18283
+
18284
+ return this.apiClient.callApi(
18285
+ '/api/v2/gamification/insights/members',
18286
+ 'GET',
18287
+ { },
18288
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'startWorkday': startWorkday },
18289
+ { },
18290
+ { },
18291
+ null,
18292
+ ['PureCloud OAuth'],
18293
+ ['application/json'],
18294
+ ['application/json']
18295
+ );
18296
+ }
18297
+
18298
+ /**
18299
+ * Get insights user trend for the current user
18300
+ *
18301
+ * @param {Object} filterType Filter type for the query request.
18302
+ * @param {String} filterId ID for the filter type.
18303
+ * @param {Object} granularity Granularity
18304
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18305
+ * @param {String} comparativePeriodEndWorkday The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18306
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18307
+ * @param {String} primaryPeriodEndWorkday The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18308
+ */
18309
+ getGamificationInsightsTrends(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday) {
18310
+ // verify the required parameter 'filterType' is set
18311
+ if (filterType === undefined || filterType === null) {
18312
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsTrends';
18313
+ }
18314
+ // verify the required parameter 'filterId' is set
18315
+ if (filterId === undefined || filterId === null) {
18316
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsTrends';
18317
+ }
18318
+ // verify the required parameter 'granularity' is set
18319
+ if (granularity === undefined || granularity === null) {
18320
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsTrends';
18321
+ }
18322
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
18323
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
18324
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsTrends';
18325
+ }
18326
+ // verify the required parameter 'comparativePeriodEndWorkday' is set
18327
+ if (comparativePeriodEndWorkday === undefined || comparativePeriodEndWorkday === null) {
18328
+ throw 'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsTrends';
18329
+ }
18330
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
18331
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
18332
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsTrends';
18333
+ }
18334
+ // verify the required parameter 'primaryPeriodEndWorkday' is set
18335
+ if (primaryPeriodEndWorkday === undefined || primaryPeriodEndWorkday === null) {
18336
+ throw 'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsTrends';
18337
+ }
18338
+
18339
+ return this.apiClient.callApi(
18340
+ '/api/v2/gamification/insights/trends',
18341
+ 'GET',
18342
+ { },
18343
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'comparativePeriodEndWorkday': comparativePeriodEndWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'primaryPeriodEndWorkday': primaryPeriodEndWorkday },
18344
+ { },
18345
+ { },
18346
+ null,
18347
+ ['PureCloud OAuth'],
18348
+ ['application/json'],
18349
+ ['application/json']
18350
+ );
18351
+ }
18352
+
18353
+ /**
18354
+ * Get insights details for the user
18355
+ *
18356
+ * @param {String} userId The ID of a user.
18357
+ * @param {Object} filterType Filter type for the query request.
18358
+ * @param {String} filterId ID for the filter type.
18359
+ * @param {Object} granularity Granularity
18360
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18361
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18362
+ */
18363
+ getGamificationInsightsUserDetails(userId, filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday) {
18364
+ // verify the required parameter 'userId' is set
18365
+ if (userId === undefined || userId === null) {
18366
+ throw 'Missing the required parameter "userId" when calling getGamificationInsightsUserDetails';
18367
+ }
18368
+ // verify the required parameter 'filterType' is set
18369
+ if (filterType === undefined || filterType === null) {
18370
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsUserDetails';
18371
+ }
18372
+ // verify the required parameter 'filterId' is set
18373
+ if (filterId === undefined || filterId === null) {
18374
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsUserDetails';
18375
+ }
18376
+ // verify the required parameter 'granularity' is set
18377
+ if (granularity === undefined || granularity === null) {
18378
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsUserDetails';
18379
+ }
18380
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
18381
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
18382
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsUserDetails';
18383
+ }
18384
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
18385
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
18386
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsUserDetails';
18387
+ }
18388
+
18389
+ return this.apiClient.callApi(
18390
+ '/api/v2/gamification/insights/users/{userId}/details',
18391
+ 'GET',
18392
+ { 'userId': userId },
18393
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday },
18394
+ { },
18395
+ { },
18396
+ null,
18397
+ ['PureCloud OAuth'],
18398
+ ['application/json'],
18399
+ ['application/json']
18400
+ );
18401
+ }
18402
+
18403
+ /**
18404
+ * Get insights user trend for the user
18405
+ *
18406
+ * @param {String} userId The ID of a user.
18407
+ * @param {Object} filterType Filter type for the query request.
18408
+ * @param {String} filterId ID for the filter type.
18409
+ * @param {Object} granularity Granularity
18410
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18411
+ * @param {String} comparativePeriodEndWorkday The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18412
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18413
+ * @param {String} primaryPeriodEndWorkday The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18414
+ */
18415
+ getGamificationInsightsUserTrends(userId, filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday) {
18416
+ // verify the required parameter 'userId' is set
18417
+ if (userId === undefined || userId === null) {
18418
+ throw 'Missing the required parameter "userId" when calling getGamificationInsightsUserTrends';
18419
+ }
18420
+ // verify the required parameter 'filterType' is set
18421
+ if (filterType === undefined || filterType === null) {
18422
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsUserTrends';
18423
+ }
18424
+ // verify the required parameter 'filterId' is set
18425
+ if (filterId === undefined || filterId === null) {
18426
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsUserTrends';
18427
+ }
18428
+ // verify the required parameter 'granularity' is set
18429
+ if (granularity === undefined || granularity === null) {
18430
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsUserTrends';
18431
+ }
18432
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
18433
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
18434
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsUserTrends';
18435
+ }
18436
+ // verify the required parameter 'comparativePeriodEndWorkday' is set
18437
+ if (comparativePeriodEndWorkday === undefined || comparativePeriodEndWorkday === null) {
18438
+ throw 'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsUserTrends';
18439
+ }
18440
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
18441
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
18442
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsUserTrends';
18443
+ }
18444
+ // verify the required parameter 'primaryPeriodEndWorkday' is set
18445
+ if (primaryPeriodEndWorkday === undefined || primaryPeriodEndWorkday === null) {
18446
+ throw 'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsUserTrends';
18447
+ }
18448
+
18449
+ return this.apiClient.callApi(
18450
+ '/api/v2/gamification/insights/users/{userId}/trends',
18451
+ 'GET',
18452
+ { 'userId': userId },
18453
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'comparativePeriodEndWorkday': comparativePeriodEndWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'primaryPeriodEndWorkday': primaryPeriodEndWorkday },
18454
+ { },
18455
+ { },
18456
+ null,
18457
+ ['PureCloud OAuth'],
18458
+ ['application/json'],
18459
+ ['application/json']
18460
+ );
18461
+ }
18462
+
18049
18463
  /**
18050
18464
  * Leaderboard of the requesting user's division or performance profile
18051
18465
  *
@@ -19478,6 +19892,61 @@ class GamificationApi {
19478
19892
  );
19479
19893
  }
19480
19894
 
19895
+ /**
19896
+ * Query performance profiles in date range for a user
19897
+ *
19898
+ * @param {String} userId The ID of a user.
19899
+ * @param {Object} body The date range of work day.
19900
+ */
19901
+ postGamificationProfilesUserQuery(userId, body) {
19902
+ // verify the required parameter 'userId' is set
19903
+ if (userId === undefined || userId === null) {
19904
+ throw 'Missing the required parameter "userId" when calling postGamificationProfilesUserQuery';
19905
+ }
19906
+ // verify the required parameter 'body' is set
19907
+ if (body === undefined || body === null) {
19908
+ throw 'Missing the required parameter "body" when calling postGamificationProfilesUserQuery';
19909
+ }
19910
+
19911
+ return this.apiClient.callApi(
19912
+ '/api/v2/gamification/profiles/users/{userId}/query',
19913
+ 'POST',
19914
+ { 'userId': userId },
19915
+ { },
19916
+ { },
19917
+ { },
19918
+ body,
19919
+ ['PureCloud OAuth'],
19920
+ ['application/json'],
19921
+ ['application/json']
19922
+ );
19923
+ }
19924
+
19925
+ /**
19926
+ * Query performance profiles in date range for the current user
19927
+ *
19928
+ * @param {Object} body The date range of work day.
19929
+ */
19930
+ postGamificationProfilesUsersMeQuery(body) {
19931
+ // verify the required parameter 'body' is set
19932
+ if (body === undefined || body === null) {
19933
+ throw 'Missing the required parameter "body" when calling postGamificationProfilesUsersMeQuery';
19934
+ }
19935
+
19936
+ return this.apiClient.callApi(
19937
+ '/api/v2/gamification/profiles/users/me/query',
19938
+ 'POST',
19939
+ { },
19940
+ { },
19941
+ { },
19942
+ { },
19943
+ body,
19944
+ ['PureCloud OAuth'],
19945
+ ['application/json'],
19946
+ ['application/json']
19947
+ );
19948
+ }
19949
+
19481
19950
  /**
19482
19951
  * Updates a performance profile
19483
19952
  *
@@ -19573,7 +20042,7 @@ class GeneralDataProtectionRegulationApi {
19573
20042
  /**
19574
20043
  * GeneralDataProtectionRegulation service.
19575
20044
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
19576
- * @version 166.0.0
20045
+ * @version 167.0.0
19577
20046
  */
19578
20047
 
19579
20048
  /**
@@ -19703,7 +20172,7 @@ class GeolocationApi {
19703
20172
  /**
19704
20173
  * Geolocation service.
19705
20174
  * @module purecloud-platform-client-v2/api/GeolocationApi
19706
- * @version 166.0.0
20175
+ * @version 167.0.0
19707
20176
  */
19708
20177
 
19709
20178
  /**
@@ -19834,7 +20303,7 @@ class GreetingsApi {
19834
20303
  /**
19835
20304
  * Greetings service.
19836
20305
  * @module purecloud-platform-client-v2/api/GreetingsApi
19837
- * @version 166.0.0
20306
+ * @version 167.0.0
19838
20307
  */
19839
20308
 
19840
20309
  /**
@@ -20289,7 +20758,7 @@ class GroupsApi {
20289
20758
  /**
20290
20759
  * Groups service.
20291
20760
  * @module purecloud-platform-client-v2/api/GroupsApi
20292
- * @version 166.0.0
20761
+ * @version 167.0.0
20293
20762
  */
20294
20763
 
20295
20764
  /**
@@ -20695,7 +21164,7 @@ class IdentityProviderApi {
20695
21164
  /**
20696
21165
  * IdentityProvider service.
20697
21166
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
20698
- * @version 166.0.0
21167
+ * @version 167.0.0
20699
21168
  */
20700
21169
 
20701
21170
  /**
@@ -21451,7 +21920,7 @@ class InfrastructureAsCodeApi {
21451
21920
  /**
21452
21921
  * InfrastructureAsCode service.
21453
21922
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
21454
- * @version 166.0.0
21923
+ * @version 167.0.0
21455
21924
  */
21456
21925
 
21457
21926
  /**
@@ -21553,7 +22022,7 @@ class IntegrationsApi {
21553
22022
  /**
21554
22023
  * Integrations service.
21555
22024
  * @module purecloud-platform-client-v2/api/IntegrationsApi
21556
- * @version 166.0.0
22025
+ * @version 167.0.0
21557
22026
  */
21558
22027
 
21559
22028
  /**
@@ -23153,7 +23622,7 @@ class JourneyApi {
23153
23622
  /**
23154
23623
  * Journey service.
23155
23624
  * @module purecloud-platform-client-v2/api/JourneyApi
23156
- * @version 166.0.0
23625
+ * @version 167.0.0
23157
23626
  */
23158
23627
 
23159
23628
  /**
@@ -24033,7 +24502,7 @@ class KnowledgeApi {
24033
24502
  /**
24034
24503
  * Knowledge service.
24035
24504
  * @module purecloud-platform-client-v2/api/KnowledgeApi
24036
- * @version 166.0.0
24505
+ * @version 167.0.0
24037
24506
  */
24038
24507
 
24039
24508
  /**
@@ -26465,7 +26934,7 @@ class LanguageUnderstandingApi {
26465
26934
  /**
26466
26935
  * LanguageUnderstanding service.
26467
26936
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
26468
- * @version 166.0.0
26937
+ * @version 167.0.0
26469
26938
  */
26470
26939
 
26471
26940
  /**
@@ -27478,7 +27947,7 @@ class LanguagesApi {
27478
27947
  /**
27479
27948
  * Languages service.
27480
27949
  * @module purecloud-platform-client-v2/api/LanguagesApi
27481
- * @version 166.0.0
27950
+ * @version 167.0.0
27482
27951
  */
27483
27952
 
27484
27953
  /**
@@ -27696,7 +28165,7 @@ class LearningApi {
27696
28165
  /**
27697
28166
  * Learning service.
27698
28167
  * @module purecloud-platform-client-v2/api/LearningApi
27699
- * @version 166.0.0
28168
+ * @version 167.0.0
27700
28169
  */
27701
28170
 
27702
28171
  /**
@@ -28511,7 +28980,7 @@ class LicenseApi {
28511
28980
  /**
28512
28981
  * License service.
28513
28982
  * @module purecloud-platform-client-v2/api/LicenseApi
28514
- * @version 166.0.0
28983
+ * @version 167.0.0
28515
28984
  */
28516
28985
 
28517
28986
  /**
@@ -28749,7 +29218,7 @@ class LocationsApi {
28749
29218
  /**
28750
29219
  * Locations service.
28751
29220
  * @module purecloud-platform-client-v2/api/LocationsApi
28752
- * @version 166.0.0
29221
+ * @version 167.0.0
28753
29222
  */
28754
29223
 
28755
29224
  /**
@@ -28985,7 +29454,7 @@ class MessagingApi {
28985
29454
  /**
28986
29455
  * Messaging service.
28987
29456
  * @module purecloud-platform-client-v2/api/MessagingApi
28988
- * @version 166.0.0
29457
+ * @version 167.0.0
28989
29458
  */
28990
29459
 
28991
29460
  /**
@@ -29136,7 +29605,7 @@ class MobileDevicesApi {
29136
29605
  /**
29137
29606
  * MobileDevices service.
29138
29607
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
29139
- * @version 166.0.0
29608
+ * @version 167.0.0
29140
29609
  */
29141
29610
 
29142
29611
  /**
@@ -29287,7 +29756,7 @@ class NotificationsApi {
29287
29756
  /**
29288
29757
  * Notifications service.
29289
29758
  * @module purecloud-platform-client-v2/api/NotificationsApi
29290
- * @version 166.0.0
29759
+ * @version 167.0.0
29291
29760
  */
29292
29761
 
29293
29762
  /**
@@ -29520,7 +29989,7 @@ class OAuthApi {
29520
29989
  /**
29521
29990
  * OAuth service.
29522
29991
  * @module purecloud-platform-client-v2/api/OAuthApi
29523
- * @version 166.0.0
29992
+ * @version 167.0.0
29524
29993
  */
29525
29994
 
29526
29995
  /**
@@ -29886,7 +30355,7 @@ class ObjectsApi {
29886
30355
  /**
29887
30356
  * Objects service.
29888
30357
  * @module purecloud-platform-client-v2/api/ObjectsApi
29889
- * @version 166.0.0
30358
+ * @version 167.0.0
29890
30359
  */
29891
30360
 
29892
30361
  /**
@@ -30157,7 +30626,7 @@ class OrganizationApi {
30157
30626
  /**
30158
30627
  * Organization service.
30159
30628
  * @module purecloud-platform-client-v2/api/OrganizationApi
30160
- * @version 166.0.0
30629
+ * @version 167.0.0
30161
30630
  */
30162
30631
 
30163
30632
  /**
@@ -30560,7 +31029,7 @@ class OrganizationAuthorizationApi {
30560
31029
  /**
30561
31030
  * OrganizationAuthorization service.
30562
31031
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
30563
- * @version 166.0.0
31032
+ * @version 167.0.0
30564
31033
  */
30565
31034
 
30566
31035
  /**
@@ -31855,7 +32324,7 @@ class OutboundApi {
31855
32324
  /**
31856
32325
  * Outbound service.
31857
32326
  * @module purecloud-platform-client-v2/api/OutboundApi
31858
- * @version 166.0.0
32327
+ * @version 167.0.0
31859
32328
  */
31860
32329
 
31861
32330
  /**
@@ -35451,7 +35920,7 @@ class PresenceApi {
35451
35920
  /**
35452
35921
  * Presence service.
35453
35922
  * @module purecloud-platform-client-v2/api/PresenceApi
35454
- * @version 166.0.0
35923
+ * @version 167.0.0
35455
35924
  */
35456
35925
 
35457
35926
  /**
@@ -36002,7 +36471,7 @@ class ProcessAutomationApi {
36002
36471
  /**
36003
36472
  * ProcessAutomation service.
36004
36473
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
36005
- * @version 166.0.0
36474
+ * @version 167.0.0
36006
36475
  */
36007
36476
 
36008
36477
  /**
@@ -36241,7 +36710,7 @@ class QualityApi {
36241
36710
  /**
36242
36711
  * Quality service.
36243
36712
  * @module purecloud-platform-client-v2/api/QualityApi
36244
- * @version 166.0.0
36713
+ * @version 167.0.0
36245
36714
  */
36246
36715
 
36247
36716
  /**
@@ -37820,7 +38289,7 @@ class RecordingApi {
37820
38289
  /**
37821
38290
  * Recording service.
37822
38291
  * @module purecloud-platform-client-v2/api/RecordingApi
37823
- * @version 166.0.0
38292
+ * @version 167.0.0
37824
38293
  */
37825
38294
 
37826
38295
  /**
@@ -39457,7 +39926,7 @@ class ResponseManagementApi {
39457
39926
  /**
39458
39927
  * ResponseManagement service.
39459
39928
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
39460
- * @version 166.0.0
39929
+ * @version 167.0.0
39461
39930
  */
39462
39931
 
39463
39932
  /**
@@ -39941,7 +40410,7 @@ class RoutingApi {
39941
40410
  /**
39942
40411
  * Routing service.
39943
40412
  * @module purecloud-platform-client-v2/api/RoutingApi
39944
- * @version 166.0.0
40413
+ * @version 167.0.0
39945
40414
  */
39946
40415
 
39947
40416
  /**
@@ -41051,6 +41520,7 @@ class RoutingApi {
41051
41520
  *
41052
41521
  * @param {Object} opts Optional parameters
41053
41522
  * @param {Object} opts.kpiGroup The Group of Key Performance Indicators to return
41523
+ * @param {Array.<String>} opts.expand Parameter to request additional data to return in KPI payload
41054
41524
  */
41055
41525
  getRoutingPredictorsKeyperformanceindicators(opts) {
41056
41526
  opts = opts || {};
@@ -41060,7 +41530,7 @@ class RoutingApi {
41060
41530
  '/api/v2/routing/predictors/keyperformanceindicators',
41061
41531
  'GET',
41062
41532
  { },
41063
- { 'kpiGroup': opts['kpiGroup'] },
41533
+ { 'kpiGroup': opts['kpiGroup'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
41064
41534
  { },
41065
41535
  { },
41066
41536
  null,
@@ -43449,7 +43919,7 @@ class SCIMApi {
43449
43919
  /**
43450
43920
  * SCIM service.
43451
43921
  * @module purecloud-platform-client-v2/api/SCIMApi
43452
- * @version 166.0.0
43922
+ * @version 167.0.0
43453
43923
  */
43454
43924
 
43455
43925
  /**
@@ -44326,7 +44796,7 @@ class ScriptsApi {
44326
44796
  /**
44327
44797
  * Scripts service.
44328
44798
  * @module purecloud-platform-client-v2/api/ScriptsApi
44329
- * @version 166.0.0
44799
+ * @version 167.0.0
44330
44800
  */
44331
44801
 
44332
44802
  /**
@@ -44745,7 +45215,7 @@ class SearchApi {
44745
45215
  /**
44746
45216
  * Search service.
44747
45217
  * @module purecloud-platform-client-v2/api/SearchApi
44748
- * @version 166.0.0
45218
+ * @version 167.0.0
44749
45219
  */
44750
45220
 
44751
45221
  /**
@@ -45355,7 +45825,7 @@ class SpeechTextAnalyticsApi {
45355
45825
  /**
45356
45826
  * SpeechTextAnalytics service.
45357
45827
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
45358
- * @version 166.0.0
45828
+ * @version 167.0.0
45359
45829
  */
45360
45830
 
45361
45831
  /**
@@ -46284,7 +46754,7 @@ class StationsApi {
46284
46754
  /**
46285
46755
  * Stations service.
46286
46756
  * @module purecloud-platform-client-v2/api/StationsApi
46287
- * @version 166.0.0
46757
+ * @version 167.0.0
46288
46758
  */
46289
46759
 
46290
46760
  /**
@@ -46431,7 +46901,7 @@ class SuggestApi {
46431
46901
  /**
46432
46902
  * Suggest service.
46433
46903
  * @module purecloud-platform-client-v2/api/SuggestApi
46434
- * @version 166.0.0
46904
+ * @version 167.0.0
46435
46905
  */
46436
46906
 
46437
46907
  /**
@@ -46570,7 +47040,7 @@ class TeamsApi {
46570
47040
  /**
46571
47041
  * Teams service.
46572
47042
  * @module purecloud-platform-client-v2/api/TeamsApi
46573
- * @version 166.0.0
47043
+ * @version 167.0.0
46574
47044
  */
46575
47045
 
46576
47046
  /**
@@ -46841,7 +47311,7 @@ class TelephonyApi {
46841
47311
  /**
46842
47312
  * Telephony service.
46843
47313
  * @module purecloud-platform-client-v2/api/TelephonyApi
46844
- * @version 166.0.0
47314
+ * @version 167.0.0
46845
47315
  */
46846
47316
 
46847
47317
  /**
@@ -46969,7 +47439,7 @@ class TelephonyProvidersEdgeApi {
46969
47439
  /**
46970
47440
  * TelephonyProvidersEdge service.
46971
47441
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
46972
- * @version 166.0.0
47442
+ * @version 167.0.0
46973
47443
  */
46974
47444
 
46975
47445
  /**
@@ -47164,31 +47634,6 @@ class TelephonyProvidersEdgeApi {
47164
47634
  );
47165
47635
  }
47166
47636
 
47167
- /**
47168
- * Delete Outbound Route
47169
- * This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} instead.
47170
- * @param {String} outboundRouteId Outbound route ID
47171
- */
47172
- deleteTelephonyProvidersEdgesOutboundroute(outboundRouteId) {
47173
- // verify the required parameter 'outboundRouteId' is set
47174
- if (outboundRouteId === undefined || outboundRouteId === null) {
47175
- throw 'Missing the required parameter "outboundRouteId" when calling deleteTelephonyProvidersEdgesOutboundroute';
47176
- }
47177
-
47178
- return this.apiClient.callApi(
47179
- '/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}',
47180
- 'DELETE',
47181
- { 'outboundRouteId': outboundRouteId },
47182
- { },
47183
- { },
47184
- { },
47185
- null,
47186
- ['PureCloud OAuth'],
47187
- ['application/json'],
47188
- ['application/json']
47189
- );
47190
- }
47191
-
47192
47637
  /**
47193
47638
  * Delete a Phone by ID
47194
47639
  *
@@ -49603,31 +50048,6 @@ class TelephonyProvidersEdgeApi {
49603
50048
  );
49604
50049
  }
49605
50050
 
49606
- /**
49607
- * Create outbound rule
49608
- * This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes instead.
49609
- * @param {Object} body OutboundRoute
49610
- */
49611
- postTelephonyProvidersEdgesOutboundroutes(body) {
49612
- // verify the required parameter 'body' is set
49613
- if (body === undefined || body === null) {
49614
- throw 'Missing the required parameter "body" when calling postTelephonyProvidersEdgesOutboundroutes';
49615
- }
49616
-
49617
- return this.apiClient.callApi(
49618
- '/api/v2/telephony/providers/edges/outboundroutes',
49619
- 'POST',
49620
- { },
49621
- { },
49622
- { },
49623
- { },
49624
- body,
49625
- ['PureCloud OAuth'],
49626
- ['application/json'],
49627
- ['application/json']
49628
- );
49629
- }
49630
-
49631
50051
  /**
49632
50052
  * Reboot a Phone
49633
50053
  *
@@ -50028,36 +50448,6 @@ class TelephonyProvidersEdgeApi {
50028
50448
  );
50029
50449
  }
50030
50450
 
50031
- /**
50032
- * Update outbound route
50033
- * This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} instead.
50034
- * @param {String} outboundRouteId Outbound route ID
50035
- * @param {Object} body OutboundRoute
50036
- */
50037
- putTelephonyProvidersEdgesOutboundroute(outboundRouteId, body) {
50038
- // verify the required parameter 'outboundRouteId' is set
50039
- if (outboundRouteId === undefined || outboundRouteId === null) {
50040
- throw 'Missing the required parameter "outboundRouteId" when calling putTelephonyProvidersEdgesOutboundroute';
50041
- }
50042
- // verify the required parameter 'body' is set
50043
- if (body === undefined || body === null) {
50044
- throw 'Missing the required parameter "body" when calling putTelephonyProvidersEdgesOutboundroute';
50045
- }
50046
-
50047
- return this.apiClient.callApi(
50048
- '/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}',
50049
- 'PUT',
50050
- { 'outboundRouteId': outboundRouteId },
50051
- { },
50052
- { },
50053
- { },
50054
- body,
50055
- ['PureCloud OAuth'],
50056
- ['application/json'],
50057
- ['application/json']
50058
- );
50059
- }
50060
-
50061
50451
  /**
50062
50452
  * Update a Phone by ID
50063
50453
  *
@@ -50249,7 +50639,7 @@ class TextbotsApi {
50249
50639
  /**
50250
50640
  * Textbots service.
50251
50641
  * @module purecloud-platform-client-v2/api/TextbotsApi
50252
- * @version 166.0.0
50642
+ * @version 167.0.0
50253
50643
  */
50254
50644
 
50255
50645
  /**
@@ -50377,7 +50767,7 @@ class TokensApi {
50377
50767
  /**
50378
50768
  * Tokens service.
50379
50769
  * @module purecloud-platform-client-v2/api/TokensApi
50380
- * @version 166.0.0
50770
+ * @version 167.0.0
50381
50771
  */
50382
50772
 
50383
50773
  /**
@@ -50483,7 +50873,7 @@ class UploadsApi {
50483
50873
  /**
50484
50874
  * Uploads service.
50485
50875
  * @module purecloud-platform-client-v2/api/UploadsApi
50486
- * @version 166.0.0
50876
+ * @version 167.0.0
50487
50877
  */
50488
50878
 
50489
50879
  /**
@@ -50659,7 +51049,7 @@ class UsageApi {
50659
51049
  /**
50660
51050
  * Usage service.
50661
51051
  * @module purecloud-platform-client-v2/api/UsageApi
50662
- * @version 166.0.0
51052
+ * @version 167.0.0
50663
51053
  */
50664
51054
 
50665
51055
  /**
@@ -50819,7 +51209,7 @@ class UserRecordingsApi {
50819
51209
  /**
50820
51210
  * UserRecordings service.
50821
51211
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
50822
- * @version 166.0.0
51212
+ * @version 167.0.0
50823
51213
  */
50824
51214
 
50825
51215
  /**
@@ -51004,7 +51394,7 @@ class UsersApi {
51004
51394
  /**
51005
51395
  * Users service.
51006
51396
  * @module purecloud-platform-client-v2/api/UsersApi
51007
- * @version 166.0.0
51397
+ * @version 167.0.0
51008
51398
  */
51009
51399
 
51010
51400
  /**
@@ -53394,7 +53784,7 @@ class UtilitiesApi {
53394
53784
  /**
53395
53785
  * Utilities service.
53396
53786
  * @module purecloud-platform-client-v2/api/UtilitiesApi
53397
- * @version 166.0.0
53787
+ * @version 167.0.0
53398
53788
  */
53399
53789
 
53400
53790
  /**
@@ -53505,7 +53895,7 @@ class VoicemailApi {
53505
53895
  /**
53506
53896
  * Voicemail service.
53507
53897
  * @module purecloud-platform-client-v2/api/VoicemailApi
53508
- * @version 166.0.0
53898
+ * @version 167.0.0
53509
53899
  */
53510
53900
 
53511
53901
  /**
@@ -54172,7 +54562,7 @@ class WebChatApi {
54172
54562
  /**
54173
54563
  * WebChat service.
54174
54564
  * @module purecloud-platform-client-v2/api/WebChatApi
54175
- * @version 166.0.0
54565
+ * @version 167.0.0
54176
54566
  */
54177
54567
 
54178
54568
  /**
@@ -54716,7 +55106,7 @@ class WebDeploymentsApi {
54716
55106
  /**
54717
55107
  * WebDeployments service.
54718
55108
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
54719
- * @version 166.0.0
55109
+ * @version 167.0.0
54720
55110
  */
54721
55111
 
54722
55112
  /**
@@ -55238,7 +55628,7 @@ class WebMessagingApi {
55238
55628
  /**
55239
55629
  * WebMessaging service.
55240
55630
  * @module purecloud-platform-client-v2/api/WebMessagingApi
55241
- * @version 166.0.0
55631
+ * @version 167.0.0
55242
55632
  */
55243
55633
 
55244
55634
  /**
@@ -55284,7 +55674,7 @@ class WidgetsApi {
55284
55674
  /**
55285
55675
  * Widgets service.
55286
55676
  * @module purecloud-platform-client-v2/api/WidgetsApi
55287
- * @version 166.0.0
55677
+ * @version 167.0.0
55288
55678
  */
55289
55679
 
55290
55680
  /**
@@ -55430,7 +55820,7 @@ class WorkforceManagementApi {
55430
55820
  /**
55431
55821
  * WorkforceManagement service.
55432
55822
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
55433
- * @version 166.0.0
55823
+ * @version 167.0.0
55434
55824
  */
55435
55825
 
55436
55826
  /**
@@ -58353,7 +58743,7 @@ class WorkforceManagementApi {
58353
58743
  }
58354
58744
 
58355
58745
  /**
58356
- * Request a historical adherence report for users across management units
58746
+ * Deprecated. Use bulk routes instead (/adherence/historical/bulk)
58357
58747
  *
58358
58748
  * @param {Object} opts Optional parameters
58359
58749
  * @param {Object} opts.body body
@@ -60174,7 +60564,7 @@ class WorkforceManagementApi {
60174
60564
  * </pre>
60175
60565
  * </p>
60176
60566
  * @module purecloud-platform-client-v2/index
60177
- * @version 166.0.0
60567
+ * @version 167.0.0
60178
60568
  */
60179
60569
  class platformClient {
60180
60570
  constructor() {