purecloud-platform-client-v2 135.0.0 → 137.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 (73) hide show
  1. package/README.md +32 -29
  2. package/dist/node/purecloud-platform-client-v2.js +9882 -9496
  3. package/dist/web-amd/purecloud-platform-client-v2.js +9882 -9496
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +9882 -9496
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +9892 -9507
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +5771 -301
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +14 -5
  11. package/src/purecloud-platform-client-v2/api/AlertingApi.js +56 -56
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +231 -231
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +573 -524
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +31 -31
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +212 -212
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +12 -12
  17. package/src/purecloud-platform-client-v2/api/ChatApi.js +16 -16
  18. package/src/purecloud-platform-client-v2/api/CoachingApi.js +96 -96
  19. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +192 -192
  20. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +810 -810
  21. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +17 -17
  22. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +337 -337
  23. package/src/purecloud-platform-client-v2/api/FaxApi.js +31 -31
  24. package/src/purecloud-platform-client-v2/api/FlowsApi.js +11 -11
  25. package/src/purecloud-platform-client-v2/api/GamificationApi.js +270 -270
  26. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +21 -21
  27. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +26 -26
  28. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +88 -88
  29. package/src/purecloud-platform-client-v2/api/GroupsApi.js +72 -72
  30. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +171 -171
  31. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +317 -315
  32. package/src/purecloud-platform-client-v2/api/JourneyApi.js +146 -146
  33. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +131 -131
  34. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +151 -151
  35. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +51 -51
  36. package/src/purecloud-platform-client-v2/api/LearningApi.js +107 -107
  37. package/src/purecloud-platform-client-v2/api/LicenseApi.js +49 -49
  38. package/src/purecloud-platform-client-v2/api/LocationsApi.js +41 -41
  39. package/src/purecloud-platform-client-v2/api/MessagingApi.js +26 -26
  40. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +26 -26
  41. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +43 -43
  42. package/src/purecloud-platform-client-v2/api/OAuthApi.js +67 -67
  43. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +50 -50
  44. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +81 -81
  45. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +162 -162
  46. package/src/purecloud-platform-client-v2/api/OutboundApi.js +768 -568
  47. package/src/purecloud-platform-client-v2/api/PresenceApi.js +64 -64
  48. package/src/purecloud-platform-client-v2/api/QualityApi.js +285 -285
  49. package/src/purecloud-platform-client-v2/api/RecordingApi.js +404 -279
  50. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +86 -86
  51. package/src/purecloud-platform-client-v2/api/RoutingApi.js +541 -537
  52. package/src/purecloud-platform-client-v2/api/SCIMApi.js +195 -195
  53. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +66 -66
  54. package/src/purecloud-platform-client-v2/api/SearchApi.js +96 -96
  55. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +194 -194
  56. package/src/purecloud-platform-client-v2/api/StationsApi.js +28 -28
  57. package/src/purecloud-platform-client-v2/api/SuggestApi.js +21 -21
  58. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +16 -16
  59. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +657 -657
  60. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +23 -23
  61. package/src/purecloud-platform-client-v2/api/TokensApi.js +21 -21
  62. package/src/purecloud-platform-client-v2/api/UploadsApi.js +26 -26
  63. package/src/purecloud-platform-client-v2/api/UsageApi.js +11 -11
  64. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +31 -31
  65. package/src/purecloud-platform-client-v2/api/UsersApi.js +413 -413
  66. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +21 -21
  67. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +140 -140
  68. package/src/purecloud-platform-client-v2/api/WebChatApi.js +97 -97
  69. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +66 -66
  70. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +6 -6
  71. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +26 -26
  72. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +765 -765
  73. package/src/purecloud-platform-client-v2/index.js +145 -149
@@ -5,7 +5,7 @@ class TextbotsApi {
5
5
  /**
6
6
  * Textbots service.
7
7
  * @module purecloud-platform-client-v2/api/TextbotsApi
8
- * @version 135.0.0
8
+ * @version 137.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -36,13 +36,13 @@ class TextbotsApi {
36
36
  return this.apiClient.callApi(
37
37
  '/api/v2/textbots/bots/search',
38
38
  'GET',
39
- { },
40
- { 'botType': this.apiClient.buildCollectionParam(opts['botType'], 'multi'),'botName': opts['botName'],'botId': this.apiClient.buildCollectionParam(opts['botId'], 'multi'),'pageSize': opts['pageSize'] },
41
- { },
42
- { },
39
+ { },
40
+ { 'botType': this.apiClient.buildCollectionParam(opts['botType'], 'multi'),'botName': opts['botName'],'botId': this.apiClient.buildCollectionParam(opts['botId'], 'multi'),'pageSize': opts['pageSize'] },
41
+ { },
42
+ { },
43
43
  null,
44
44
  ['PureCloud OAuth'],
45
- ['application/json'],
45
+ ['application/json'],
46
46
  ['application/json']
47
47
  );
48
48
  }
@@ -50,7 +50,7 @@ class TextbotsApi {
50
50
  /**
51
51
  * Issue a bot flow turn event
52
52
  * Send a turn event to an executing bot flow and produce the next action to take.
53
- * @param {String} sessionId The bot flow session ID, typically obtained from 'POST /api/v2/textbots/botflows/sessions'
53
+ * @param {String} sessionId The bot flow session ID, typically obtained from 'POST /api/v2/textbots/botflows/sessions'
54
54
  * @param {Object} turnRequest
55
55
  */
56
56
  postTextbotsBotflowsSessionTurns(sessionId, turnRequest) {
@@ -66,20 +66,20 @@ class TextbotsApi {
66
66
  return this.apiClient.callApi(
67
67
  '/api/v2/textbots/botflows/sessions/{sessionId}/turns',
68
68
  'POST',
69
- { 'sessionId': sessionId },
70
- { },
71
- { },
72
- { },
69
+ { 'sessionId': sessionId },
70
+ { },
71
+ { },
72
+ { },
73
73
  turnRequest,
74
74
  ['PureCloud OAuth'],
75
- ['application/json'],
75
+ ['application/json'],
76
76
  ['application/json']
77
77
  );
78
78
  }
79
79
 
80
80
  /**
81
81
  * Create an execution instance of a bot flow definition.
82
- * The launch is asynchronous; use the returned instance ID to post turns to it using 'POST /api/v2/textbots/botflows/sessions/{sessionId}/turns'.
82
+ * The launch is asynchronous; use the returned instance ID to post turns to it using POST /api/v2/textbots/botflows/sessions/{sessionId}/turns.
83
83
  * @param {Object} launchRequest
84
84
  */
85
85
  postTextbotsBotflowsSessions(launchRequest) {
@@ -91,13 +91,13 @@ class TextbotsApi {
91
91
  return this.apiClient.callApi(
92
92
  '/api/v2/textbots/botflows/sessions',
93
93
  'POST',
94
- { },
95
- { },
96
- { },
97
- { },
94
+ { },
95
+ { },
96
+ { },
97
+ { },
98
98
  launchRequest,
99
99
  ['PureCloud OAuth'],
100
- ['application/json'],
100
+ ['application/json'],
101
101
  ['application/json']
102
102
  );
103
103
  }
@@ -116,13 +116,13 @@ class TextbotsApi {
116
116
  return this.apiClient.callApi(
117
117
  '/api/v2/textbots/bots/execute',
118
118
  'POST',
119
- { },
120
- { },
121
- { },
122
- { },
119
+ { },
120
+ { },
121
+ { },
122
+ { },
123
123
  postTextRequest,
124
124
  ['PureCloud OAuth'],
125
- ['application/json'],
125
+ ['application/json'],
126
126
  ['application/json']
127
127
  );
128
128
  }
@@ -5,7 +5,7 @@ class TokensApi {
5
5
  /**
6
6
  * Tokens service.
7
7
  * @module purecloud-platform-client-v2/api/TokensApi
8
- * @version 135.0.0
8
+ * @version 137.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -34,13 +34,13 @@ class TokensApi {
34
34
  return this.apiClient.callApi(
35
35
  '/api/v2/tokens/{userId}',
36
36
  'DELETE',
37
- { 'userId': userId },
38
- { },
39
- { },
40
- { },
37
+ { 'userId': userId },
38
+ { },
39
+ { },
40
+ { },
41
41
  null,
42
42
  ['PureCloud OAuth'],
43
- ['application/json'],
43
+ ['application/json'],
44
44
  ['application/json']
45
45
  );
46
46
  }
@@ -54,13 +54,13 @@ class TokensApi {
54
54
  return this.apiClient.callApi(
55
55
  '/api/v2/tokens/me',
56
56
  'DELETE',
57
- { },
58
- { },
59
- { },
60
- { },
57
+ { },
58
+ { },
59
+ { },
60
+ { },
61
61
  null,
62
62
  ['PureCloud OAuth'],
63
- ['application/json'],
63
+ ['application/json'],
64
64
  ['application/json']
65
65
  );
66
66
  }
@@ -74,13 +74,13 @@ class TokensApi {
74
74
  return this.apiClient.callApi(
75
75
  '/api/v2/tokens/me',
76
76
  'GET',
77
- { },
78
- { },
79
- { },
80
- { },
77
+ { },
78
+ { },
79
+ { },
80
+ { },
81
81
  null,
82
82
  ['PureCloud OAuth'],
83
- ['application/json'],
83
+ ['application/json'],
84
84
  ['application/json']
85
85
  );
86
86
  }
@@ -94,13 +94,13 @@ class TokensApi {
94
94
  return this.apiClient.callApi(
95
95
  '/api/v2/tokens/me',
96
96
  'HEAD',
97
- { },
98
- { },
99
- { },
100
- { },
97
+ { },
98
+ { },
99
+ { },
100
+ { },
101
101
  null,
102
102
  ['PureCloud OAuth'],
103
- ['application/json'],
103
+ ['application/json'],
104
104
  ['application/json']
105
105
  );
106
106
  }
@@ -5,7 +5,7 @@ class UploadsApi {
5
5
  /**
6
6
  * Uploads service.
7
7
  * @module purecloud-platform-client-v2/api/UploadsApi
8
- * @version 135.0.0
8
+ * @version 137.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -34,13 +34,13 @@ class UploadsApi {
34
34
  return this.apiClient.callApi(
35
35
  '/api/v2/knowledge/documentuploads',
36
36
  'POST',
37
- { },
38
- { },
39
- { },
40
- { },
37
+ { },
38
+ { },
39
+ { },
40
+ { },
41
41
  body,
42
42
  ['PureCloud OAuth'],
43
- ['application/json'],
43
+ ['application/json'],
44
44
  ['application/json']
45
45
  );
46
46
  }
@@ -64,13 +64,13 @@ class UploadsApi {
64
64
  return this.apiClient.callApi(
65
65
  '/api/v2/languageunderstanding/miners/{minerId}/uploads',
66
66
  'POST',
67
- { 'minerId': minerId },
68
- { },
69
- { },
70
- { },
67
+ { 'minerId': minerId },
68
+ { },
69
+ { },
70
+ { },
71
71
  body,
72
72
  ['PureCloud OAuth'],
73
- ['application/json'],
73
+ ['application/json'],
74
74
  ['application/json']
75
75
  );
76
76
  }
@@ -89,13 +89,13 @@ class UploadsApi {
89
89
  return this.apiClient.callApi(
90
90
  '/api/v2/uploads/publicassets/images',
91
91
  'POST',
92
- { },
93
- { },
94
- { },
95
- { },
92
+ { },
93
+ { },
94
+ { },
95
+ { },
96
96
  body,
97
97
  ['PureCloud OAuth'],
98
- ['application/json'],
98
+ ['application/json'],
99
99
  ['application/json']
100
100
  );
101
101
  }
@@ -114,13 +114,13 @@ class UploadsApi {
114
114
  return this.apiClient.callApi(
115
115
  '/api/v2/uploads/recordings',
116
116
  'POST',
117
- { },
118
- { },
119
- { },
120
- { },
117
+ { },
118
+ { },
119
+ { },
120
+ { },
121
121
  body,
122
122
  ['PureCloud OAuth'],
123
- ['application/json'],
123
+ ['application/json'],
124
124
  ['application/json']
125
125
  );
126
126
  }
@@ -139,13 +139,13 @@ class UploadsApi {
139
139
  return this.apiClient.callApi(
140
140
  '/api/v2/uploads/workforcemanagement/historicaldata/csv',
141
141
  'POST',
142
- { },
143
- { },
144
- { },
145
- { },
142
+ { },
143
+ { },
144
+ { },
145
+ { },
146
146
  body,
147
147
  ['PureCloud OAuth'],
148
- ['application/json'],
148
+ ['application/json'],
149
149
  ['application/json']
150
150
  );
151
151
  }
@@ -5,7 +5,7 @@ class UsageApi {
5
5
  /**
6
6
  * Usage service.
7
7
  * @module purecloud-platform-client-v2/api/UsageApi
8
- * @version 135.0.0
8
+ * @version 137.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -34,13 +34,13 @@ class UsageApi {
34
34
  return this.apiClient.callApi(
35
35
  '/api/v2/usage/query/{executionId}/results',
36
36
  'GET',
37
- { 'executionId': executionId },
38
- { },
39
- { },
40
- { },
37
+ { 'executionId': executionId },
38
+ { },
39
+ { },
40
+ { },
41
41
  null,
42
42
  ['PureCloud OAuth'],
43
- ['application/json'],
43
+ ['application/json'],
44
44
  ['application/json']
45
45
  );
46
46
  }
@@ -59,13 +59,13 @@ class UsageApi {
59
59
  return this.apiClient.callApi(
60
60
  '/api/v2/usage/query',
61
61
  'POST',
62
- { },
63
- { },
64
- { },
65
- { },
62
+ { },
63
+ { },
64
+ { },
65
+ { },
66
66
  body,
67
67
  ['PureCloud OAuth'],
68
- ['application/json'],
68
+ ['application/json'],
69
69
  ['application/json']
70
70
  );
71
71
  }
@@ -5,7 +5,7 @@ class UserRecordingsApi {
5
5
  /**
6
6
  * UserRecordings service.
7
7
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
8
- * @version 135.0.0
8
+ * @version 137.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -34,13 +34,13 @@ class UserRecordingsApi {
34
34
  return this.apiClient.callApi(
35
35
  '/api/v2/userrecordings/{recordingId}',
36
36
  'DELETE',
37
- { 'recordingId': recordingId },
38
- { },
39
- { },
40
- { },
37
+ { 'recordingId': recordingId },
38
+ { },
39
+ { },
40
+ { },
41
41
  null,
42
42
  ['PureCloud OAuth'],
43
- ['application/json'],
43
+ ['application/json'],
44
44
  ['application/json']
45
45
  );
46
46
  }
@@ -63,13 +63,13 @@ class UserRecordingsApi {
63
63
  return this.apiClient.callApi(
64
64
  '/api/v2/userrecordings/{recordingId}',
65
65
  'GET',
66
- { 'recordingId': recordingId },
67
- { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
68
- { },
69
- { },
66
+ { 'recordingId': recordingId },
67
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
68
+ { },
69
+ { },
70
70
  null,
71
71
  ['PureCloud OAuth'],
72
- ['application/json'],
72
+ ['application/json'],
73
73
  ['application/json']
74
74
  );
75
75
  }
@@ -92,13 +92,13 @@ class UserRecordingsApi {
92
92
  return this.apiClient.callApi(
93
93
  '/api/v2/userrecordings/{recordingId}/media',
94
94
  'GET',
95
- { 'recordingId': recordingId },
96
- { 'formatId': opts['formatId'] },
97
- { },
98
- { },
95
+ { 'recordingId': recordingId },
96
+ { 'formatId': opts['formatId'] },
97
+ { },
98
+ { },
99
99
  null,
100
100
  ['PureCloud OAuth'],
101
- ['application/json'],
101
+ ['application/json'],
102
102
  ['application/json']
103
103
  );
104
104
  }
@@ -118,13 +118,13 @@ class UserRecordingsApi {
118
118
  return this.apiClient.callApi(
119
119
  '/api/v2/userrecordings',
120
120
  'GET',
121
- { },
122
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
123
- { },
124
- { },
121
+ { },
122
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
123
+ { },
124
+ { },
125
125
  null,
126
126
  ['PureCloud OAuth'],
127
- ['application/json'],
127
+ ['application/json'],
128
128
  ['application/json']
129
129
  );
130
130
  }
@@ -138,13 +138,13 @@ class UserRecordingsApi {
138
138
  return this.apiClient.callApi(
139
139
  '/api/v2/userrecordings/summary',
140
140
  'GET',
141
- { },
142
- { },
143
- { },
144
- { },
141
+ { },
142
+ { },
143
+ { },
144
+ { },
145
145
  null,
146
146
  ['PureCloud OAuth'],
147
- ['application/json'],
147
+ ['application/json'],
148
148
  ['application/json']
149
149
  );
150
150
  }
@@ -172,13 +172,13 @@ class UserRecordingsApi {
172
172
  return this.apiClient.callApi(
173
173
  '/api/v2/userrecordings/{recordingId}',
174
174
  'PUT',
175
- { 'recordingId': recordingId },
176
- { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
177
- { },
178
- { },
175
+ { 'recordingId': recordingId },
176
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
177
+ { },
178
+ { },
179
179
  body,
180
180
  ['PureCloud OAuth'],
181
- ['application/json'],
181
+ ['application/json'],
182
182
  ['application/json']
183
183
  );
184
184
  }