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
@@ -2279,7 +2279,7 @@ class Configuration {
2279
2279
 
2280
2280
  /**
2281
2281
  * @module purecloud-platform-client-v2/ApiClient
2282
- * @version 166.0.0
2282
+ * @version 167.0.0
2283
2283
  */
2284
2284
  class ApiClient {
2285
2285
  /**
@@ -3358,7 +3358,7 @@ class AlertingApi {
3358
3358
  /**
3359
3359
  * Alerting service.
3360
3360
  * @module purecloud-platform-client-v2/api/AlertingApi
3361
- * @version 166.0.0
3361
+ * @version 167.0.0
3362
3362
  */
3363
3363
 
3364
3364
  /**
@@ -3672,7 +3672,7 @@ class AnalyticsApi {
3672
3672
  /**
3673
3673
  * Analytics service.
3674
3674
  * @module purecloud-platform-client-v2/api/AnalyticsApi
3675
- * @version 166.0.0
3675
+ * @version 167.0.0
3676
3676
  */
3677
3677
 
3678
3678
  /**
@@ -4926,7 +4926,7 @@ class ArchitectApi {
4926
4926
  /**
4927
4927
  * Architect service.
4928
4928
  * @module purecloud-platform-client-v2/api/ArchitectApi
4929
- * @version 166.0.0
4929
+ * @version 167.0.0
4930
4930
  */
4931
4931
 
4932
4932
  /**
@@ -7974,7 +7974,7 @@ class AuditApi {
7974
7974
  /**
7975
7975
  * Audit service.
7976
7976
  * @module purecloud-platform-client-v2/api/AuditApi
7977
- * @version 166.0.0
7977
+ * @version 167.0.0
7978
7978
  */
7979
7979
 
7980
7980
  /**
@@ -8087,7 +8087,7 @@ class AuditApi {
8087
8087
 
8088
8088
  /**
8089
8089
  * Create audit query execution
8090
- *
8090
+ * Use /api/v2/audits/query/servicemapping endpoint for a list of valid values
8091
8091
  * @param {Object} body query
8092
8092
  */
8093
8093
  postAuditsQuery(body) {
@@ -8112,7 +8112,7 @@ class AuditApi {
8112
8112
 
8113
8113
  /**
8114
8114
  * This endpoint will only retrieve 14 days worth of audits for certain services. Please use /query to get a full list and older audits.
8115
- *
8115
+ * Use /api/v2/audits/query/realtime/servicemapping endpoint for a list of valid values
8116
8116
  * @param {Object} body query
8117
8117
  * @param {Object} opts Optional parameters
8118
8118
  * @param {Array.<String>} opts.expand Which fields, if any, to expand
@@ -8145,7 +8145,7 @@ class AuthorizationApi {
8145
8145
  /**
8146
8146
  * Authorization service.
8147
8147
  * @module purecloud-platform-client-v2/api/AuthorizationApi
8148
- * @version 166.0.0
8148
+ * @version 167.0.0
8149
8149
  */
8150
8150
 
8151
8151
  /**
@@ -9374,7 +9374,7 @@ class BillingApi {
9374
9374
  /**
9375
9375
  * Billing service.
9376
9376
  * @module purecloud-platform-client-v2/api/BillingApi
9377
- * @version 166.0.0
9377
+ * @version 167.0.0
9378
9378
  */
9379
9379
 
9380
9380
  /**
@@ -9454,7 +9454,7 @@ class ChatApi {
9454
9454
  /**
9455
9455
  * Chat service.
9456
9456
  * @module purecloud-platform-client-v2/api/ChatApi
9457
- * @version 166.0.0
9457
+ * @version 167.0.0
9458
9458
  */
9459
9459
 
9460
9460
  /**
@@ -9615,7 +9615,7 @@ class CoachingApi {
9615
9615
  /**
9616
9616
  * Coaching service.
9617
9617
  * @module purecloud-platform-client-v2/api/CoachingApi
9618
- * @version 166.0.0
9618
+ * @version 167.0.0
9619
9619
  */
9620
9620
 
9621
9621
  /**
@@ -10192,7 +10192,7 @@ class ContentManagementApi {
10192
10192
  /**
10193
10193
  * ContentManagement service.
10194
10194
  * @module purecloud-platform-client-v2/api/ContentManagementApi
10195
- * @version 166.0.0
10195
+ * @version 167.0.0
10196
10196
  */
10197
10197
 
10198
10198
  /**
@@ -11332,7 +11332,7 @@ class ConversationsApi {
11332
11332
  /**
11333
11333
  * Conversations service.
11334
11334
  * @module purecloud-platform-client-v2/api/ConversationsApi
11335
- * @version 166.0.0
11335
+ * @version 167.0.0
11336
11336
  */
11337
11337
 
11338
11338
  /**
@@ -17392,7 +17392,7 @@ class DataExtensionsApi {
17392
17392
  /**
17393
17393
  * DataExtensions service.
17394
17394
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
17395
- * @version 166.0.0
17395
+ * @version 167.0.0
17396
17396
  */
17397
17397
 
17398
17398
  /**
@@ -17478,7 +17478,7 @@ class DownloadsApi {
17478
17478
  /**
17479
17479
  * Downloads service.
17480
17480
  * @module purecloud-platform-client-v2/api/DownloadsApi
17481
- * @version 166.0.0
17481
+ * @version 167.0.0
17482
17482
  */
17483
17483
 
17484
17484
  /**
@@ -17530,7 +17530,7 @@ class EventsApi {
17530
17530
  /**
17531
17531
  * Events service.
17532
17532
  * @module purecloud-platform-client-v2/api/EventsApi
17533
- * @version 166.0.0
17533
+ * @version 167.0.0
17534
17534
  */
17535
17535
 
17536
17536
  /**
@@ -17626,7 +17626,7 @@ class ExternalContactsApi {
17626
17626
  /**
17627
17627
  * ExternalContacts service.
17628
17628
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
17629
- * @version 166.0.0
17629
+ * @version 167.0.0
17630
17630
  */
17631
17631
 
17632
17632
  /**
@@ -19584,7 +19584,7 @@ class FaxApi {
19584
19584
  /**
19585
19585
  * Fax service.
19586
19586
  * @module purecloud-platform-client-v2/api/FaxApi
19587
- * @version 166.0.0
19587
+ * @version 167.0.0
19588
19588
  */
19589
19589
 
19590
19590
  /**
@@ -19755,7 +19755,7 @@ class FlowsApi {
19755
19755
  /**
19756
19756
  * Flows service.
19757
19757
  * @module purecloud-platform-client-v2/api/FlowsApi
19758
- * @version 166.0.0
19758
+ * @version 167.0.0
19759
19759
  */
19760
19760
 
19761
19761
  /**
@@ -19826,7 +19826,7 @@ class GamificationApi {
19826
19826
  /**
19827
19827
  * Gamification service.
19828
19828
  * @module purecloud-platform-client-v2/api/GamificationApi
19829
- * @version 166.0.0
19829
+ * @version 167.0.0
19830
19830
  */
19831
19831
 
19832
19832
  /**
@@ -19916,6 +19916,420 @@ class GamificationApi {
19916
19916
  );
19917
19917
  }
19918
19918
 
19919
+ /**
19920
+ * Get insights summary
19921
+ *
19922
+ * @param {Object} filterType Filter type for the query request.
19923
+ * @param {String} filterId ID for the filter type.
19924
+ * @param {Object} granularity Granularity
19925
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
19926
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
19927
+ * @param {Object} opts Optional parameters
19928
+ * @param {Number} opts.pageSize Page size (default to 25)
19929
+ * @param {Number} opts.pageNumber Page number (default to 1)
19930
+ * @param {Object} opts.sortKey Sort key
19931
+ * @param {String} opts.sortMetricId Sort Metric Id
19932
+ * @param {Object} opts.sortOrder Sort order (default to asc)
19933
+ * @param {String} opts.userIds A list of up to 100 comma-separated user Ids
19934
+ */
19935
+ getGamificationInsights(filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday, opts) {
19936
+ opts = opts || {};
19937
+
19938
+ // verify the required parameter 'filterType' is set
19939
+ if (filterType === undefined || filterType === null) {
19940
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsights';
19941
+ }
19942
+ // verify the required parameter 'filterId' is set
19943
+ if (filterId === undefined || filterId === null) {
19944
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsights';
19945
+ }
19946
+ // verify the required parameter 'granularity' is set
19947
+ if (granularity === undefined || granularity === null) {
19948
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsights';
19949
+ }
19950
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
19951
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
19952
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsights';
19953
+ }
19954
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
19955
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
19956
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsights';
19957
+ }
19958
+
19959
+ return this.apiClient.callApi(
19960
+ '/api/v2/gamification/insights',
19961
+ 'GET',
19962
+ { },
19963
+ { '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'] },
19964
+ { },
19965
+ { },
19966
+ null,
19967
+ ['PureCloud OAuth'],
19968
+ ['application/json'],
19969
+ ['application/json']
19970
+ );
19971
+ }
19972
+
19973
+ /**
19974
+ * Get insights details for the current user
19975
+ *
19976
+ * @param {Object} filterType Filter type for the query request.
19977
+ * @param {String} filterId ID for the filter type.
19978
+ * @param {Object} granularity Granularity
19979
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
19980
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
19981
+ */
19982
+ getGamificationInsightsDetails(filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday) {
19983
+ // verify the required parameter 'filterType' is set
19984
+ if (filterType === undefined || filterType === null) {
19985
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsDetails';
19986
+ }
19987
+ // verify the required parameter 'filterId' is set
19988
+ if (filterId === undefined || filterId === null) {
19989
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsDetails';
19990
+ }
19991
+ // verify the required parameter 'granularity' is set
19992
+ if (granularity === undefined || granularity === null) {
19993
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsDetails';
19994
+ }
19995
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
19996
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
19997
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsDetails';
19998
+ }
19999
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
20000
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
20001
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsDetails';
20002
+ }
20003
+
20004
+ return this.apiClient.callApi(
20005
+ '/api/v2/gamification/insights/details',
20006
+ 'GET',
20007
+ { },
20008
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday },
20009
+ { },
20010
+ { },
20011
+ null,
20012
+ ['PureCloud OAuth'],
20013
+ ['application/json'],
20014
+ ['application/json']
20015
+ );
20016
+ }
20017
+
20018
+ /**
20019
+ * Get insights overall trend for the current user
20020
+ *
20021
+ * @param {Object} filterType Filter type for the query request.
20022
+ * @param {String} filterId ID for the filter type.
20023
+ * @param {Object} granularity Granularity
20024
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20025
+ * @param {String} comparativePeriodEndWorkday The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20026
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20027
+ * @param {String} primaryPeriodEndWorkday The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20028
+ */
20029
+ getGamificationInsightsGroupsTrends(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday) {
20030
+ // verify the required parameter 'filterType' is set
20031
+ if (filterType === undefined || filterType === null) {
20032
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsGroupsTrends';
20033
+ }
20034
+ // verify the required parameter 'filterId' is set
20035
+ if (filterId === undefined || filterId === null) {
20036
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsGroupsTrends';
20037
+ }
20038
+ // verify the required parameter 'granularity' is set
20039
+ if (granularity === undefined || granularity === null) {
20040
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsGroupsTrends';
20041
+ }
20042
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
20043
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
20044
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsGroupsTrends';
20045
+ }
20046
+ // verify the required parameter 'comparativePeriodEndWorkday' is set
20047
+ if (comparativePeriodEndWorkday === undefined || comparativePeriodEndWorkday === null) {
20048
+ throw 'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsGroupsTrends';
20049
+ }
20050
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
20051
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
20052
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsGroupsTrends';
20053
+ }
20054
+ // verify the required parameter 'primaryPeriodEndWorkday' is set
20055
+ if (primaryPeriodEndWorkday === undefined || primaryPeriodEndWorkday === null) {
20056
+ throw 'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsGroupsTrends';
20057
+ }
20058
+
20059
+ return this.apiClient.callApi(
20060
+ '/api/v2/gamification/insights/groups/trends',
20061
+ 'GET',
20062
+ { },
20063
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'comparativePeriodEndWorkday': comparativePeriodEndWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'primaryPeriodEndWorkday': primaryPeriodEndWorkday },
20064
+ { },
20065
+ { },
20066
+ null,
20067
+ ['PureCloud OAuth'],
20068
+ ['application/json'],
20069
+ ['application/json']
20070
+ );
20071
+ }
20072
+
20073
+ /**
20074
+ * Get insights overall trend
20075
+ *
20076
+ * @param {Object} filterType Filter type for the query request.
20077
+ * @param {String} filterId ID for the filter type.
20078
+ * @param {Object} granularity Granularity
20079
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20080
+ * @param {String} comparativePeriodEndWorkday The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20081
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20082
+ * @param {String} primaryPeriodEndWorkday The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20083
+ */
20084
+ getGamificationInsightsGroupsTrendsAll(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday) {
20085
+ // verify the required parameter 'filterType' is set
20086
+ if (filterType === undefined || filterType === null) {
20087
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsGroupsTrendsAll';
20088
+ }
20089
+ // verify the required parameter 'filterId' is set
20090
+ if (filterId === undefined || filterId === null) {
20091
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsGroupsTrendsAll';
20092
+ }
20093
+ // verify the required parameter 'granularity' is set
20094
+ if (granularity === undefined || granularity === null) {
20095
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsGroupsTrendsAll';
20096
+ }
20097
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
20098
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
20099
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsGroupsTrendsAll';
20100
+ }
20101
+ // verify the required parameter 'comparativePeriodEndWorkday' is set
20102
+ if (comparativePeriodEndWorkday === undefined || comparativePeriodEndWorkday === null) {
20103
+ throw 'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsGroupsTrendsAll';
20104
+ }
20105
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
20106
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
20107
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsGroupsTrendsAll';
20108
+ }
20109
+ // verify the required parameter 'primaryPeriodEndWorkday' is set
20110
+ if (primaryPeriodEndWorkday === undefined || primaryPeriodEndWorkday === null) {
20111
+ throw 'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsGroupsTrendsAll';
20112
+ }
20113
+
20114
+ return this.apiClient.callApi(
20115
+ '/api/v2/gamification/insights/groups/trends/all',
20116
+ 'GET',
20117
+ { },
20118
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'comparativePeriodEndWorkday': comparativePeriodEndWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'primaryPeriodEndWorkday': primaryPeriodEndWorkday },
20119
+ { },
20120
+ { },
20121
+ null,
20122
+ ['PureCloud OAuth'],
20123
+ ['application/json'],
20124
+ ['application/json']
20125
+ );
20126
+ }
20127
+
20128
+ /**
20129
+ * Query users in a profile during a period of time
20130
+ *
20131
+ * @param {Object} filterType Filter type for the query request.
20132
+ * @param {String} filterId ID for the filter type.
20133
+ * @param {Object} granularity Granularity
20134
+ * @param {String} startWorkday The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20135
+ */
20136
+ getGamificationInsightsMembers(filterType, filterId, granularity, startWorkday) {
20137
+ // verify the required parameter 'filterType' is set
20138
+ if (filterType === undefined || filterType === null) {
20139
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsMembers';
20140
+ }
20141
+ // verify the required parameter 'filterId' is set
20142
+ if (filterId === undefined || filterId === null) {
20143
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsMembers';
20144
+ }
20145
+ // verify the required parameter 'granularity' is set
20146
+ if (granularity === undefined || granularity === null) {
20147
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsMembers';
20148
+ }
20149
+ // verify the required parameter 'startWorkday' is set
20150
+ if (startWorkday === undefined || startWorkday === null) {
20151
+ throw 'Missing the required parameter "startWorkday" when calling getGamificationInsightsMembers';
20152
+ }
20153
+
20154
+ return this.apiClient.callApi(
20155
+ '/api/v2/gamification/insights/members',
20156
+ 'GET',
20157
+ { },
20158
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'startWorkday': startWorkday },
20159
+ { },
20160
+ { },
20161
+ null,
20162
+ ['PureCloud OAuth'],
20163
+ ['application/json'],
20164
+ ['application/json']
20165
+ );
20166
+ }
20167
+
20168
+ /**
20169
+ * Get insights user trend for the current user
20170
+ *
20171
+ * @param {Object} filterType Filter type for the query request.
20172
+ * @param {String} filterId ID for the filter type.
20173
+ * @param {Object} granularity Granularity
20174
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20175
+ * @param {String} comparativePeriodEndWorkday The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20176
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20177
+ * @param {String} primaryPeriodEndWorkday The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20178
+ */
20179
+ getGamificationInsightsTrends(filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday) {
20180
+ // verify the required parameter 'filterType' is set
20181
+ if (filterType === undefined || filterType === null) {
20182
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsTrends';
20183
+ }
20184
+ // verify the required parameter 'filterId' is set
20185
+ if (filterId === undefined || filterId === null) {
20186
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsTrends';
20187
+ }
20188
+ // verify the required parameter 'granularity' is set
20189
+ if (granularity === undefined || granularity === null) {
20190
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsTrends';
20191
+ }
20192
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
20193
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
20194
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsTrends';
20195
+ }
20196
+ // verify the required parameter 'comparativePeriodEndWorkday' is set
20197
+ if (comparativePeriodEndWorkday === undefined || comparativePeriodEndWorkday === null) {
20198
+ throw 'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsTrends';
20199
+ }
20200
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
20201
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
20202
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsTrends';
20203
+ }
20204
+ // verify the required parameter 'primaryPeriodEndWorkday' is set
20205
+ if (primaryPeriodEndWorkday === undefined || primaryPeriodEndWorkday === null) {
20206
+ throw 'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsTrends';
20207
+ }
20208
+
20209
+ return this.apiClient.callApi(
20210
+ '/api/v2/gamification/insights/trends',
20211
+ 'GET',
20212
+ { },
20213
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'comparativePeriodEndWorkday': comparativePeriodEndWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'primaryPeriodEndWorkday': primaryPeriodEndWorkday },
20214
+ { },
20215
+ { },
20216
+ null,
20217
+ ['PureCloud OAuth'],
20218
+ ['application/json'],
20219
+ ['application/json']
20220
+ );
20221
+ }
20222
+
20223
+ /**
20224
+ * Get insights details for the user
20225
+ *
20226
+ * @param {String} userId The ID of a user.
20227
+ * @param {Object} filterType Filter type for the query request.
20228
+ * @param {String} filterId ID for the filter type.
20229
+ * @param {Object} granularity Granularity
20230
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20231
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20232
+ */
20233
+ getGamificationInsightsUserDetails(userId, filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday) {
20234
+ // verify the required parameter 'userId' is set
20235
+ if (userId === undefined || userId === null) {
20236
+ throw 'Missing the required parameter "userId" when calling getGamificationInsightsUserDetails';
20237
+ }
20238
+ // verify the required parameter 'filterType' is set
20239
+ if (filterType === undefined || filterType === null) {
20240
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsUserDetails';
20241
+ }
20242
+ // verify the required parameter 'filterId' is set
20243
+ if (filterId === undefined || filterId === null) {
20244
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsUserDetails';
20245
+ }
20246
+ // verify the required parameter 'granularity' is set
20247
+ if (granularity === undefined || granularity === null) {
20248
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsUserDetails';
20249
+ }
20250
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
20251
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
20252
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsUserDetails';
20253
+ }
20254
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
20255
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
20256
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsUserDetails';
20257
+ }
20258
+
20259
+ return this.apiClient.callApi(
20260
+ '/api/v2/gamification/insights/users/{userId}/details',
20261
+ 'GET',
20262
+ { 'userId': userId },
20263
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday },
20264
+ { },
20265
+ { },
20266
+ null,
20267
+ ['PureCloud OAuth'],
20268
+ ['application/json'],
20269
+ ['application/json']
20270
+ );
20271
+ }
20272
+
20273
+ /**
20274
+ * Get insights user trend for the user
20275
+ *
20276
+ * @param {String} userId The ID of a user.
20277
+ * @param {Object} filterType Filter type for the query request.
20278
+ * @param {String} filterId ID for the filter type.
20279
+ * @param {Object} granularity Granularity
20280
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20281
+ * @param {String} comparativePeriodEndWorkday The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20282
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20283
+ * @param {String} primaryPeriodEndWorkday The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
20284
+ */
20285
+ getGamificationInsightsUserTrends(userId, filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday) {
20286
+ // verify the required parameter 'userId' is set
20287
+ if (userId === undefined || userId === null) {
20288
+ throw 'Missing the required parameter "userId" when calling getGamificationInsightsUserTrends';
20289
+ }
20290
+ // verify the required parameter 'filterType' is set
20291
+ if (filterType === undefined || filterType === null) {
20292
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsUserTrends';
20293
+ }
20294
+ // verify the required parameter 'filterId' is set
20295
+ if (filterId === undefined || filterId === null) {
20296
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsUserTrends';
20297
+ }
20298
+ // verify the required parameter 'granularity' is set
20299
+ if (granularity === undefined || granularity === null) {
20300
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsUserTrends';
20301
+ }
20302
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
20303
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
20304
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsUserTrends';
20305
+ }
20306
+ // verify the required parameter 'comparativePeriodEndWorkday' is set
20307
+ if (comparativePeriodEndWorkday === undefined || comparativePeriodEndWorkday === null) {
20308
+ throw 'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsUserTrends';
20309
+ }
20310
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
20311
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
20312
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsUserTrends';
20313
+ }
20314
+ // verify the required parameter 'primaryPeriodEndWorkday' is set
20315
+ if (primaryPeriodEndWorkday === undefined || primaryPeriodEndWorkday === null) {
20316
+ throw 'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsUserTrends';
20317
+ }
20318
+
20319
+ return this.apiClient.callApi(
20320
+ '/api/v2/gamification/insights/users/{userId}/trends',
20321
+ 'GET',
20322
+ { 'userId': userId },
20323
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'comparativePeriodEndWorkday': comparativePeriodEndWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'primaryPeriodEndWorkday': primaryPeriodEndWorkday },
20324
+ { },
20325
+ { },
20326
+ null,
20327
+ ['PureCloud OAuth'],
20328
+ ['application/json'],
20329
+ ['application/json']
20330
+ );
20331
+ }
20332
+
19919
20333
  /**
19920
20334
  * Leaderboard of the requesting user's division or performance profile
19921
20335
  *
@@ -21348,6 +21762,61 @@ class GamificationApi {
21348
21762
  );
21349
21763
  }
21350
21764
 
21765
+ /**
21766
+ * Query performance profiles in date range for a user
21767
+ *
21768
+ * @param {String} userId The ID of a user.
21769
+ * @param {Object} body The date range of work day.
21770
+ */
21771
+ postGamificationProfilesUserQuery(userId, body) {
21772
+ // verify the required parameter 'userId' is set
21773
+ if (userId === undefined || userId === null) {
21774
+ throw 'Missing the required parameter "userId" when calling postGamificationProfilesUserQuery';
21775
+ }
21776
+ // verify the required parameter 'body' is set
21777
+ if (body === undefined || body === null) {
21778
+ throw 'Missing the required parameter "body" when calling postGamificationProfilesUserQuery';
21779
+ }
21780
+
21781
+ return this.apiClient.callApi(
21782
+ '/api/v2/gamification/profiles/users/{userId}/query',
21783
+ 'POST',
21784
+ { 'userId': userId },
21785
+ { },
21786
+ { },
21787
+ { },
21788
+ body,
21789
+ ['PureCloud OAuth'],
21790
+ ['application/json'],
21791
+ ['application/json']
21792
+ );
21793
+ }
21794
+
21795
+ /**
21796
+ * Query performance profiles in date range for the current user
21797
+ *
21798
+ * @param {Object} body The date range of work day.
21799
+ */
21800
+ postGamificationProfilesUsersMeQuery(body) {
21801
+ // verify the required parameter 'body' is set
21802
+ if (body === undefined || body === null) {
21803
+ throw 'Missing the required parameter "body" when calling postGamificationProfilesUsersMeQuery';
21804
+ }
21805
+
21806
+ return this.apiClient.callApi(
21807
+ '/api/v2/gamification/profiles/users/me/query',
21808
+ 'POST',
21809
+ { },
21810
+ { },
21811
+ { },
21812
+ { },
21813
+ body,
21814
+ ['PureCloud OAuth'],
21815
+ ['application/json'],
21816
+ ['application/json']
21817
+ );
21818
+ }
21819
+
21351
21820
  /**
21352
21821
  * Updates a performance profile
21353
21822
  *
@@ -21443,7 +21912,7 @@ class GeneralDataProtectionRegulationApi {
21443
21912
  /**
21444
21913
  * GeneralDataProtectionRegulation service.
21445
21914
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
21446
- * @version 166.0.0
21915
+ * @version 167.0.0
21447
21916
  */
21448
21917
 
21449
21918
  /**
@@ -21573,7 +22042,7 @@ class GeolocationApi {
21573
22042
  /**
21574
22043
  * Geolocation service.
21575
22044
  * @module purecloud-platform-client-v2/api/GeolocationApi
21576
- * @version 166.0.0
22045
+ * @version 167.0.0
21577
22046
  */
21578
22047
 
21579
22048
  /**
@@ -21704,7 +22173,7 @@ class GreetingsApi {
21704
22173
  /**
21705
22174
  * Greetings service.
21706
22175
  * @module purecloud-platform-client-v2/api/GreetingsApi
21707
- * @version 166.0.0
22176
+ * @version 167.0.0
21708
22177
  */
21709
22178
 
21710
22179
  /**
@@ -22159,7 +22628,7 @@ class GroupsApi {
22159
22628
  /**
22160
22629
  * Groups service.
22161
22630
  * @module purecloud-platform-client-v2/api/GroupsApi
22162
- * @version 166.0.0
22631
+ * @version 167.0.0
22163
22632
  */
22164
22633
 
22165
22634
  /**
@@ -22565,7 +23034,7 @@ class IdentityProviderApi {
22565
23034
  /**
22566
23035
  * IdentityProvider service.
22567
23036
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
22568
- * @version 166.0.0
23037
+ * @version 167.0.0
22569
23038
  */
22570
23039
 
22571
23040
  /**
@@ -23321,7 +23790,7 @@ class InfrastructureAsCodeApi {
23321
23790
  /**
23322
23791
  * InfrastructureAsCode service.
23323
23792
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
23324
- * @version 166.0.0
23793
+ * @version 167.0.0
23325
23794
  */
23326
23795
 
23327
23796
  /**
@@ -23423,7 +23892,7 @@ class IntegrationsApi {
23423
23892
  /**
23424
23893
  * Integrations service.
23425
23894
  * @module purecloud-platform-client-v2/api/IntegrationsApi
23426
- * @version 166.0.0
23895
+ * @version 167.0.0
23427
23896
  */
23428
23897
 
23429
23898
  /**
@@ -25023,7 +25492,7 @@ class JourneyApi {
25023
25492
  /**
25024
25493
  * Journey service.
25025
25494
  * @module purecloud-platform-client-v2/api/JourneyApi
25026
- * @version 166.0.0
25495
+ * @version 167.0.0
25027
25496
  */
25028
25497
 
25029
25498
  /**
@@ -25903,7 +26372,7 @@ class KnowledgeApi {
25903
26372
  /**
25904
26373
  * Knowledge service.
25905
26374
  * @module purecloud-platform-client-v2/api/KnowledgeApi
25906
- * @version 166.0.0
26375
+ * @version 167.0.0
25907
26376
  */
25908
26377
 
25909
26378
  /**
@@ -28335,7 +28804,7 @@ class LanguageUnderstandingApi {
28335
28804
  /**
28336
28805
  * LanguageUnderstanding service.
28337
28806
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
28338
- * @version 166.0.0
28807
+ * @version 167.0.0
28339
28808
  */
28340
28809
 
28341
28810
  /**
@@ -29348,7 +29817,7 @@ class LanguagesApi {
29348
29817
  /**
29349
29818
  * Languages service.
29350
29819
  * @module purecloud-platform-client-v2/api/LanguagesApi
29351
- * @version 166.0.0
29820
+ * @version 167.0.0
29352
29821
  */
29353
29822
 
29354
29823
  /**
@@ -29566,7 +30035,7 @@ class LearningApi {
29566
30035
  /**
29567
30036
  * Learning service.
29568
30037
  * @module purecloud-platform-client-v2/api/LearningApi
29569
- * @version 166.0.0
30038
+ * @version 167.0.0
29570
30039
  */
29571
30040
 
29572
30041
  /**
@@ -30381,7 +30850,7 @@ class LicenseApi {
30381
30850
  /**
30382
30851
  * License service.
30383
30852
  * @module purecloud-platform-client-v2/api/LicenseApi
30384
- * @version 166.0.0
30853
+ * @version 167.0.0
30385
30854
  */
30386
30855
 
30387
30856
  /**
@@ -30619,7 +31088,7 @@ class LocationsApi {
30619
31088
  /**
30620
31089
  * Locations service.
30621
31090
  * @module purecloud-platform-client-v2/api/LocationsApi
30622
- * @version 166.0.0
31091
+ * @version 167.0.0
30623
31092
  */
30624
31093
 
30625
31094
  /**
@@ -30855,7 +31324,7 @@ class MessagingApi {
30855
31324
  /**
30856
31325
  * Messaging service.
30857
31326
  * @module purecloud-platform-client-v2/api/MessagingApi
30858
- * @version 166.0.0
31327
+ * @version 167.0.0
30859
31328
  */
30860
31329
 
30861
31330
  /**
@@ -31006,7 +31475,7 @@ class MobileDevicesApi {
31006
31475
  /**
31007
31476
  * MobileDevices service.
31008
31477
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
31009
- * @version 166.0.0
31478
+ * @version 167.0.0
31010
31479
  */
31011
31480
 
31012
31481
  /**
@@ -31157,7 +31626,7 @@ class NotificationsApi {
31157
31626
  /**
31158
31627
  * Notifications service.
31159
31628
  * @module purecloud-platform-client-v2/api/NotificationsApi
31160
- * @version 166.0.0
31629
+ * @version 167.0.0
31161
31630
  */
31162
31631
 
31163
31632
  /**
@@ -31390,7 +31859,7 @@ class OAuthApi {
31390
31859
  /**
31391
31860
  * OAuth service.
31392
31861
  * @module purecloud-platform-client-v2/api/OAuthApi
31393
- * @version 166.0.0
31862
+ * @version 167.0.0
31394
31863
  */
31395
31864
 
31396
31865
  /**
@@ -31756,7 +32225,7 @@ class ObjectsApi {
31756
32225
  /**
31757
32226
  * Objects service.
31758
32227
  * @module purecloud-platform-client-v2/api/ObjectsApi
31759
- * @version 166.0.0
32228
+ * @version 167.0.0
31760
32229
  */
31761
32230
 
31762
32231
  /**
@@ -32027,7 +32496,7 @@ class OrganizationApi {
32027
32496
  /**
32028
32497
  * Organization service.
32029
32498
  * @module purecloud-platform-client-v2/api/OrganizationApi
32030
- * @version 166.0.0
32499
+ * @version 167.0.0
32031
32500
  */
32032
32501
 
32033
32502
  /**
@@ -32430,7 +32899,7 @@ class OrganizationAuthorizationApi {
32430
32899
  /**
32431
32900
  * OrganizationAuthorization service.
32432
32901
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
32433
- * @version 166.0.0
32902
+ * @version 167.0.0
32434
32903
  */
32435
32904
 
32436
32905
  /**
@@ -33725,7 +34194,7 @@ class OutboundApi {
33725
34194
  /**
33726
34195
  * Outbound service.
33727
34196
  * @module purecloud-platform-client-v2/api/OutboundApi
33728
- * @version 166.0.0
34197
+ * @version 167.0.0
33729
34198
  */
33730
34199
 
33731
34200
  /**
@@ -37321,7 +37790,7 @@ class PresenceApi {
37321
37790
  /**
37322
37791
  * Presence service.
37323
37792
  * @module purecloud-platform-client-v2/api/PresenceApi
37324
- * @version 166.0.0
37793
+ * @version 167.0.0
37325
37794
  */
37326
37795
 
37327
37796
  /**
@@ -37872,7 +38341,7 @@ class ProcessAutomationApi {
37872
38341
  /**
37873
38342
  * ProcessAutomation service.
37874
38343
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
37875
- * @version 166.0.0
38344
+ * @version 167.0.0
37876
38345
  */
37877
38346
 
37878
38347
  /**
@@ -38111,7 +38580,7 @@ class QualityApi {
38111
38580
  /**
38112
38581
  * Quality service.
38113
38582
  * @module purecloud-platform-client-v2/api/QualityApi
38114
- * @version 166.0.0
38583
+ * @version 167.0.0
38115
38584
  */
38116
38585
 
38117
38586
  /**
@@ -39690,7 +40159,7 @@ class RecordingApi {
39690
40159
  /**
39691
40160
  * Recording service.
39692
40161
  * @module purecloud-platform-client-v2/api/RecordingApi
39693
- * @version 166.0.0
40162
+ * @version 167.0.0
39694
40163
  */
39695
40164
 
39696
40165
  /**
@@ -41327,7 +41796,7 @@ class ResponseManagementApi {
41327
41796
  /**
41328
41797
  * ResponseManagement service.
41329
41798
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
41330
- * @version 166.0.0
41799
+ * @version 167.0.0
41331
41800
  */
41332
41801
 
41333
41802
  /**
@@ -41811,7 +42280,7 @@ class RoutingApi {
41811
42280
  /**
41812
42281
  * Routing service.
41813
42282
  * @module purecloud-platform-client-v2/api/RoutingApi
41814
- * @version 166.0.0
42283
+ * @version 167.0.0
41815
42284
  */
41816
42285
 
41817
42286
  /**
@@ -42921,6 +43390,7 @@ class RoutingApi {
42921
43390
  *
42922
43391
  * @param {Object} opts Optional parameters
42923
43392
  * @param {Object} opts.kpiGroup The Group of Key Performance Indicators to return
43393
+ * @param {Array.<String>} opts.expand Parameter to request additional data to return in KPI payload
42924
43394
  */
42925
43395
  getRoutingPredictorsKeyperformanceindicators(opts) {
42926
43396
  opts = opts || {};
@@ -42930,7 +43400,7 @@ class RoutingApi {
42930
43400
  '/api/v2/routing/predictors/keyperformanceindicators',
42931
43401
  'GET',
42932
43402
  { },
42933
- { 'kpiGroup': opts['kpiGroup'] },
43403
+ { 'kpiGroup': opts['kpiGroup'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
42934
43404
  { },
42935
43405
  { },
42936
43406
  null,
@@ -45319,7 +45789,7 @@ class SCIMApi {
45319
45789
  /**
45320
45790
  * SCIM service.
45321
45791
  * @module purecloud-platform-client-v2/api/SCIMApi
45322
- * @version 166.0.0
45792
+ * @version 167.0.0
45323
45793
  */
45324
45794
 
45325
45795
  /**
@@ -46196,7 +46666,7 @@ class ScriptsApi {
46196
46666
  /**
46197
46667
  * Scripts service.
46198
46668
  * @module purecloud-platform-client-v2/api/ScriptsApi
46199
- * @version 166.0.0
46669
+ * @version 167.0.0
46200
46670
  */
46201
46671
 
46202
46672
  /**
@@ -46615,7 +47085,7 @@ class SearchApi {
46615
47085
  /**
46616
47086
  * Search service.
46617
47087
  * @module purecloud-platform-client-v2/api/SearchApi
46618
- * @version 166.0.0
47088
+ * @version 167.0.0
46619
47089
  */
46620
47090
 
46621
47091
  /**
@@ -47225,7 +47695,7 @@ class SpeechTextAnalyticsApi {
47225
47695
  /**
47226
47696
  * SpeechTextAnalytics service.
47227
47697
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
47228
- * @version 166.0.0
47698
+ * @version 167.0.0
47229
47699
  */
47230
47700
 
47231
47701
  /**
@@ -48154,7 +48624,7 @@ class StationsApi {
48154
48624
  /**
48155
48625
  * Stations service.
48156
48626
  * @module purecloud-platform-client-v2/api/StationsApi
48157
- * @version 166.0.0
48627
+ * @version 167.0.0
48158
48628
  */
48159
48629
 
48160
48630
  /**
@@ -48301,7 +48771,7 @@ class SuggestApi {
48301
48771
  /**
48302
48772
  * Suggest service.
48303
48773
  * @module purecloud-platform-client-v2/api/SuggestApi
48304
- * @version 166.0.0
48774
+ * @version 167.0.0
48305
48775
  */
48306
48776
 
48307
48777
  /**
@@ -48440,7 +48910,7 @@ class TeamsApi {
48440
48910
  /**
48441
48911
  * Teams service.
48442
48912
  * @module purecloud-platform-client-v2/api/TeamsApi
48443
- * @version 166.0.0
48913
+ * @version 167.0.0
48444
48914
  */
48445
48915
 
48446
48916
  /**
@@ -48711,7 +49181,7 @@ class TelephonyApi {
48711
49181
  /**
48712
49182
  * Telephony service.
48713
49183
  * @module purecloud-platform-client-v2/api/TelephonyApi
48714
- * @version 166.0.0
49184
+ * @version 167.0.0
48715
49185
  */
48716
49186
 
48717
49187
  /**
@@ -48839,7 +49309,7 @@ class TelephonyProvidersEdgeApi {
48839
49309
  /**
48840
49310
  * TelephonyProvidersEdge service.
48841
49311
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
48842
- * @version 166.0.0
49312
+ * @version 167.0.0
48843
49313
  */
48844
49314
 
48845
49315
  /**
@@ -49034,31 +49504,6 @@ class TelephonyProvidersEdgeApi {
49034
49504
  );
49035
49505
  }
49036
49506
 
49037
- /**
49038
- * Delete Outbound Route
49039
- * This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} instead.
49040
- * @param {String} outboundRouteId Outbound route ID
49041
- */
49042
- deleteTelephonyProvidersEdgesOutboundroute(outboundRouteId) {
49043
- // verify the required parameter 'outboundRouteId' is set
49044
- if (outboundRouteId === undefined || outboundRouteId === null) {
49045
- throw 'Missing the required parameter "outboundRouteId" when calling deleteTelephonyProvidersEdgesOutboundroute';
49046
- }
49047
-
49048
- return this.apiClient.callApi(
49049
- '/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}',
49050
- 'DELETE',
49051
- { 'outboundRouteId': outboundRouteId },
49052
- { },
49053
- { },
49054
- { },
49055
- null,
49056
- ['PureCloud OAuth'],
49057
- ['application/json'],
49058
- ['application/json']
49059
- );
49060
- }
49061
-
49062
49507
  /**
49063
49508
  * Delete a Phone by ID
49064
49509
  *
@@ -51473,31 +51918,6 @@ class TelephonyProvidersEdgeApi {
51473
51918
  );
51474
51919
  }
51475
51920
 
51476
- /**
51477
- * Create outbound rule
51478
- * This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes instead.
51479
- * @param {Object} body OutboundRoute
51480
- */
51481
- postTelephonyProvidersEdgesOutboundroutes(body) {
51482
- // verify the required parameter 'body' is set
51483
- if (body === undefined || body === null) {
51484
- throw 'Missing the required parameter "body" when calling postTelephonyProvidersEdgesOutboundroutes';
51485
- }
51486
-
51487
- return this.apiClient.callApi(
51488
- '/api/v2/telephony/providers/edges/outboundroutes',
51489
- 'POST',
51490
- { },
51491
- { },
51492
- { },
51493
- { },
51494
- body,
51495
- ['PureCloud OAuth'],
51496
- ['application/json'],
51497
- ['application/json']
51498
- );
51499
- }
51500
-
51501
51921
  /**
51502
51922
  * Reboot a Phone
51503
51923
  *
@@ -51898,36 +52318,6 @@ class TelephonyProvidersEdgeApi {
51898
52318
  );
51899
52319
  }
51900
52320
 
51901
- /**
51902
- * Update outbound route
51903
- * This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} instead.
51904
- * @param {String} outboundRouteId Outbound route ID
51905
- * @param {Object} body OutboundRoute
51906
- */
51907
- putTelephonyProvidersEdgesOutboundroute(outboundRouteId, body) {
51908
- // verify the required parameter 'outboundRouteId' is set
51909
- if (outboundRouteId === undefined || outboundRouteId === null) {
51910
- throw 'Missing the required parameter "outboundRouteId" when calling putTelephonyProvidersEdgesOutboundroute';
51911
- }
51912
- // verify the required parameter 'body' is set
51913
- if (body === undefined || body === null) {
51914
- throw 'Missing the required parameter "body" when calling putTelephonyProvidersEdgesOutboundroute';
51915
- }
51916
-
51917
- return this.apiClient.callApi(
51918
- '/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}',
51919
- 'PUT',
51920
- { 'outboundRouteId': outboundRouteId },
51921
- { },
51922
- { },
51923
- { },
51924
- body,
51925
- ['PureCloud OAuth'],
51926
- ['application/json'],
51927
- ['application/json']
51928
- );
51929
- }
51930
-
51931
52321
  /**
51932
52322
  * Update a Phone by ID
51933
52323
  *
@@ -52119,7 +52509,7 @@ class TextbotsApi {
52119
52509
  /**
52120
52510
  * Textbots service.
52121
52511
  * @module purecloud-platform-client-v2/api/TextbotsApi
52122
- * @version 166.0.0
52512
+ * @version 167.0.0
52123
52513
  */
52124
52514
 
52125
52515
  /**
@@ -52247,7 +52637,7 @@ class TokensApi {
52247
52637
  /**
52248
52638
  * Tokens service.
52249
52639
  * @module purecloud-platform-client-v2/api/TokensApi
52250
- * @version 166.0.0
52640
+ * @version 167.0.0
52251
52641
  */
52252
52642
 
52253
52643
  /**
@@ -52353,7 +52743,7 @@ class UploadsApi {
52353
52743
  /**
52354
52744
  * Uploads service.
52355
52745
  * @module purecloud-platform-client-v2/api/UploadsApi
52356
- * @version 166.0.0
52746
+ * @version 167.0.0
52357
52747
  */
52358
52748
 
52359
52749
  /**
@@ -52529,7 +52919,7 @@ class UsageApi {
52529
52919
  /**
52530
52920
  * Usage service.
52531
52921
  * @module purecloud-platform-client-v2/api/UsageApi
52532
- * @version 166.0.0
52922
+ * @version 167.0.0
52533
52923
  */
52534
52924
 
52535
52925
  /**
@@ -52689,7 +53079,7 @@ class UserRecordingsApi {
52689
53079
  /**
52690
53080
  * UserRecordings service.
52691
53081
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
52692
- * @version 166.0.0
53082
+ * @version 167.0.0
52693
53083
  */
52694
53084
 
52695
53085
  /**
@@ -52874,7 +53264,7 @@ class UsersApi {
52874
53264
  /**
52875
53265
  * Users service.
52876
53266
  * @module purecloud-platform-client-v2/api/UsersApi
52877
- * @version 166.0.0
53267
+ * @version 167.0.0
52878
53268
  */
52879
53269
 
52880
53270
  /**
@@ -55264,7 +55654,7 @@ class UtilitiesApi {
55264
55654
  /**
55265
55655
  * Utilities service.
55266
55656
  * @module purecloud-platform-client-v2/api/UtilitiesApi
55267
- * @version 166.0.0
55657
+ * @version 167.0.0
55268
55658
  */
55269
55659
 
55270
55660
  /**
@@ -55375,7 +55765,7 @@ class VoicemailApi {
55375
55765
  /**
55376
55766
  * Voicemail service.
55377
55767
  * @module purecloud-platform-client-v2/api/VoicemailApi
55378
- * @version 166.0.0
55768
+ * @version 167.0.0
55379
55769
  */
55380
55770
 
55381
55771
  /**
@@ -56042,7 +56432,7 @@ class WebChatApi {
56042
56432
  /**
56043
56433
  * WebChat service.
56044
56434
  * @module purecloud-platform-client-v2/api/WebChatApi
56045
- * @version 166.0.0
56435
+ * @version 167.0.0
56046
56436
  */
56047
56437
 
56048
56438
  /**
@@ -56586,7 +56976,7 @@ class WebDeploymentsApi {
56586
56976
  /**
56587
56977
  * WebDeployments service.
56588
56978
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
56589
- * @version 166.0.0
56979
+ * @version 167.0.0
56590
56980
  */
56591
56981
 
56592
56982
  /**
@@ -57108,7 +57498,7 @@ class WebMessagingApi {
57108
57498
  /**
57109
57499
  * WebMessaging service.
57110
57500
  * @module purecloud-platform-client-v2/api/WebMessagingApi
57111
- * @version 166.0.0
57501
+ * @version 167.0.0
57112
57502
  */
57113
57503
 
57114
57504
  /**
@@ -57154,7 +57544,7 @@ class WidgetsApi {
57154
57544
  /**
57155
57545
  * Widgets service.
57156
57546
  * @module purecloud-platform-client-v2/api/WidgetsApi
57157
- * @version 166.0.0
57547
+ * @version 167.0.0
57158
57548
  */
57159
57549
 
57160
57550
  /**
@@ -57300,7 +57690,7 @@ class WorkforceManagementApi {
57300
57690
  /**
57301
57691
  * WorkforceManagement service.
57302
57692
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
57303
- * @version 166.0.0
57693
+ * @version 167.0.0
57304
57694
  */
57305
57695
 
57306
57696
  /**
@@ -60223,7 +60613,7 @@ class WorkforceManagementApi {
60223
60613
  }
60224
60614
 
60225
60615
  /**
60226
- * Request a historical adherence report for users across management units
60616
+ * Deprecated. Use bulk routes instead (/adherence/historical/bulk)
60227
60617
  *
60228
60618
  * @param {Object} opts Optional parameters
60229
60619
  * @param {Object} opts.body body
@@ -62044,7 +62434,7 @@ class WorkforceManagementApi {
62044
62434
  * </pre>
62045
62435
  * </p>
62046
62436
  * @module purecloud-platform-client-v2/index
62047
- * @version 166.0.0
62437
+ * @version 167.0.0
62048
62438
  */
62049
62439
  class platformClient {
62050
62440
  constructor() {