purecloud-platform-client-v2 163.0.0 → 165.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 +206 -169
  3. package/dist/web-amd/purecloud-platform-client-v2.js +206 -169
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +206 -169
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +206 -169
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +84 -66
  9. package/package.json +1 -1
  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 +2 -2
  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 +41 -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 +1 -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 +2 -97
  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 +90 -1
  69. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/UsersApi.js +5 -3
  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 +1 -1
  78. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -5,7 +5,7 @@ class UsageApi {
5
5
  /**
6
6
  * Usage service.
7
7
  * @module purecloud-platform-client-v2/api/UsageApi
8
- * @version 163.0.0
8
+ * @version 165.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -20,6 +20,65 @@ class UsageApi {
20
20
  }
21
21
 
22
22
 
23
+ /**
24
+ * Get the results of a usage query
25
+ *
26
+ * @param {String} executionId ID of the query execution
27
+ * @param {String} clientId Client ID
28
+ */
29
+ getOauthClientUsageQueryResult(executionId, clientId) {
30
+ // verify the required parameter 'executionId' is set
31
+ if (executionId === undefined || executionId === null) {
32
+ throw 'Missing the required parameter "executionId" when calling getOauthClientUsageQueryResult';
33
+ }
34
+ // verify the required parameter 'clientId' is set
35
+ if (clientId === undefined || clientId === null) {
36
+ throw 'Missing the required parameter "clientId" when calling getOauthClientUsageQueryResult';
37
+ }
38
+
39
+ return this.apiClient.callApi(
40
+ '/api/v2/oauth/clients/{clientId}/usage/query/results/{executionId}',
41
+ 'GET',
42
+ { 'executionId': executionId,'clientId': clientId },
43
+ { },
44
+ { },
45
+ { },
46
+ null,
47
+ ['PureCloud OAuth'],
48
+ ['application/json'],
49
+ ['application/json']
50
+ );
51
+ }
52
+
53
+ /**
54
+ * Get a summary of OAuth client API usage
55
+ * After calling this method, you will then need to poll for the query results based on the returned execution Id
56
+ * @param {String} clientId Client ID
57
+ * @param {Object} opts Optional parameters
58
+ * @param {String} opts.days Previous number of days to query (default to 7)
59
+ */
60
+ getOauthClientUsageSummary(clientId, opts) {
61
+ opts = opts || {};
62
+
63
+ // verify the required parameter 'clientId' is set
64
+ if (clientId === undefined || clientId === null) {
65
+ throw 'Missing the required parameter "clientId" when calling getOauthClientUsageSummary';
66
+ }
67
+
68
+ return this.apiClient.callApi(
69
+ '/api/v2/oauth/clients/{clientId}/usage/summary',
70
+ 'GET',
71
+ { 'clientId': clientId },
72
+ { 'days': opts['days'] },
73
+ { },
74
+ { },
75
+ null,
76
+ ['PureCloud OAuth'],
77
+ ['application/json'],
78
+ ['application/json']
79
+ );
80
+ }
81
+
23
82
  /**
24
83
  * Get the results of a usage query
25
84
  *
@@ -45,6 +104,36 @@ class UsageApi {
45
104
  );
46
105
  }
47
106
 
107
+ /**
108
+ * Query for OAuth client API usage
109
+ * After calling this method, you will then need to poll for the query results based on the returned execution Id
110
+ * @param {String} clientId Client ID
111
+ * @param {Object} body Query
112
+ */
113
+ postOauthClientUsageQuery(clientId, body) {
114
+ // verify the required parameter 'clientId' is set
115
+ if (clientId === undefined || clientId === null) {
116
+ throw 'Missing the required parameter "clientId" when calling postOauthClientUsageQuery';
117
+ }
118
+ // verify the required parameter 'body' is set
119
+ if (body === undefined || body === null) {
120
+ throw 'Missing the required parameter "body" when calling postOauthClientUsageQuery';
121
+ }
122
+
123
+ return this.apiClient.callApi(
124
+ '/api/v2/oauth/clients/{clientId}/usage/query',
125
+ 'POST',
126
+ { 'clientId': clientId },
127
+ { },
128
+ { },
129
+ { },
130
+ body,
131
+ ['PureCloud OAuth'],
132
+ ['application/json'],
133
+ ['application/json']
134
+ );
135
+ }
136
+
48
137
  /**
49
138
  * Query organization API Usage -
50
139
  * After calling this method, you will then need to poll for the query results based on the returned execution Id
@@ -5,7 +5,7 @@ class UserRecordingsApi {
5
5
  /**
6
6
  * UserRecordings service.
7
7
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
8
- * @version 163.0.0
8
+ * @version 165.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class UsersApi {
5
5
  /**
6
6
  * Users service.
7
7
  * @module purecloud-platform-client-v2/api/UsersApi
8
- * @version 163.0.0
8
+ * @version 165.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -1114,6 +1114,7 @@ class UsersApi {
1114
1114
  * @param {String} opts.interval Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
1115
1115
  * @param {String} opts.completionInterval Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
1116
1116
  * @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
1117
+ * @param {Object} opts.pass Specifies if only the failed (pass is False) or passed (pass is True) activities are returned. If pass is Any or if the pass parameter is not supplied, all activities are returned (default to Any)
1117
1118
  * @param {Number} opts.pageSize Page size (default to 25)
1118
1119
  * @param {Number} opts.pageNumber Page number (default to 1)
1119
1120
  * @param {Object} opts.sortOrder Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (default to Desc)
@@ -1129,7 +1130,7 @@ class UsersApi {
1129
1130
  '/api/v2/users/development/activities',
1130
1131
  'GET',
1131
1132
  { },
1132
- { 'userId': this.apiClient.buildCollectionParam(opts['userId'], 'multi'),'moduleId': opts['moduleId'],'interval': opts['interval'],'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'relationship': this.apiClient.buildCollectionParam(opts['relationship'], 'multi') },
1133
+ { 'userId': this.apiClient.buildCollectionParam(opts['userId'], 'multi'),'moduleId': opts['moduleId'],'interval': opts['interval'],'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'pass': opts['pass'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'relationship': this.apiClient.buildCollectionParam(opts['relationship'], 'multi') },
1133
1134
  { },
1134
1135
  { },
1135
1136
  null,
@@ -1147,6 +1148,7 @@ class UsersApi {
1147
1148
  * @param {String} opts.interval Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
1148
1149
  * @param {String} opts.completionInterval Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
1149
1150
  * @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
1151
+ * @param {Object} opts.pass Specifies if only the failed (pass is False) or passed (pass is True) activities are returned. If pass is Any or if the pass parameter is not supplied, all activities are returned (default to Any)
1150
1152
  * @param {Number} opts.pageSize Page size (default to 25)
1151
1153
  * @param {Number} opts.pageNumber Page number (default to 1)
1152
1154
  * @param {Object} opts.sortOrder Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (default to Desc)
@@ -1162,7 +1164,7 @@ class UsersApi {
1162
1164
  '/api/v2/users/development/activities/me',
1163
1165
  'GET',
1164
1166
  { },
1165
- { 'moduleId': opts['moduleId'],'interval': opts['interval'],'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'relationship': this.apiClient.buildCollectionParam(opts['relationship'], 'multi') },
1167
+ { 'moduleId': opts['moduleId'],'interval': opts['interval'],'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'pass': opts['pass'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'relationship': this.apiClient.buildCollectionParam(opts['relationship'], 'multi') },
1166
1168
  { },
1167
1169
  { },
1168
1170
  null,
@@ -5,7 +5,7 @@ class UtilitiesApi {
5
5
  /**
6
6
  * Utilities service.
7
7
  * @module purecloud-platform-client-v2/api/UtilitiesApi
8
- * @version 163.0.0
8
+ * @version 165.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class VoicemailApi {
5
5
  /**
6
6
  * Voicemail service.
7
7
  * @module purecloud-platform-client-v2/api/VoicemailApi
8
- * @version 163.0.0
8
+ * @version 165.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class WebChatApi {
5
5
  /**
6
6
  * WebChat service.
7
7
  * @module purecloud-platform-client-v2/api/WebChatApi
8
- * @version 163.0.0
8
+ * @version 165.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class WebDeploymentsApi {
5
5
  /**
6
6
  * WebDeployments service.
7
7
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
8
- * @version 163.0.0
8
+ * @version 165.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class WebMessagingApi {
5
5
  /**
6
6
  * WebMessaging service.
7
7
  * @module purecloud-platform-client-v2/api/WebMessagingApi
8
- * @version 163.0.0
8
+ * @version 165.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class WidgetsApi {
5
5
  /**
6
6
  * Widgets service.
7
7
  * @module purecloud-platform-client-v2/api/WidgetsApi
8
- * @version 163.0.0
8
+ * @version 165.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class WorkforceManagementApi {
5
5
  /**
6
6
  * WorkforceManagement service.
7
7
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
8
- * @version 163.0.0
8
+ * @version 165.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -100,7 +100,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
100
100
  * </pre>
101
101
  * </p>
102
102
  * @module purecloud-platform-client-v2/index
103
- * @version 163.0.0
103
+ * @version 165.0.0
104
104
  */
105
105
  class platformClient {
106
106
  constructor() {