purecloud-platform-client-v2 166.0.0 → 168.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 (79) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +747 -205
  3. package/dist/web-amd/purecloud-platform-client-v2.js +747 -205
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +747 -205
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +747 -205
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +885 -413
  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/CarrierServicesApi.js +75 -0
  18. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +32 -1
  22. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +2 -2
  26. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/GamificationApi.js +470 -1
  29. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +69 -4
  35. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/OutboundApi.js +26 -1
  51. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/QualityApi.js +2 -2
  54. package/src/purecloud-platform-client-v2/api/RecordingApi.js +2 -2
  55. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +3 -2
  56. package/src/purecloud-platform-client-v2/api/RoutingApi.js +3 -2
  57. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -46
  62. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -81
  66. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +2 -2
  79. package/src/purecloud-platform-client-v2/index.js +7 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "purecloud-platform-client-v2",
3
- "version": "166.0.0",
3
+ "version": "168.0.0",
4
4
  "description": "A JavaScript library to interface with the PureCloud Platform API",
5
5
  "license": "MIT",
6
6
  "main": "dist/node/purecloud-platform-client-v2.js",
@@ -9,12 +9,12 @@
9
9
  "jsnext:main": "src/purecloud-platform-client-v2/index.js",
10
10
  "browser": "dist/web-cjs/purecloud-platform-client-v2.min.js",
11
11
  "files": [
12
- "dist/*",
13
- "src/*",
14
- "package.json",
15
- "README.md",
16
- "LICENSE",
17
- "index.d.ts"
12
+ "dist/*",
13
+ "src/*",
14
+ "package.json",
15
+ "README.md",
16
+ "LICENSE",
17
+ "index.d.ts"
18
18
  ],
19
19
  "repository": {
20
20
  "type": "git",
@@ -4,7 +4,7 @@ import { default as qs } from 'qs';
4
4
 
5
5
  /**
6
6
  * @module purecloud-platform-client-v2/ApiClient
7
- * @version 166.0.0
7
+ * @version 168.0.0
8
8
  */
9
9
  class ApiClient {
10
10
  /**
@@ -5,7 +5,7 @@ class AlertingApi {
5
5
  /**
6
6
  * Alerting service.
7
7
  * @module purecloud-platform-client-v2/api/AlertingApi
8
- * @version 166.0.0
8
+ * @version 168.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class AnalyticsApi {
5
5
  /**
6
6
  * Analytics service.
7
7
  * @module purecloud-platform-client-v2/api/AnalyticsApi
8
- * @version 166.0.0
8
+ * @version 168.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ArchitectApi {
5
5
  /**
6
6
  * Architect service.
7
7
  * @module purecloud-platform-client-v2/api/ArchitectApi
8
- * @version 166.0.0
8
+ * @version 168.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class AuditApi {
5
5
  /**
6
6
  * Audit service.
7
7
  * @module purecloud-platform-client-v2/api/AuditApi
8
- * @version 166.0.0
8
+ * @version 168.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -118,7 +118,7 @@ class AuditApi {
118
118
 
119
119
  /**
120
120
  * Create audit query execution
121
- *
121
+ * Use /api/v2/audits/query/servicemapping endpoint for a list of valid values
122
122
  * @param {Object} body query
123
123
  */
124
124
  postAuditsQuery(body) {
@@ -143,7 +143,7 @@ class AuditApi {
143
143
 
144
144
  /**
145
145
  * This endpoint will only retrieve 14 days worth of audits for certain services. Please use /query to get a full list and older audits.
146
- *
146
+ * Use /api/v2/audits/query/realtime/servicemapping endpoint for a list of valid values
147
147
  * @param {Object} body query
148
148
  * @param {Object} opts Optional parameters
149
149
  * @param {Array.<String>} opts.expand Which fields, if any, to expand
@@ -5,7 +5,7 @@ class AuthorizationApi {
5
5
  /**
6
6
  * Authorization service.
7
7
  * @module purecloud-platform-client-v2/api/AuthorizationApi
8
- * @version 166.0.0
8
+ * @version 168.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class BillingApi {
5
5
  /**
6
6
  * Billing service.
7
7
  * @module purecloud-platform-client-v2/api/BillingApi
8
- * @version 166.0.0
8
+ * @version 168.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -0,0 +1,75 @@
1
+ import ApiClient from '../ApiClient.js';
2
+
3
+
4
+ class CarrierServicesApi {
5
+ /**
6
+ * CarrierServices service.
7
+ * @module purecloud-platform-client-v2/api/CarrierServicesApi
8
+ * @version 168.0.0
9
+ */
10
+
11
+ /**
12
+ * Constructs a new CarrierServicesApi.
13
+ * @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
14
+ * @class
15
+ * @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
16
+ * default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
17
+ */
18
+ constructor(apiClient) {
19
+ this.apiClient = apiClient || ApiClient.instance;
20
+ }
21
+
22
+
23
+ /**
24
+ * Get location for the logged in user
25
+ *
26
+ * @param {String} phoneNumber Phone number in E164 format
27
+ */
28
+ getCarrierservicesIntegrationsEmergencylocationsMe(phoneNumber) {
29
+ // verify the required parameter 'phoneNumber' is set
30
+ if (phoneNumber === undefined || phoneNumber === null) {
31
+ throw 'Missing the required parameter "phoneNumber" when calling getCarrierservicesIntegrationsEmergencylocationsMe';
32
+ }
33
+
34
+ return this.apiClient.callApi(
35
+ '/api/v2/carrierservices/integrations/emergencylocations/me',
36
+ 'GET',
37
+ { },
38
+ { 'phoneNumber': phoneNumber },
39
+ { },
40
+ { },
41
+ null,
42
+ ['PureCloud OAuth'],
43
+ ['application/json'],
44
+ ['application/json']
45
+ );
46
+ }
47
+
48
+ /**
49
+ * Set current location for the logged in user
50
+ *
51
+ * @param {Object} opts Optional parameters
52
+ * @param {Object} opts.body
53
+ */
54
+ postCarrierservicesIntegrationsEmergencylocationsMe(opts) {
55
+ opts = opts || {};
56
+
57
+
58
+ return this.apiClient.callApi(
59
+ '/api/v2/carrierservices/integrations/emergencylocations/me',
60
+ 'POST',
61
+ { },
62
+ { },
63
+ { },
64
+ { },
65
+ opts['body'],
66
+ ['PureCloud OAuth'],
67
+ ['application/json'],
68
+ ['application/json']
69
+ );
70
+ }
71
+
72
+ }
73
+
74
+
75
+ export default CarrierServicesApi;
@@ -5,7 +5,7 @@ class ChatApi {
5
5
  /**
6
6
  * Chat service.
7
7
  * @module purecloud-platform-client-v2/api/ChatApi
8
- * @version 166.0.0
8
+ * @version 168.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class CoachingApi {
5
5
  /**
6
6
  * Coaching service.
7
7
  * @module purecloud-platform-client-v2/api/CoachingApi
8
- * @version 166.0.0
8
+ * @version 168.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ContentManagementApi {
5
5
  /**
6
6
  * ContentManagement service.
7
7
  * @module purecloud-platform-client-v2/api/ContentManagementApi
8
- * @version 166.0.0
8
+ * @version 168.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ConversationsApi {
5
5
  /**
6
6
  * Conversations service.
7
7
  * @module purecloud-platform-client-v2/api/ConversationsApi
8
- * @version 166.0.0
8
+ * @version 168.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -3270,6 +3270,37 @@ class ConversationsApi {
3270
3270
  );
3271
3271
  }
3272
3272
 
3273
+ /**
3274
+ * Reset conversation draft to its initial state and/or auto-fill draft content
3275
+ *
3276
+ * @param {String} conversationId conversationId
3277
+ * @param {Object} opts Optional parameters
3278
+ * @param {Boolean} opts.autoFill autoFill
3279
+ * @param {Boolean} opts.discard discard
3280
+ * @param {Object} opts.body Draft Manipulation Request
3281
+ */
3282
+ patchConversationsEmailMessagesDraft(conversationId, opts) {
3283
+ opts = opts || {};
3284
+
3285
+ // verify the required parameter 'conversationId' is set
3286
+ if (conversationId === undefined || conversationId === null) {
3287
+ throw 'Missing the required parameter "conversationId" when calling patchConversationsEmailMessagesDraft';
3288
+ }
3289
+
3290
+ return this.apiClient.callApi(
3291
+ '/api/v2/conversations/emails/{conversationId}/messages/draft',
3292
+ 'PATCH',
3293
+ { 'conversationId': conversationId },
3294
+ { 'autoFill': opts['autoFill'],'discard': opts['discard'] },
3295
+ { },
3296
+ { },
3297
+ opts['body'],
3298
+ ['PureCloud OAuth'],
3299
+ ['application/json'],
3300
+ ['application/json']
3301
+ );
3302
+ }
3303
+
3273
3304
  /**
3274
3305
  * Update conversation participant
3275
3306
  *
@@ -5,7 +5,7 @@ class DataExtensionsApi {
5
5
  /**
6
6
  * DataExtensions service.
7
7
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
8
- * @version 166.0.0
8
+ * @version 168.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class DownloadsApi {
5
5
  /**
6
6
  * Downloads service.
7
7
  * @module purecloud-platform-client-v2/api/DownloadsApi
8
- * @version 166.0.0
8
+ * @version 168.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class EventsApi {
5
5
  /**
6
6
  * Events service.
7
7
  * @module purecloud-platform-client-v2/api/EventsApi
8
- * @version 166.0.0
8
+ * @version 168.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ExternalContactsApi {
5
5
  /**
6
6
  * ExternalContacts service.
7
7
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
8
- * @version 166.0.0
8
+ * @version 168.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -1549,7 +1549,7 @@ class ExternalContactsApi {
1549
1549
 
1550
1550
  /**
1551
1551
  * Merge two contacts into a new contact record
1552
- *
1552
+ * Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
1553
1553
  * @param {Object} body MergeRequest
1554
1554
  */
1555
1555
  postExternalcontactsMergeContacts(body) {
@@ -5,7 +5,7 @@ class FaxApi {
5
5
  /**
6
6
  * Fax service.
7
7
  * @module purecloud-platform-client-v2/api/FaxApi
8
- * @version 166.0.0
8
+ * @version 168.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class FlowsApi {
5
5
  /**
6
6
  * Flows service.
7
7
  * @module purecloud-platform-client-v2/api/FlowsApi
8
- * @version 166.0.0
8
+ * @version 168.0.0
9
9
  */
10
10
 
11
11
  /**