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
@@ -399,7 +399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
399
399
 
400
400
  /**
401
401
  * @module purecloud-platform-client-v2/ApiClient
402
- * @version 166.0.0
402
+ * @version 167.0.0
403
403
  */
404
404
  class ApiClient {
405
405
  /**
@@ -1485,7 +1485,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
1485
1485
  /**
1486
1486
  * Alerting service.
1487
1487
  * @module purecloud-platform-client-v2/api/AlertingApi
1488
- * @version 166.0.0
1488
+ * @version 167.0.0
1489
1489
  */
1490
1490
 
1491
1491
  /**
@@ -1799,7 +1799,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
1799
1799
  /**
1800
1800
  * Analytics service.
1801
1801
  * @module purecloud-platform-client-v2/api/AnalyticsApi
1802
- * @version 166.0.0
1802
+ * @version 167.0.0
1803
1803
  */
1804
1804
 
1805
1805
  /**
@@ -3053,7 +3053,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3053
3053
  /**
3054
3054
  * Architect service.
3055
3055
  * @module purecloud-platform-client-v2/api/ArchitectApi
3056
- * @version 166.0.0
3056
+ * @version 167.0.0
3057
3057
  */
3058
3058
 
3059
3059
  /**
@@ -6101,7 +6101,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
6101
6101
  /**
6102
6102
  * Audit service.
6103
6103
  * @module purecloud-platform-client-v2/api/AuditApi
6104
- * @version 166.0.0
6104
+ * @version 167.0.0
6105
6105
  */
6106
6106
 
6107
6107
  /**
@@ -6214,7 +6214,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
6214
6214
 
6215
6215
  /**
6216
6216
  * Create audit query execution
6217
- *
6217
+ * Use /api/v2/audits/query/servicemapping endpoint for a list of valid values
6218
6218
  * @param {Object} body query
6219
6219
  */
6220
6220
  postAuditsQuery(body) {
@@ -6239,7 +6239,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
6239
6239
 
6240
6240
  /**
6241
6241
  * This endpoint will only retrieve 14 days worth of audits for certain services. Please use /query to get a full list and older audits.
6242
- *
6242
+ * Use /api/v2/audits/query/realtime/servicemapping endpoint for a list of valid values
6243
6243
  * @param {Object} body query
6244
6244
  * @param {Object} opts Optional parameters
6245
6245
  * @param {Array.<String>} opts.expand Which fields, if any, to expand
@@ -6272,7 +6272,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
6272
6272
  /**
6273
6273
  * Authorization service.
6274
6274
  * @module purecloud-platform-client-v2/api/AuthorizationApi
6275
- * @version 166.0.0
6275
+ * @version 167.0.0
6276
6276
  */
6277
6277
 
6278
6278
  /**
@@ -7501,7 +7501,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
7501
7501
  /**
7502
7502
  * Billing service.
7503
7503
  * @module purecloud-platform-client-v2/api/BillingApi
7504
- * @version 166.0.0
7504
+ * @version 167.0.0
7505
7505
  */
7506
7506
 
7507
7507
  /**
@@ -7581,7 +7581,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
7581
7581
  /**
7582
7582
  * Chat service.
7583
7583
  * @module purecloud-platform-client-v2/api/ChatApi
7584
- * @version 166.0.0
7584
+ * @version 167.0.0
7585
7585
  */
7586
7586
 
7587
7587
  /**
@@ -7742,7 +7742,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
7742
7742
  /**
7743
7743
  * Coaching service.
7744
7744
  * @module purecloud-platform-client-v2/api/CoachingApi
7745
- * @version 166.0.0
7745
+ * @version 167.0.0
7746
7746
  */
7747
7747
 
7748
7748
  /**
@@ -8319,7 +8319,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
8319
8319
  /**
8320
8320
  * ContentManagement service.
8321
8321
  * @module purecloud-platform-client-v2/api/ContentManagementApi
8322
- * @version 166.0.0
8322
+ * @version 167.0.0
8323
8323
  */
8324
8324
 
8325
8325
  /**
@@ -9459,7 +9459,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9459
9459
  /**
9460
9460
  * Conversations service.
9461
9461
  * @module purecloud-platform-client-v2/api/ConversationsApi
9462
- * @version 166.0.0
9462
+ * @version 167.0.0
9463
9463
  */
9464
9464
 
9465
9465
  /**
@@ -15519,7 +15519,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15519
15519
  /**
15520
15520
  * DataExtensions service.
15521
15521
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
15522
- * @version 166.0.0
15522
+ * @version 167.0.0
15523
15523
  */
15524
15524
 
15525
15525
  /**
@@ -15605,7 +15605,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15605
15605
  /**
15606
15606
  * Downloads service.
15607
15607
  * @module purecloud-platform-client-v2/api/DownloadsApi
15608
- * @version 166.0.0
15608
+ * @version 167.0.0
15609
15609
  */
15610
15610
 
15611
15611
  /**
@@ -15657,7 +15657,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15657
15657
  /**
15658
15658
  * Events service.
15659
15659
  * @module purecloud-platform-client-v2/api/EventsApi
15660
- * @version 166.0.0
15660
+ * @version 167.0.0
15661
15661
  */
15662
15662
 
15663
15663
  /**
@@ -15753,7 +15753,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15753
15753
  /**
15754
15754
  * ExternalContacts service.
15755
15755
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
15756
- * @version 166.0.0
15756
+ * @version 167.0.0
15757
15757
  */
15758
15758
 
15759
15759
  /**
@@ -17711,7 +17711,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17711
17711
  /**
17712
17712
  * Fax service.
17713
17713
  * @module purecloud-platform-client-v2/api/FaxApi
17714
- * @version 166.0.0
17714
+ * @version 167.0.0
17715
17715
  */
17716
17716
 
17717
17717
  /**
@@ -17882,7 +17882,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17882
17882
  /**
17883
17883
  * Flows service.
17884
17884
  * @module purecloud-platform-client-v2/api/FlowsApi
17885
- * @version 166.0.0
17885
+ * @version 167.0.0
17886
17886
  */
17887
17887
 
17888
17888
  /**
@@ -17953,7 +17953,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17953
17953
  /**
17954
17954
  * Gamification service.
17955
17955
  * @module purecloud-platform-client-v2/api/GamificationApi
17956
- * @version 166.0.0
17956
+ * @version 167.0.0
17957
17957
  */
17958
17958
 
17959
17959
  /**
@@ -18043,6 +18043,420 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
18043
18043
  );
18044
18044
  }
18045
18045
 
18046
+ /**
18047
+ * Get insights summary
18048
+ *
18049
+ * @param {Object} filterType Filter type for the query request.
18050
+ * @param {String} filterId ID for the filter type.
18051
+ * @param {Object} granularity Granularity
18052
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18053
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18054
+ * @param {Object} opts Optional parameters
18055
+ * @param {Number} opts.pageSize Page size (default to 25)
18056
+ * @param {Number} opts.pageNumber Page number (default to 1)
18057
+ * @param {Object} opts.sortKey Sort key
18058
+ * @param {String} opts.sortMetricId Sort Metric Id
18059
+ * @param {Object} opts.sortOrder Sort order (default to asc)
18060
+ * @param {String} opts.userIds A list of up to 100 comma-separated user Ids
18061
+ */
18062
+ getGamificationInsights(filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday, opts) {
18063
+ opts = opts || {};
18064
+
18065
+ // verify the required parameter 'filterType' is set
18066
+ if (filterType === undefined || filterType === null) {
18067
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsights';
18068
+ }
18069
+ // verify the required parameter 'filterId' is set
18070
+ if (filterId === undefined || filterId === null) {
18071
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsights';
18072
+ }
18073
+ // verify the required parameter 'granularity' is set
18074
+ if (granularity === undefined || granularity === null) {
18075
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsights';
18076
+ }
18077
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
18078
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
18079
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsights';
18080
+ }
18081
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
18082
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
18083
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsights';
18084
+ }
18085
+
18086
+ return this.apiClient.callApi(
18087
+ '/api/v2/gamification/insights',
18088
+ 'GET',
18089
+ { },
18090
+ { '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'] },
18091
+ { },
18092
+ { },
18093
+ null,
18094
+ ['PureCloud OAuth'],
18095
+ ['application/json'],
18096
+ ['application/json']
18097
+ );
18098
+ }
18099
+
18100
+ /**
18101
+ * Get insights details for the current user
18102
+ *
18103
+ * @param {Object} filterType Filter type for the query request.
18104
+ * @param {String} filterId ID for the filter type.
18105
+ * @param {Object} granularity Granularity
18106
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18107
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18108
+ */
18109
+ getGamificationInsightsDetails(filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday) {
18110
+ // verify the required parameter 'filterType' is set
18111
+ if (filterType === undefined || filterType === null) {
18112
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsDetails';
18113
+ }
18114
+ // verify the required parameter 'filterId' is set
18115
+ if (filterId === undefined || filterId === null) {
18116
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsDetails';
18117
+ }
18118
+ // verify the required parameter 'granularity' is set
18119
+ if (granularity === undefined || granularity === null) {
18120
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsDetails';
18121
+ }
18122
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
18123
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
18124
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsDetails';
18125
+ }
18126
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
18127
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
18128
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsDetails';
18129
+ }
18130
+
18131
+ return this.apiClient.callApi(
18132
+ '/api/v2/gamification/insights/details',
18133
+ 'GET',
18134
+ { },
18135
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday },
18136
+ { },
18137
+ { },
18138
+ null,
18139
+ ['PureCloud OAuth'],
18140
+ ['application/json'],
18141
+ ['application/json']
18142
+ );
18143
+ }
18144
+
18145
+ /**
18146
+ * Get insights overall trend for the current user
18147
+ *
18148
+ * @param {Object} filterType Filter type for the query request.
18149
+ * @param {String} filterId ID for the filter type.
18150
+ * @param {Object} granularity Granularity
18151
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18152
+ * @param {String} comparativePeriodEndWorkday The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18153
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18154
+ * @param {String} primaryPeriodEndWorkday The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18155
+ */
18156
+ getGamificationInsightsGroupsTrends(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday) {
18157
+ // verify the required parameter 'filterType' is set
18158
+ if (filterType === undefined || filterType === null) {
18159
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsGroupsTrends';
18160
+ }
18161
+ // verify the required parameter 'filterId' is set
18162
+ if (filterId === undefined || filterId === null) {
18163
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsGroupsTrends';
18164
+ }
18165
+ // verify the required parameter 'granularity' is set
18166
+ if (granularity === undefined || granularity === null) {
18167
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsGroupsTrends';
18168
+ }
18169
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
18170
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
18171
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsGroupsTrends';
18172
+ }
18173
+ // verify the required parameter 'comparativePeriodEndWorkday' is set
18174
+ if (comparativePeriodEndWorkday === undefined || comparativePeriodEndWorkday === null) {
18175
+ throw 'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsGroupsTrends';
18176
+ }
18177
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
18178
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
18179
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsGroupsTrends';
18180
+ }
18181
+ // verify the required parameter 'primaryPeriodEndWorkday' is set
18182
+ if (primaryPeriodEndWorkday === undefined || primaryPeriodEndWorkday === null) {
18183
+ throw 'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsGroupsTrends';
18184
+ }
18185
+
18186
+ return this.apiClient.callApi(
18187
+ '/api/v2/gamification/insights/groups/trends',
18188
+ 'GET',
18189
+ { },
18190
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'comparativePeriodEndWorkday': comparativePeriodEndWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'primaryPeriodEndWorkday': primaryPeriodEndWorkday },
18191
+ { },
18192
+ { },
18193
+ null,
18194
+ ['PureCloud OAuth'],
18195
+ ['application/json'],
18196
+ ['application/json']
18197
+ );
18198
+ }
18199
+
18200
+ /**
18201
+ * Get insights overall trend
18202
+ *
18203
+ * @param {Object} filterType Filter type for the query request.
18204
+ * @param {String} filterId ID for the filter type.
18205
+ * @param {Object} granularity Granularity
18206
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18207
+ * @param {String} comparativePeriodEndWorkday The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18208
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18209
+ * @param {String} primaryPeriodEndWorkday The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18210
+ */
18211
+ getGamificationInsightsGroupsTrendsAll(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday) {
18212
+ // verify the required parameter 'filterType' is set
18213
+ if (filterType === undefined || filterType === null) {
18214
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsGroupsTrendsAll';
18215
+ }
18216
+ // verify the required parameter 'filterId' is set
18217
+ if (filterId === undefined || filterId === null) {
18218
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsGroupsTrendsAll';
18219
+ }
18220
+ // verify the required parameter 'granularity' is set
18221
+ if (granularity === undefined || granularity === null) {
18222
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsGroupsTrendsAll';
18223
+ }
18224
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
18225
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
18226
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsGroupsTrendsAll';
18227
+ }
18228
+ // verify the required parameter 'comparativePeriodEndWorkday' is set
18229
+ if (comparativePeriodEndWorkday === undefined || comparativePeriodEndWorkday === null) {
18230
+ throw 'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsGroupsTrendsAll';
18231
+ }
18232
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
18233
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
18234
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsGroupsTrendsAll';
18235
+ }
18236
+ // verify the required parameter 'primaryPeriodEndWorkday' is set
18237
+ if (primaryPeriodEndWorkday === undefined || primaryPeriodEndWorkday === null) {
18238
+ throw 'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsGroupsTrendsAll';
18239
+ }
18240
+
18241
+ return this.apiClient.callApi(
18242
+ '/api/v2/gamification/insights/groups/trends/all',
18243
+ 'GET',
18244
+ { },
18245
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'comparativePeriodEndWorkday': comparativePeriodEndWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'primaryPeriodEndWorkday': primaryPeriodEndWorkday },
18246
+ { },
18247
+ { },
18248
+ null,
18249
+ ['PureCloud OAuth'],
18250
+ ['application/json'],
18251
+ ['application/json']
18252
+ );
18253
+ }
18254
+
18255
+ /**
18256
+ * Query users in a profile during a period of time
18257
+ *
18258
+ * @param {Object} filterType Filter type for the query request.
18259
+ * @param {String} filterId ID for the filter type.
18260
+ * @param {Object} granularity Granularity
18261
+ * @param {String} startWorkday The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18262
+ */
18263
+ getGamificationInsightsMembers(filterType, filterId, granularity, startWorkday) {
18264
+ // verify the required parameter 'filterType' is set
18265
+ if (filterType === undefined || filterType === null) {
18266
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsMembers';
18267
+ }
18268
+ // verify the required parameter 'filterId' is set
18269
+ if (filterId === undefined || filterId === null) {
18270
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsMembers';
18271
+ }
18272
+ // verify the required parameter 'granularity' is set
18273
+ if (granularity === undefined || granularity === null) {
18274
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsMembers';
18275
+ }
18276
+ // verify the required parameter 'startWorkday' is set
18277
+ if (startWorkday === undefined || startWorkday === null) {
18278
+ throw 'Missing the required parameter "startWorkday" when calling getGamificationInsightsMembers';
18279
+ }
18280
+
18281
+ return this.apiClient.callApi(
18282
+ '/api/v2/gamification/insights/members',
18283
+ 'GET',
18284
+ { },
18285
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'startWorkday': startWorkday },
18286
+ { },
18287
+ { },
18288
+ null,
18289
+ ['PureCloud OAuth'],
18290
+ ['application/json'],
18291
+ ['application/json']
18292
+ );
18293
+ }
18294
+
18295
+ /**
18296
+ * Get insights user trend for the current user
18297
+ *
18298
+ * @param {Object} filterType Filter type for the query request.
18299
+ * @param {String} filterId ID for the filter type.
18300
+ * @param {Object} granularity Granularity
18301
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18302
+ * @param {String} comparativePeriodEndWorkday The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18303
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18304
+ * @param {String} primaryPeriodEndWorkday The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18305
+ */
18306
+ getGamificationInsightsTrends(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday) {
18307
+ // verify the required parameter 'filterType' is set
18308
+ if (filterType === undefined || filterType === null) {
18309
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsTrends';
18310
+ }
18311
+ // verify the required parameter 'filterId' is set
18312
+ if (filterId === undefined || filterId === null) {
18313
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsTrends';
18314
+ }
18315
+ // verify the required parameter 'granularity' is set
18316
+ if (granularity === undefined || granularity === null) {
18317
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsTrends';
18318
+ }
18319
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
18320
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
18321
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsTrends';
18322
+ }
18323
+ // verify the required parameter 'comparativePeriodEndWorkday' is set
18324
+ if (comparativePeriodEndWorkday === undefined || comparativePeriodEndWorkday === null) {
18325
+ throw 'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsTrends';
18326
+ }
18327
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
18328
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
18329
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsTrends';
18330
+ }
18331
+ // verify the required parameter 'primaryPeriodEndWorkday' is set
18332
+ if (primaryPeriodEndWorkday === undefined || primaryPeriodEndWorkday === null) {
18333
+ throw 'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsTrends';
18334
+ }
18335
+
18336
+ return this.apiClient.callApi(
18337
+ '/api/v2/gamification/insights/trends',
18338
+ 'GET',
18339
+ { },
18340
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'comparativePeriodEndWorkday': comparativePeriodEndWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'primaryPeriodEndWorkday': primaryPeriodEndWorkday },
18341
+ { },
18342
+ { },
18343
+ null,
18344
+ ['PureCloud OAuth'],
18345
+ ['application/json'],
18346
+ ['application/json']
18347
+ );
18348
+ }
18349
+
18350
+ /**
18351
+ * Get insights details for the user
18352
+ *
18353
+ * @param {String} userId The ID of a user.
18354
+ * @param {Object} filterType Filter type for the query request.
18355
+ * @param {String} filterId ID for the filter type.
18356
+ * @param {Object} granularity Granularity
18357
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18358
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18359
+ */
18360
+ getGamificationInsightsUserDetails(userId, filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday) {
18361
+ // verify the required parameter 'userId' is set
18362
+ if (userId === undefined || userId === null) {
18363
+ throw 'Missing the required parameter "userId" when calling getGamificationInsightsUserDetails';
18364
+ }
18365
+ // verify the required parameter 'filterType' is set
18366
+ if (filterType === undefined || filterType === null) {
18367
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsUserDetails';
18368
+ }
18369
+ // verify the required parameter 'filterId' is set
18370
+ if (filterId === undefined || filterId === null) {
18371
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsUserDetails';
18372
+ }
18373
+ // verify the required parameter 'granularity' is set
18374
+ if (granularity === undefined || granularity === null) {
18375
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsUserDetails';
18376
+ }
18377
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
18378
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
18379
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsUserDetails';
18380
+ }
18381
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
18382
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
18383
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsUserDetails';
18384
+ }
18385
+
18386
+ return this.apiClient.callApi(
18387
+ '/api/v2/gamification/insights/users/{userId}/details',
18388
+ 'GET',
18389
+ { 'userId': userId },
18390
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday },
18391
+ { },
18392
+ { },
18393
+ null,
18394
+ ['PureCloud OAuth'],
18395
+ ['application/json'],
18396
+ ['application/json']
18397
+ );
18398
+ }
18399
+
18400
+ /**
18401
+ * Get insights user trend for the user
18402
+ *
18403
+ * @param {String} userId The ID of a user.
18404
+ * @param {Object} filterType Filter type for the query request.
18405
+ * @param {String} filterId ID for the filter type.
18406
+ * @param {Object} granularity Granularity
18407
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18408
+ * @param {String} comparativePeriodEndWorkday The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18409
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18410
+ * @param {String} primaryPeriodEndWorkday The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18411
+ */
18412
+ getGamificationInsightsUserTrends(userId, filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday) {
18413
+ // verify the required parameter 'userId' is set
18414
+ if (userId === undefined || userId === null) {
18415
+ throw 'Missing the required parameter "userId" when calling getGamificationInsightsUserTrends';
18416
+ }
18417
+ // verify the required parameter 'filterType' is set
18418
+ if (filterType === undefined || filterType === null) {
18419
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsUserTrends';
18420
+ }
18421
+ // verify the required parameter 'filterId' is set
18422
+ if (filterId === undefined || filterId === null) {
18423
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsUserTrends';
18424
+ }
18425
+ // verify the required parameter 'granularity' is set
18426
+ if (granularity === undefined || granularity === null) {
18427
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsUserTrends';
18428
+ }
18429
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
18430
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
18431
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsUserTrends';
18432
+ }
18433
+ // verify the required parameter 'comparativePeriodEndWorkday' is set
18434
+ if (comparativePeriodEndWorkday === undefined || comparativePeriodEndWorkday === null) {
18435
+ throw 'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsUserTrends';
18436
+ }
18437
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
18438
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
18439
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsUserTrends';
18440
+ }
18441
+ // verify the required parameter 'primaryPeriodEndWorkday' is set
18442
+ if (primaryPeriodEndWorkday === undefined || primaryPeriodEndWorkday === null) {
18443
+ throw 'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsUserTrends';
18444
+ }
18445
+
18446
+ return this.apiClient.callApi(
18447
+ '/api/v2/gamification/insights/users/{userId}/trends',
18448
+ 'GET',
18449
+ { 'userId': userId },
18450
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'comparativePeriodEndWorkday': comparativePeriodEndWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'primaryPeriodEndWorkday': primaryPeriodEndWorkday },
18451
+ { },
18452
+ { },
18453
+ null,
18454
+ ['PureCloud OAuth'],
18455
+ ['application/json'],
18456
+ ['application/json']
18457
+ );
18458
+ }
18459
+
18046
18460
  /**
18047
18461
  * Leaderboard of the requesting user's division or performance profile
18048
18462
  *
@@ -19475,6 +19889,61 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19475
19889
  );
19476
19890
  }
19477
19891
 
19892
+ /**
19893
+ * Query performance profiles in date range for a user
19894
+ *
19895
+ * @param {String} userId The ID of a user.
19896
+ * @param {Object} body The date range of work day.
19897
+ */
19898
+ postGamificationProfilesUserQuery(userId, body) {
19899
+ // verify the required parameter 'userId' is set
19900
+ if (userId === undefined || userId === null) {
19901
+ throw 'Missing the required parameter "userId" when calling postGamificationProfilesUserQuery';
19902
+ }
19903
+ // verify the required parameter 'body' is set
19904
+ if (body === undefined || body === null) {
19905
+ throw 'Missing the required parameter "body" when calling postGamificationProfilesUserQuery';
19906
+ }
19907
+
19908
+ return this.apiClient.callApi(
19909
+ '/api/v2/gamification/profiles/users/{userId}/query',
19910
+ 'POST',
19911
+ { 'userId': userId },
19912
+ { },
19913
+ { },
19914
+ { },
19915
+ body,
19916
+ ['PureCloud OAuth'],
19917
+ ['application/json'],
19918
+ ['application/json']
19919
+ );
19920
+ }
19921
+
19922
+ /**
19923
+ * Query performance profiles in date range for the current user
19924
+ *
19925
+ * @param {Object} body The date range of work day.
19926
+ */
19927
+ postGamificationProfilesUsersMeQuery(body) {
19928
+ // verify the required parameter 'body' is set
19929
+ if (body === undefined || body === null) {
19930
+ throw 'Missing the required parameter "body" when calling postGamificationProfilesUsersMeQuery';
19931
+ }
19932
+
19933
+ return this.apiClient.callApi(
19934
+ '/api/v2/gamification/profiles/users/me/query',
19935
+ 'POST',
19936
+ { },
19937
+ { },
19938
+ { },
19939
+ { },
19940
+ body,
19941
+ ['PureCloud OAuth'],
19942
+ ['application/json'],
19943
+ ['application/json']
19944
+ );
19945
+ }
19946
+
19478
19947
  /**
19479
19948
  * Updates a performance profile
19480
19949
  *
@@ -19570,7 +20039,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19570
20039
  /**
19571
20040
  * GeneralDataProtectionRegulation service.
19572
20041
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
19573
- * @version 166.0.0
20042
+ * @version 167.0.0
19574
20043
  */
19575
20044
 
19576
20045
  /**
@@ -19700,7 +20169,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19700
20169
  /**
19701
20170
  * Geolocation service.
19702
20171
  * @module purecloud-platform-client-v2/api/GeolocationApi
19703
- * @version 166.0.0
20172
+ * @version 167.0.0
19704
20173
  */
19705
20174
 
19706
20175
  /**
@@ -19831,7 +20300,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19831
20300
  /**
19832
20301
  * Greetings service.
19833
20302
  * @module purecloud-platform-client-v2/api/GreetingsApi
19834
- * @version 166.0.0
20303
+ * @version 167.0.0
19835
20304
  */
19836
20305
 
19837
20306
  /**
@@ -20286,7 +20755,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20286
20755
  /**
20287
20756
  * Groups service.
20288
20757
  * @module purecloud-platform-client-v2/api/GroupsApi
20289
- * @version 166.0.0
20758
+ * @version 167.0.0
20290
20759
  */
20291
20760
 
20292
20761
  /**
@@ -20692,7 +21161,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20692
21161
  /**
20693
21162
  * IdentityProvider service.
20694
21163
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
20695
- * @version 166.0.0
21164
+ * @version 167.0.0
20696
21165
  */
20697
21166
 
20698
21167
  /**
@@ -21448,7 +21917,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21448
21917
  /**
21449
21918
  * InfrastructureAsCode service.
21450
21919
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
21451
- * @version 166.0.0
21920
+ * @version 167.0.0
21452
21921
  */
21453
21922
 
21454
21923
  /**
@@ -21550,7 +22019,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21550
22019
  /**
21551
22020
  * Integrations service.
21552
22021
  * @module purecloud-platform-client-v2/api/IntegrationsApi
21553
- * @version 166.0.0
22022
+ * @version 167.0.0
21554
22023
  */
21555
22024
 
21556
22025
  /**
@@ -23150,7 +23619,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23150
23619
  /**
23151
23620
  * Journey service.
23152
23621
  * @module purecloud-platform-client-v2/api/JourneyApi
23153
- * @version 166.0.0
23622
+ * @version 167.0.0
23154
23623
  */
23155
23624
 
23156
23625
  /**
@@ -24030,7 +24499,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24030
24499
  /**
24031
24500
  * Knowledge service.
24032
24501
  * @module purecloud-platform-client-v2/api/KnowledgeApi
24033
- * @version 166.0.0
24502
+ * @version 167.0.0
24034
24503
  */
24035
24504
 
24036
24505
  /**
@@ -26462,7 +26931,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26462
26931
  /**
26463
26932
  * LanguageUnderstanding service.
26464
26933
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
26465
- * @version 166.0.0
26934
+ * @version 167.0.0
26466
26935
  */
26467
26936
 
26468
26937
  /**
@@ -27475,7 +27944,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27475
27944
  /**
27476
27945
  * Languages service.
27477
27946
  * @module purecloud-platform-client-v2/api/LanguagesApi
27478
- * @version 166.0.0
27947
+ * @version 167.0.0
27479
27948
  */
27480
27949
 
27481
27950
  /**
@@ -27693,7 +28162,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27693
28162
  /**
27694
28163
  * Learning service.
27695
28164
  * @module purecloud-platform-client-v2/api/LearningApi
27696
- * @version 166.0.0
28165
+ * @version 167.0.0
27697
28166
  */
27698
28167
 
27699
28168
  /**
@@ -28508,7 +28977,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28508
28977
  /**
28509
28978
  * License service.
28510
28979
  * @module purecloud-platform-client-v2/api/LicenseApi
28511
- * @version 166.0.0
28980
+ * @version 167.0.0
28512
28981
  */
28513
28982
 
28514
28983
  /**
@@ -28746,7 +29215,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28746
29215
  /**
28747
29216
  * Locations service.
28748
29217
  * @module purecloud-platform-client-v2/api/LocationsApi
28749
- * @version 166.0.0
29218
+ * @version 167.0.0
28750
29219
  */
28751
29220
 
28752
29221
  /**
@@ -28982,7 +29451,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28982
29451
  /**
28983
29452
  * Messaging service.
28984
29453
  * @module purecloud-platform-client-v2/api/MessagingApi
28985
- * @version 166.0.0
29454
+ * @version 167.0.0
28986
29455
  */
28987
29456
 
28988
29457
  /**
@@ -29133,7 +29602,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29133
29602
  /**
29134
29603
  * MobileDevices service.
29135
29604
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
29136
- * @version 166.0.0
29605
+ * @version 167.0.0
29137
29606
  */
29138
29607
 
29139
29608
  /**
@@ -29284,7 +29753,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29284
29753
  /**
29285
29754
  * Notifications service.
29286
29755
  * @module purecloud-platform-client-v2/api/NotificationsApi
29287
- * @version 166.0.0
29756
+ * @version 167.0.0
29288
29757
  */
29289
29758
 
29290
29759
  /**
@@ -29517,7 +29986,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29517
29986
  /**
29518
29987
  * OAuth service.
29519
29988
  * @module purecloud-platform-client-v2/api/OAuthApi
29520
- * @version 166.0.0
29989
+ * @version 167.0.0
29521
29990
  */
29522
29991
 
29523
29992
  /**
@@ -29883,7 +30352,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29883
30352
  /**
29884
30353
  * Objects service.
29885
30354
  * @module purecloud-platform-client-v2/api/ObjectsApi
29886
- * @version 166.0.0
30355
+ * @version 167.0.0
29887
30356
  */
29888
30357
 
29889
30358
  /**
@@ -30154,7 +30623,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30154
30623
  /**
30155
30624
  * Organization service.
30156
30625
  * @module purecloud-platform-client-v2/api/OrganizationApi
30157
- * @version 166.0.0
30626
+ * @version 167.0.0
30158
30627
  */
30159
30628
 
30160
30629
  /**
@@ -30557,7 +31026,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30557
31026
  /**
30558
31027
  * OrganizationAuthorization service.
30559
31028
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
30560
- * @version 166.0.0
31029
+ * @version 167.0.0
30561
31030
  */
30562
31031
 
30563
31032
  /**
@@ -31852,7 +32321,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
31852
32321
  /**
31853
32322
  * Outbound service.
31854
32323
  * @module purecloud-platform-client-v2/api/OutboundApi
31855
- * @version 166.0.0
32324
+ * @version 167.0.0
31856
32325
  */
31857
32326
 
31858
32327
  /**
@@ -35448,7 +35917,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
35448
35917
  /**
35449
35918
  * Presence service.
35450
35919
  * @module purecloud-platform-client-v2/api/PresenceApi
35451
- * @version 166.0.0
35920
+ * @version 167.0.0
35452
35921
  */
35453
35922
 
35454
35923
  /**
@@ -35999,7 +36468,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
35999
36468
  /**
36000
36469
  * ProcessAutomation service.
36001
36470
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
36002
- * @version 166.0.0
36471
+ * @version 167.0.0
36003
36472
  */
36004
36473
 
36005
36474
  /**
@@ -36238,7 +36707,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36238
36707
  /**
36239
36708
  * Quality service.
36240
36709
  * @module purecloud-platform-client-v2/api/QualityApi
36241
- * @version 166.0.0
36710
+ * @version 167.0.0
36242
36711
  */
36243
36712
 
36244
36713
  /**
@@ -37817,7 +38286,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37817
38286
  /**
37818
38287
  * Recording service.
37819
38288
  * @module purecloud-platform-client-v2/api/RecordingApi
37820
- * @version 166.0.0
38289
+ * @version 167.0.0
37821
38290
  */
37822
38291
 
37823
38292
  /**
@@ -39454,7 +39923,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39454
39923
  /**
39455
39924
  * ResponseManagement service.
39456
39925
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
39457
- * @version 166.0.0
39926
+ * @version 167.0.0
39458
39927
  */
39459
39928
 
39460
39929
  /**
@@ -39938,7 +40407,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39938
40407
  /**
39939
40408
  * Routing service.
39940
40409
  * @module purecloud-platform-client-v2/api/RoutingApi
39941
- * @version 166.0.0
40410
+ * @version 167.0.0
39942
40411
  */
39943
40412
 
39944
40413
  /**
@@ -41048,6 +41517,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41048
41517
  *
41049
41518
  * @param {Object} opts Optional parameters
41050
41519
  * @param {Object} opts.kpiGroup The Group of Key Performance Indicators to return
41520
+ * @param {Array.<String>} opts.expand Parameter to request additional data to return in KPI payload
41051
41521
  */
41052
41522
  getRoutingPredictorsKeyperformanceindicators(opts) {
41053
41523
  opts = opts || {};
@@ -41057,7 +41527,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41057
41527
  '/api/v2/routing/predictors/keyperformanceindicators',
41058
41528
  'GET',
41059
41529
  { },
41060
- { 'kpiGroup': opts['kpiGroup'] },
41530
+ { 'kpiGroup': opts['kpiGroup'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
41061
41531
  { },
41062
41532
  { },
41063
41533
  null,
@@ -43446,7 +43916,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
43446
43916
  /**
43447
43917
  * SCIM service.
43448
43918
  * @module purecloud-platform-client-v2/api/SCIMApi
43449
- * @version 166.0.0
43919
+ * @version 167.0.0
43450
43920
  */
43451
43921
 
43452
43922
  /**
@@ -44323,7 +44793,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
44323
44793
  /**
44324
44794
  * Scripts service.
44325
44795
  * @module purecloud-platform-client-v2/api/ScriptsApi
44326
- * @version 166.0.0
44796
+ * @version 167.0.0
44327
44797
  */
44328
44798
 
44329
44799
  /**
@@ -44742,7 +45212,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
44742
45212
  /**
44743
45213
  * Search service.
44744
45214
  * @module purecloud-platform-client-v2/api/SearchApi
44745
- * @version 166.0.0
45215
+ * @version 167.0.0
44746
45216
  */
44747
45217
 
44748
45218
  /**
@@ -45352,7 +45822,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45352
45822
  /**
45353
45823
  * SpeechTextAnalytics service.
45354
45824
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
45355
- * @version 166.0.0
45825
+ * @version 167.0.0
45356
45826
  */
45357
45827
 
45358
45828
  /**
@@ -46281,7 +46751,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46281
46751
  /**
46282
46752
  * Stations service.
46283
46753
  * @module purecloud-platform-client-v2/api/StationsApi
46284
- * @version 166.0.0
46754
+ * @version 167.0.0
46285
46755
  */
46286
46756
 
46287
46757
  /**
@@ -46428,7 +46898,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46428
46898
  /**
46429
46899
  * Suggest service.
46430
46900
  * @module purecloud-platform-client-v2/api/SuggestApi
46431
- * @version 166.0.0
46901
+ * @version 167.0.0
46432
46902
  */
46433
46903
 
46434
46904
  /**
@@ -46567,7 +47037,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46567
47037
  /**
46568
47038
  * Teams service.
46569
47039
  * @module purecloud-platform-client-v2/api/TeamsApi
46570
- * @version 166.0.0
47040
+ * @version 167.0.0
46571
47041
  */
46572
47042
 
46573
47043
  /**
@@ -46838,7 +47308,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46838
47308
  /**
46839
47309
  * Telephony service.
46840
47310
  * @module purecloud-platform-client-v2/api/TelephonyApi
46841
- * @version 166.0.0
47311
+ * @version 167.0.0
46842
47312
  */
46843
47313
 
46844
47314
  /**
@@ -46966,7 +47436,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46966
47436
  /**
46967
47437
  * TelephonyProvidersEdge service.
46968
47438
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
46969
- * @version 166.0.0
47439
+ * @version 167.0.0
46970
47440
  */
46971
47441
 
46972
47442
  /**
@@ -47161,31 +47631,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47161
47631
  );
47162
47632
  }
47163
47633
 
47164
- /**
47165
- * Delete Outbound Route
47166
- * This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} instead.
47167
- * @param {String} outboundRouteId Outbound route ID
47168
- */
47169
- deleteTelephonyProvidersEdgesOutboundroute(outboundRouteId) {
47170
- // verify the required parameter 'outboundRouteId' is set
47171
- if (outboundRouteId === undefined || outboundRouteId === null) {
47172
- throw 'Missing the required parameter "outboundRouteId" when calling deleteTelephonyProvidersEdgesOutboundroute';
47173
- }
47174
-
47175
- return this.apiClient.callApi(
47176
- '/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}',
47177
- 'DELETE',
47178
- { 'outboundRouteId': outboundRouteId },
47179
- { },
47180
- { },
47181
- { },
47182
- null,
47183
- ['PureCloud OAuth'],
47184
- ['application/json'],
47185
- ['application/json']
47186
- );
47187
- }
47188
-
47189
47634
  /**
47190
47635
  * Delete a Phone by ID
47191
47636
  *
@@ -49600,31 +50045,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
49600
50045
  );
49601
50046
  }
49602
50047
 
49603
- /**
49604
- * Create outbound rule
49605
- * This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes instead.
49606
- * @param {Object} body OutboundRoute
49607
- */
49608
- postTelephonyProvidersEdgesOutboundroutes(body) {
49609
- // verify the required parameter 'body' is set
49610
- if (body === undefined || body === null) {
49611
- throw 'Missing the required parameter "body" when calling postTelephonyProvidersEdgesOutboundroutes';
49612
- }
49613
-
49614
- return this.apiClient.callApi(
49615
- '/api/v2/telephony/providers/edges/outboundroutes',
49616
- 'POST',
49617
- { },
49618
- { },
49619
- { },
49620
- { },
49621
- body,
49622
- ['PureCloud OAuth'],
49623
- ['application/json'],
49624
- ['application/json']
49625
- );
49626
- }
49627
-
49628
50048
  /**
49629
50049
  * Reboot a Phone
49630
50050
  *
@@ -50025,36 +50445,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50025
50445
  );
50026
50446
  }
50027
50447
 
50028
- /**
50029
- * Update outbound route
50030
- * This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} instead.
50031
- * @param {String} outboundRouteId Outbound route ID
50032
- * @param {Object} body OutboundRoute
50033
- */
50034
- putTelephonyProvidersEdgesOutboundroute(outboundRouteId, body) {
50035
- // verify the required parameter 'outboundRouteId' is set
50036
- if (outboundRouteId === undefined || outboundRouteId === null) {
50037
- throw 'Missing the required parameter "outboundRouteId" when calling putTelephonyProvidersEdgesOutboundroute';
50038
- }
50039
- // verify the required parameter 'body' is set
50040
- if (body === undefined || body === null) {
50041
- throw 'Missing the required parameter "body" when calling putTelephonyProvidersEdgesOutboundroute';
50042
- }
50043
-
50044
- return this.apiClient.callApi(
50045
- '/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}',
50046
- 'PUT',
50047
- { 'outboundRouteId': outboundRouteId },
50048
- { },
50049
- { },
50050
- { },
50051
- body,
50052
- ['PureCloud OAuth'],
50053
- ['application/json'],
50054
- ['application/json']
50055
- );
50056
- }
50057
-
50058
50448
  /**
50059
50449
  * Update a Phone by ID
50060
50450
  *
@@ -50246,7 +50636,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50246
50636
  /**
50247
50637
  * Textbots service.
50248
50638
  * @module purecloud-platform-client-v2/api/TextbotsApi
50249
- * @version 166.0.0
50639
+ * @version 167.0.0
50250
50640
  */
50251
50641
 
50252
50642
  /**
@@ -50374,7 +50764,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50374
50764
  /**
50375
50765
  * Tokens service.
50376
50766
  * @module purecloud-platform-client-v2/api/TokensApi
50377
- * @version 166.0.0
50767
+ * @version 167.0.0
50378
50768
  */
50379
50769
 
50380
50770
  /**
@@ -50480,7 +50870,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50480
50870
  /**
50481
50871
  * Uploads service.
50482
50872
  * @module purecloud-platform-client-v2/api/UploadsApi
50483
- * @version 166.0.0
50873
+ * @version 167.0.0
50484
50874
  */
50485
50875
 
50486
50876
  /**
@@ -50656,7 +51046,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50656
51046
  /**
50657
51047
  * Usage service.
50658
51048
  * @module purecloud-platform-client-v2/api/UsageApi
50659
- * @version 166.0.0
51049
+ * @version 167.0.0
50660
51050
  */
50661
51051
 
50662
51052
  /**
@@ -50816,7 +51206,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50816
51206
  /**
50817
51207
  * UserRecordings service.
50818
51208
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
50819
- * @version 166.0.0
51209
+ * @version 167.0.0
50820
51210
  */
50821
51211
 
50822
51212
  /**
@@ -51001,7 +51391,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51001
51391
  /**
51002
51392
  * Users service.
51003
51393
  * @module purecloud-platform-client-v2/api/UsersApi
51004
- * @version 166.0.0
51394
+ * @version 167.0.0
51005
51395
  */
51006
51396
 
51007
51397
  /**
@@ -53391,7 +53781,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
53391
53781
  /**
53392
53782
  * Utilities service.
53393
53783
  * @module purecloud-platform-client-v2/api/UtilitiesApi
53394
- * @version 166.0.0
53784
+ * @version 167.0.0
53395
53785
  */
53396
53786
 
53397
53787
  /**
@@ -53502,7 +53892,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
53502
53892
  /**
53503
53893
  * Voicemail service.
53504
53894
  * @module purecloud-platform-client-v2/api/VoicemailApi
53505
- * @version 166.0.0
53895
+ * @version 167.0.0
53506
53896
  */
53507
53897
 
53508
53898
  /**
@@ -54169,7 +54559,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
54169
54559
  /**
54170
54560
  * WebChat service.
54171
54561
  * @module purecloud-platform-client-v2/api/WebChatApi
54172
- * @version 166.0.0
54562
+ * @version 167.0.0
54173
54563
  */
54174
54564
 
54175
54565
  /**
@@ -54713,7 +55103,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
54713
55103
  /**
54714
55104
  * WebDeployments service.
54715
55105
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
54716
- * @version 166.0.0
55106
+ * @version 167.0.0
54717
55107
  */
54718
55108
 
54719
55109
  /**
@@ -55235,7 +55625,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55235
55625
  /**
55236
55626
  * WebMessaging service.
55237
55627
  * @module purecloud-platform-client-v2/api/WebMessagingApi
55238
- * @version 166.0.0
55628
+ * @version 167.0.0
55239
55629
  */
55240
55630
 
55241
55631
  /**
@@ -55281,7 +55671,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55281
55671
  /**
55282
55672
  * Widgets service.
55283
55673
  * @module purecloud-platform-client-v2/api/WidgetsApi
55284
- * @version 166.0.0
55674
+ * @version 167.0.0
55285
55675
  */
55286
55676
 
55287
55677
  /**
@@ -55427,7 +55817,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55427
55817
  /**
55428
55818
  * WorkforceManagement service.
55429
55819
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
55430
- * @version 166.0.0
55820
+ * @version 167.0.0
55431
55821
  */
55432
55822
 
55433
55823
  /**
@@ -58350,7 +58740,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58350
58740
  }
58351
58741
 
58352
58742
  /**
58353
- * Request a historical adherence report for users across management units
58743
+ * Deprecated. Use bulk routes instead (/adherence/historical/bulk)
58354
58744
  *
58355
58745
  * @param {Object} opts Optional parameters
58356
58746
  * @param {Object} opts.body body
@@ -60171,7 +60561,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
60171
60561
  * </pre>
60172
60562
  * </p>
60173
60563
  * @module purecloud-platform-client-v2/index
60174
- * @version 166.0.0
60564
+ * @version 167.0.0
60175
60565
  */
60176
60566
  class platformClient {
60177
60567
  constructor() {