ultracart_rest_api_v2_typescript 4.0.100-RC → 4.0.102-RC
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.
- package/README.md +4 -2
- package/dist/apis/ConversationApi.d.ts +81 -0
- package/dist/apis/ConversationApi.js +171 -0
- package/dist/models/ConversationDepartment.d.ts +0 -6
- package/dist/models/ConversationDepartment.js +0 -2
- package/dist/models/ConversationEngagement.d.ts +6 -0
- package/dist/models/ConversationEngagement.js +2 -0
- package/package.json +1 -1
- package/src/apis/ConversationApi.ts +180 -0
- package/src/models/ConversationDepartment.ts +0 -8
- package/src/models/ConversationEngagement.ts +8 -0
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## ultracart_rest_api_v2_typescript@4.0.
|
|
1
|
+
## ultracart_rest_api_v2_typescript@4.0.102-RC
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install ultracart_rest_api_v2_typescript@4.0.
|
|
39
|
+
npm install ultracart_rest_api_v2_typescript@4.0.102-RC --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
|
|
|
54
54
|
|
|
55
55
|
| Version | Date | Comments |
|
|
56
56
|
| --: | :-: | --- |
|
|
57
|
+
| 4.0.102-RC | 12/21/2022 | conversation development |
|
|
58
|
+
| 4.0.101-RC | 12/20/2022 | conversation engagement update |
|
|
57
59
|
| 4.0.100-RC | 12/20/2022 | conversation engagement update |
|
|
58
60
|
| 4.0.99-RC | 12/15/2022 | conversation search - added start date filtering |
|
|
59
61
|
| 4.0.98-RC | 12/15/2022 | conversation searching |
|
|
@@ -11,6 +11,15 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
13
|
import { ConversationAgentAuthResponse, ConversationAutocompleteRequest, ConversationAutocompleteResponse, ConversationCannedMessage, ConversationCannedMessageResponse, ConversationCannedMessagesResponse, ConversationCannedMessagesSearch, ConversationDepartment, ConversationDepartmentResponse, ConversationDepartmentsResponse, ConversationEngagement, ConversationEngagementResponse, ConversationEngagementsResponse, ConversationJoinRequest, ConversationMessagesResponse, ConversationMultimediaUploadUrlResponse, ConversationResponse, ConversationSearchRequest, ConversationSearchResponse, ConversationStartRequest, ConversationStartResponse, ConversationWebchatContext, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse } from '../models';
|
|
14
|
+
export interface DeleteConversationCannedMessageRequest {
|
|
15
|
+
conversationCannedMessageOid: number;
|
|
16
|
+
}
|
|
17
|
+
export interface DeleteDepartmentRequest {
|
|
18
|
+
conversationDepartmentOid: number;
|
|
19
|
+
}
|
|
20
|
+
export interface DeleteEngagementRequest {
|
|
21
|
+
conversationEngagementOid: number;
|
|
22
|
+
}
|
|
14
23
|
export interface GetConversationRequest {
|
|
15
24
|
conversationUuid: string;
|
|
16
25
|
limit?: number;
|
|
@@ -86,6 +95,48 @@ export interface UpdateConversationWebchatQueueStatusRequest {
|
|
|
86
95
|
* @interface ConversationApiInterface
|
|
87
96
|
*/
|
|
88
97
|
export interface ConversationApiInterface {
|
|
98
|
+
/**
|
|
99
|
+
* Delete a conversation canned message
|
|
100
|
+
* @summary Delete a conversation canned message
|
|
101
|
+
* @param {number} conversationCannedMessageOid
|
|
102
|
+
* @param {*} [options] Override http request option.
|
|
103
|
+
* @throws {RequiredError}
|
|
104
|
+
* @memberof ConversationApiInterface
|
|
105
|
+
*/
|
|
106
|
+
deleteConversationCannedMessageRaw(requestParameters: DeleteConversationCannedMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
107
|
+
/**
|
|
108
|
+
* Delete a conversation canned message
|
|
109
|
+
* Delete a conversation canned message
|
|
110
|
+
*/
|
|
111
|
+
deleteConversationCannedMessage(requestParameters: DeleteConversationCannedMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
112
|
+
/**
|
|
113
|
+
* Delete a conversation department
|
|
114
|
+
* @summary Delete a conversation department
|
|
115
|
+
* @param {number} conversationDepartmentOid
|
|
116
|
+
* @param {*} [options] Override http request option.
|
|
117
|
+
* @throws {RequiredError}
|
|
118
|
+
* @memberof ConversationApiInterface
|
|
119
|
+
*/
|
|
120
|
+
deleteDepartmentRaw(requestParameters: DeleteDepartmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
121
|
+
/**
|
|
122
|
+
* Delete a conversation department
|
|
123
|
+
* Delete a conversation department
|
|
124
|
+
*/
|
|
125
|
+
deleteDepartment(requestParameters: DeleteDepartmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
126
|
+
/**
|
|
127
|
+
* Delete a conversation engagement
|
|
128
|
+
* @summary Delete a conversation engagement
|
|
129
|
+
* @param {number} conversationEngagementOid
|
|
130
|
+
* @param {*} [options] Override http request option.
|
|
131
|
+
* @throws {RequiredError}
|
|
132
|
+
* @memberof ConversationApiInterface
|
|
133
|
+
*/
|
|
134
|
+
deleteEngagementRaw(requestParameters: DeleteEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
135
|
+
/**
|
|
136
|
+
* Delete a conversation engagement
|
|
137
|
+
* Delete a conversation engagement
|
|
138
|
+
*/
|
|
139
|
+
deleteEngagement(requestParameters: DeleteEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
89
140
|
/**
|
|
90
141
|
* Called periodically by the conversation API to keep the session alive.
|
|
91
142
|
* @summary Agent keep alive
|
|
@@ -446,6 +497,36 @@ export interface ConversationApiInterface {
|
|
|
446
497
|
*
|
|
447
498
|
*/
|
|
448
499
|
export declare class ConversationApi extends runtime.BaseAPI implements ConversationApiInterface {
|
|
500
|
+
/**
|
|
501
|
+
* Delete a conversation canned message
|
|
502
|
+
* Delete a conversation canned message
|
|
503
|
+
*/
|
|
504
|
+
deleteConversationCannedMessageRaw(requestParameters: DeleteConversationCannedMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
505
|
+
/**
|
|
506
|
+
* Delete a conversation canned message
|
|
507
|
+
* Delete a conversation canned message
|
|
508
|
+
*/
|
|
509
|
+
deleteConversationCannedMessage(requestParameters: DeleteConversationCannedMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
510
|
+
/**
|
|
511
|
+
* Delete a conversation department
|
|
512
|
+
* Delete a conversation department
|
|
513
|
+
*/
|
|
514
|
+
deleteDepartmentRaw(requestParameters: DeleteDepartmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
515
|
+
/**
|
|
516
|
+
* Delete a conversation department
|
|
517
|
+
* Delete a conversation department
|
|
518
|
+
*/
|
|
519
|
+
deleteDepartment(requestParameters: DeleteDepartmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
520
|
+
/**
|
|
521
|
+
* Delete a conversation engagement
|
|
522
|
+
* Delete a conversation engagement
|
|
523
|
+
*/
|
|
524
|
+
deleteEngagementRaw(requestParameters: DeleteEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
525
|
+
/**
|
|
526
|
+
* Delete a conversation engagement
|
|
527
|
+
* Delete a conversation engagement
|
|
528
|
+
*/
|
|
529
|
+
deleteEngagement(requestParameters: DeleteEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
449
530
|
/**
|
|
450
531
|
* Called periodically by the conversation API to keep the session alive.
|
|
451
532
|
* Agent keep alive
|
|
@@ -75,6 +75,177 @@ var ConversationApi = /** @class */ (function (_super) {
|
|
|
75
75
|
function ConversationApi() {
|
|
76
76
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
77
77
|
}
|
|
78
|
+
/**
|
|
79
|
+
* Delete a conversation canned message
|
|
80
|
+
* Delete a conversation canned message
|
|
81
|
+
*/
|
|
82
|
+
ConversationApi.prototype.deleteConversationCannedMessageRaw = function (requestParameters, initOverrides) {
|
|
83
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
84
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
85
|
+
return __generator(this, function (_c) {
|
|
86
|
+
switch (_c.label) {
|
|
87
|
+
case 0:
|
|
88
|
+
if (requestParameters.conversationCannedMessageOid === null || requestParameters.conversationCannedMessageOid === undefined) {
|
|
89
|
+
throw new runtime.RequiredError('conversationCannedMessageOid', 'Required parameter requestParameters.conversationCannedMessageOid was null or undefined when calling deleteConversationCannedMessage.');
|
|
90
|
+
}
|
|
91
|
+
queryParameters = {};
|
|
92
|
+
headerParameters = {};
|
|
93
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
94
|
+
// oauth required
|
|
95
|
+
_a = headerParameters;
|
|
96
|
+
_b = "Authorization";
|
|
97
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["conversation_write"])];
|
|
98
|
+
case 1:
|
|
99
|
+
// oauth required
|
|
100
|
+
_a[_b] = _c.sent();
|
|
101
|
+
_c.label = 2;
|
|
102
|
+
case 2:
|
|
103
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
104
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
105
|
+
}
|
|
106
|
+
return [4 /*yield*/, this.request({
|
|
107
|
+
path: "/conversation/canned_messages/{conversation_canned_message_oid}".replace("{".concat("conversation_canned_message_oid", "}"), encodeURIComponent(String(requestParameters.conversationCannedMessageOid))),
|
|
108
|
+
method: 'DELETE',
|
|
109
|
+
headers: headerParameters,
|
|
110
|
+
query: queryParameters,
|
|
111
|
+
}, initOverrides)];
|
|
112
|
+
case 3:
|
|
113
|
+
response = _c.sent();
|
|
114
|
+
return [2 /*return*/, new runtime.VoidApiResponse(response)];
|
|
115
|
+
}
|
|
116
|
+
});
|
|
117
|
+
});
|
|
118
|
+
};
|
|
119
|
+
/**
|
|
120
|
+
* Delete a conversation canned message
|
|
121
|
+
* Delete a conversation canned message
|
|
122
|
+
*/
|
|
123
|
+
ConversationApi.prototype.deleteConversationCannedMessage = function (requestParameters, initOverrides) {
|
|
124
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
125
|
+
return __generator(this, function (_a) {
|
|
126
|
+
switch (_a.label) {
|
|
127
|
+
case 0: return [4 /*yield*/, this.deleteConversationCannedMessageRaw(requestParameters, initOverrides)];
|
|
128
|
+
case 1:
|
|
129
|
+
_a.sent();
|
|
130
|
+
return [2 /*return*/];
|
|
131
|
+
}
|
|
132
|
+
});
|
|
133
|
+
});
|
|
134
|
+
};
|
|
135
|
+
/**
|
|
136
|
+
* Delete a conversation department
|
|
137
|
+
* Delete a conversation department
|
|
138
|
+
*/
|
|
139
|
+
ConversationApi.prototype.deleteDepartmentRaw = function (requestParameters, initOverrides) {
|
|
140
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
141
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
142
|
+
return __generator(this, function (_c) {
|
|
143
|
+
switch (_c.label) {
|
|
144
|
+
case 0:
|
|
145
|
+
if (requestParameters.conversationDepartmentOid === null || requestParameters.conversationDepartmentOid === undefined) {
|
|
146
|
+
throw new runtime.RequiredError('conversationDepartmentOid', 'Required parameter requestParameters.conversationDepartmentOid was null or undefined when calling deleteDepartment.');
|
|
147
|
+
}
|
|
148
|
+
queryParameters = {};
|
|
149
|
+
headerParameters = {};
|
|
150
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
151
|
+
// oauth required
|
|
152
|
+
_a = headerParameters;
|
|
153
|
+
_b = "Authorization";
|
|
154
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["conversation_write"])];
|
|
155
|
+
case 1:
|
|
156
|
+
// oauth required
|
|
157
|
+
_a[_b] = _c.sent();
|
|
158
|
+
_c.label = 2;
|
|
159
|
+
case 2:
|
|
160
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
161
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
162
|
+
}
|
|
163
|
+
return [4 /*yield*/, this.request({
|
|
164
|
+
path: "/conversation/departments/{conversation_department_oid}".replace("{".concat("conversation_department_oid", "}"), encodeURIComponent(String(requestParameters.conversationDepartmentOid))),
|
|
165
|
+
method: 'DELETE',
|
|
166
|
+
headers: headerParameters,
|
|
167
|
+
query: queryParameters,
|
|
168
|
+
}, initOverrides)];
|
|
169
|
+
case 3:
|
|
170
|
+
response = _c.sent();
|
|
171
|
+
return [2 /*return*/, new runtime.VoidApiResponse(response)];
|
|
172
|
+
}
|
|
173
|
+
});
|
|
174
|
+
});
|
|
175
|
+
};
|
|
176
|
+
/**
|
|
177
|
+
* Delete a conversation department
|
|
178
|
+
* Delete a conversation department
|
|
179
|
+
*/
|
|
180
|
+
ConversationApi.prototype.deleteDepartment = function (requestParameters, initOverrides) {
|
|
181
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
182
|
+
return __generator(this, function (_a) {
|
|
183
|
+
switch (_a.label) {
|
|
184
|
+
case 0: return [4 /*yield*/, this.deleteDepartmentRaw(requestParameters, initOverrides)];
|
|
185
|
+
case 1:
|
|
186
|
+
_a.sent();
|
|
187
|
+
return [2 /*return*/];
|
|
188
|
+
}
|
|
189
|
+
});
|
|
190
|
+
});
|
|
191
|
+
};
|
|
192
|
+
/**
|
|
193
|
+
* Delete a conversation engagement
|
|
194
|
+
* Delete a conversation engagement
|
|
195
|
+
*/
|
|
196
|
+
ConversationApi.prototype.deleteEngagementRaw = function (requestParameters, initOverrides) {
|
|
197
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
198
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
199
|
+
return __generator(this, function (_c) {
|
|
200
|
+
switch (_c.label) {
|
|
201
|
+
case 0:
|
|
202
|
+
if (requestParameters.conversationEngagementOid === null || requestParameters.conversationEngagementOid === undefined) {
|
|
203
|
+
throw new runtime.RequiredError('conversationEngagementOid', 'Required parameter requestParameters.conversationEngagementOid was null or undefined when calling deleteEngagement.');
|
|
204
|
+
}
|
|
205
|
+
queryParameters = {};
|
|
206
|
+
headerParameters = {};
|
|
207
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
208
|
+
// oauth required
|
|
209
|
+
_a = headerParameters;
|
|
210
|
+
_b = "Authorization";
|
|
211
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["conversation_write"])];
|
|
212
|
+
case 1:
|
|
213
|
+
// oauth required
|
|
214
|
+
_a[_b] = _c.sent();
|
|
215
|
+
_c.label = 2;
|
|
216
|
+
case 2:
|
|
217
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
218
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
219
|
+
}
|
|
220
|
+
return [4 /*yield*/, this.request({
|
|
221
|
+
path: "/conversation/engagements/{conversation_engagement_oid}".replace("{".concat("conversation_engagement_oid", "}"), encodeURIComponent(String(requestParameters.conversationEngagementOid))),
|
|
222
|
+
method: 'DELETE',
|
|
223
|
+
headers: headerParameters,
|
|
224
|
+
query: queryParameters,
|
|
225
|
+
}, initOverrides)];
|
|
226
|
+
case 3:
|
|
227
|
+
response = _c.sent();
|
|
228
|
+
return [2 /*return*/, new runtime.VoidApiResponse(response)];
|
|
229
|
+
}
|
|
230
|
+
});
|
|
231
|
+
});
|
|
232
|
+
};
|
|
233
|
+
/**
|
|
234
|
+
* Delete a conversation engagement
|
|
235
|
+
* Delete a conversation engagement
|
|
236
|
+
*/
|
|
237
|
+
ConversationApi.prototype.deleteEngagement = function (requestParameters, initOverrides) {
|
|
238
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
239
|
+
return __generator(this, function (_a) {
|
|
240
|
+
switch (_a.label) {
|
|
241
|
+
case 0: return [4 /*yield*/, this.deleteEngagementRaw(requestParameters, initOverrides)];
|
|
242
|
+
case 1:
|
|
243
|
+
_a.sent();
|
|
244
|
+
return [2 /*return*/];
|
|
245
|
+
}
|
|
246
|
+
});
|
|
247
|
+
});
|
|
248
|
+
};
|
|
78
249
|
/**
|
|
79
250
|
* Called periodically by the conversation API to keep the session alive.
|
|
80
251
|
* Agent keep alive
|
|
@@ -21,12 +21,6 @@ export interface ConversationDepartment {
|
|
|
21
21
|
* @memberof ConversationDepartment
|
|
22
22
|
*/
|
|
23
23
|
conversation_department_oid?: number;
|
|
24
|
-
/**
|
|
25
|
-
*
|
|
26
|
-
* @type {boolean}
|
|
27
|
-
* @memberof ConversationDepartment
|
|
28
|
-
*/
|
|
29
|
-
delete_me?: boolean;
|
|
30
24
|
/**
|
|
31
25
|
*
|
|
32
26
|
* @type {string}
|
|
@@ -25,7 +25,6 @@ function ConversationDepartmentFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
25
25
|
}
|
|
26
26
|
return {
|
|
27
27
|
'conversation_department_oid': !(0, runtime_1.exists)(json, 'conversation_department_oid') ? undefined : json['conversation_department_oid'],
|
|
28
|
-
'delete_me': !(0, runtime_1.exists)(json, 'delete_me') ? undefined : json['delete_me'],
|
|
29
28
|
'department_name': !(0, runtime_1.exists)(json, 'department_name') ? undefined : json['department_name'],
|
|
30
29
|
'merchant_id': !(0, runtime_1.exists)(json, 'merchant_id') ? undefined : json['merchant_id'],
|
|
31
30
|
'settings': !(0, runtime_1.exists)(json, 'settings') ? undefined : json['settings'],
|
|
@@ -41,7 +40,6 @@ function ConversationDepartmentToJSON(value) {
|
|
|
41
40
|
}
|
|
42
41
|
return {
|
|
43
42
|
'conversation_department_oid': value.conversation_department_oid,
|
|
44
|
-
'delete_me': value.delete_me,
|
|
45
43
|
'department_name': value.department_name,
|
|
46
44
|
'merchant_id': value.merchant_id,
|
|
47
45
|
'settings': value.settings,
|
|
@@ -16,6 +16,12 @@ import { ConversationEngagementEquation } from './ConversationEngagementEquation
|
|
|
16
16
|
* @interface ConversationEngagement
|
|
17
17
|
*/
|
|
18
18
|
export interface ConversationEngagement {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {boolean}
|
|
22
|
+
* @memberof ConversationEngagement
|
|
23
|
+
*/
|
|
24
|
+
active?: boolean;
|
|
19
25
|
/**
|
|
20
26
|
*
|
|
21
27
|
* @type {number}
|
|
@@ -33,6 +33,7 @@ function ConversationEngagementFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
33
33
|
return json;
|
|
34
34
|
}
|
|
35
35
|
return {
|
|
36
|
+
'active': !(0, runtime_1.exists)(json, 'active') ? undefined : json['active'],
|
|
36
37
|
'conversation_engagement_oid': !(0, runtime_1.exists)(json, 'conversation_engagement_oid') ? undefined : json['conversation_engagement_oid'],
|
|
37
38
|
'customer_greeting': !(0, runtime_1.exists)(json, 'customer_greeting') ? undefined : json['customer_greeting'],
|
|
38
39
|
'department_oids': !(0, runtime_1.exists)(json, 'department_oids') ? undefined : json['department_oids'],
|
|
@@ -51,6 +52,7 @@ function ConversationEngagementToJSON(value) {
|
|
|
51
52
|
return null;
|
|
52
53
|
}
|
|
53
54
|
return {
|
|
55
|
+
'active': value.active,
|
|
54
56
|
'conversation_engagement_oid': value.conversation_engagement_oid,
|
|
55
57
|
'customer_greeting': value.customer_greeting,
|
|
56
58
|
'department_oids': value.department_oids,
|
package/package.json
CHANGED
|
@@ -95,6 +95,18 @@ import {
|
|
|
95
95
|
ErrorResponseToJSON,
|
|
96
96
|
} from '../models';
|
|
97
97
|
|
|
98
|
+
export interface DeleteConversationCannedMessageRequest {
|
|
99
|
+
conversationCannedMessageOid: number;
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
export interface DeleteDepartmentRequest {
|
|
103
|
+
conversationDepartmentOid: number;
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
export interface DeleteEngagementRequest {
|
|
107
|
+
conversationEngagementOid: number;
|
|
108
|
+
}
|
|
109
|
+
|
|
98
110
|
export interface GetConversationRequest {
|
|
99
111
|
conversationUuid: string;
|
|
100
112
|
limit?: number;
|
|
@@ -189,6 +201,54 @@ export interface UpdateConversationWebchatQueueStatusRequest {
|
|
|
189
201
|
* @interface ConversationApiInterface
|
|
190
202
|
*/
|
|
191
203
|
export interface ConversationApiInterface {
|
|
204
|
+
/**
|
|
205
|
+
* Delete a conversation canned message
|
|
206
|
+
* @summary Delete a conversation canned message
|
|
207
|
+
* @param {number} conversationCannedMessageOid
|
|
208
|
+
* @param {*} [options] Override http request option.
|
|
209
|
+
* @throws {RequiredError}
|
|
210
|
+
* @memberof ConversationApiInterface
|
|
211
|
+
*/
|
|
212
|
+
deleteConversationCannedMessageRaw(requestParameters: DeleteConversationCannedMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
213
|
+
|
|
214
|
+
/**
|
|
215
|
+
* Delete a conversation canned message
|
|
216
|
+
* Delete a conversation canned message
|
|
217
|
+
*/
|
|
218
|
+
deleteConversationCannedMessage(requestParameters: DeleteConversationCannedMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
219
|
+
|
|
220
|
+
/**
|
|
221
|
+
* Delete a conversation department
|
|
222
|
+
* @summary Delete a conversation department
|
|
223
|
+
* @param {number} conversationDepartmentOid
|
|
224
|
+
* @param {*} [options] Override http request option.
|
|
225
|
+
* @throws {RequiredError}
|
|
226
|
+
* @memberof ConversationApiInterface
|
|
227
|
+
*/
|
|
228
|
+
deleteDepartmentRaw(requestParameters: DeleteDepartmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
229
|
+
|
|
230
|
+
/**
|
|
231
|
+
* Delete a conversation department
|
|
232
|
+
* Delete a conversation department
|
|
233
|
+
*/
|
|
234
|
+
deleteDepartment(requestParameters: DeleteDepartmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
235
|
+
|
|
236
|
+
/**
|
|
237
|
+
* Delete a conversation engagement
|
|
238
|
+
* @summary Delete a conversation engagement
|
|
239
|
+
* @param {number} conversationEngagementOid
|
|
240
|
+
* @param {*} [options] Override http request option.
|
|
241
|
+
* @throws {RequiredError}
|
|
242
|
+
* @memberof ConversationApiInterface
|
|
243
|
+
*/
|
|
244
|
+
deleteEngagementRaw(requestParameters: DeleteEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
245
|
+
|
|
246
|
+
/**
|
|
247
|
+
* Delete a conversation engagement
|
|
248
|
+
* Delete a conversation engagement
|
|
249
|
+
*/
|
|
250
|
+
deleteEngagement(requestParameters: DeleteEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
251
|
+
|
|
192
252
|
/**
|
|
193
253
|
* Called periodically by the conversation API to keep the session alive.
|
|
194
254
|
* @summary Agent keep alive
|
|
@@ -601,6 +661,126 @@ export interface ConversationApiInterface {
|
|
|
601
661
|
*/
|
|
602
662
|
export class ConversationApi extends runtime.BaseAPI implements ConversationApiInterface {
|
|
603
663
|
|
|
664
|
+
/**
|
|
665
|
+
* Delete a conversation canned message
|
|
666
|
+
* Delete a conversation canned message
|
|
667
|
+
*/
|
|
668
|
+
async deleteConversationCannedMessageRaw(requestParameters: DeleteConversationCannedMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
669
|
+
if (requestParameters.conversationCannedMessageOid === null || requestParameters.conversationCannedMessageOid === undefined) {
|
|
670
|
+
throw new runtime.RequiredError('conversationCannedMessageOid','Required parameter requestParameters.conversationCannedMessageOid was null or undefined when calling deleteConversationCannedMessage.');
|
|
671
|
+
}
|
|
672
|
+
|
|
673
|
+
const queryParameters: any = {};
|
|
674
|
+
|
|
675
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
676
|
+
|
|
677
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
678
|
+
// oauth required
|
|
679
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["conversation_write"]);
|
|
680
|
+
}
|
|
681
|
+
|
|
682
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
683
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
684
|
+
}
|
|
685
|
+
|
|
686
|
+
const response = await this.request({
|
|
687
|
+
path: `/conversation/canned_messages/{conversation_canned_message_oid}`.replace(`{${"conversation_canned_message_oid"}}`, encodeURIComponent(String(requestParameters.conversationCannedMessageOid))),
|
|
688
|
+
method: 'DELETE',
|
|
689
|
+
headers: headerParameters,
|
|
690
|
+
query: queryParameters,
|
|
691
|
+
}, initOverrides);
|
|
692
|
+
|
|
693
|
+
return new runtime.VoidApiResponse(response);
|
|
694
|
+
}
|
|
695
|
+
|
|
696
|
+
/**
|
|
697
|
+
* Delete a conversation canned message
|
|
698
|
+
* Delete a conversation canned message
|
|
699
|
+
*/
|
|
700
|
+
async deleteConversationCannedMessage(requestParameters: DeleteConversationCannedMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
701
|
+
await this.deleteConversationCannedMessageRaw(requestParameters, initOverrides);
|
|
702
|
+
}
|
|
703
|
+
|
|
704
|
+
/**
|
|
705
|
+
* Delete a conversation department
|
|
706
|
+
* Delete a conversation department
|
|
707
|
+
*/
|
|
708
|
+
async deleteDepartmentRaw(requestParameters: DeleteDepartmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
709
|
+
if (requestParameters.conversationDepartmentOid === null || requestParameters.conversationDepartmentOid === undefined) {
|
|
710
|
+
throw new runtime.RequiredError('conversationDepartmentOid','Required parameter requestParameters.conversationDepartmentOid was null or undefined when calling deleteDepartment.');
|
|
711
|
+
}
|
|
712
|
+
|
|
713
|
+
const queryParameters: any = {};
|
|
714
|
+
|
|
715
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
716
|
+
|
|
717
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
718
|
+
// oauth required
|
|
719
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["conversation_write"]);
|
|
720
|
+
}
|
|
721
|
+
|
|
722
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
723
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
724
|
+
}
|
|
725
|
+
|
|
726
|
+
const response = await this.request({
|
|
727
|
+
path: `/conversation/departments/{conversation_department_oid}`.replace(`{${"conversation_department_oid"}}`, encodeURIComponent(String(requestParameters.conversationDepartmentOid))),
|
|
728
|
+
method: 'DELETE',
|
|
729
|
+
headers: headerParameters,
|
|
730
|
+
query: queryParameters,
|
|
731
|
+
}, initOverrides);
|
|
732
|
+
|
|
733
|
+
return new runtime.VoidApiResponse(response);
|
|
734
|
+
}
|
|
735
|
+
|
|
736
|
+
/**
|
|
737
|
+
* Delete a conversation department
|
|
738
|
+
* Delete a conversation department
|
|
739
|
+
*/
|
|
740
|
+
async deleteDepartment(requestParameters: DeleteDepartmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
741
|
+
await this.deleteDepartmentRaw(requestParameters, initOverrides);
|
|
742
|
+
}
|
|
743
|
+
|
|
744
|
+
/**
|
|
745
|
+
* Delete a conversation engagement
|
|
746
|
+
* Delete a conversation engagement
|
|
747
|
+
*/
|
|
748
|
+
async deleteEngagementRaw(requestParameters: DeleteEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
749
|
+
if (requestParameters.conversationEngagementOid === null || requestParameters.conversationEngagementOid === undefined) {
|
|
750
|
+
throw new runtime.RequiredError('conversationEngagementOid','Required parameter requestParameters.conversationEngagementOid was null or undefined when calling deleteEngagement.');
|
|
751
|
+
}
|
|
752
|
+
|
|
753
|
+
const queryParameters: any = {};
|
|
754
|
+
|
|
755
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
756
|
+
|
|
757
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
758
|
+
// oauth required
|
|
759
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["conversation_write"]);
|
|
760
|
+
}
|
|
761
|
+
|
|
762
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
763
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
764
|
+
}
|
|
765
|
+
|
|
766
|
+
const response = await this.request({
|
|
767
|
+
path: `/conversation/engagements/{conversation_engagement_oid}`.replace(`{${"conversation_engagement_oid"}}`, encodeURIComponent(String(requestParameters.conversationEngagementOid))),
|
|
768
|
+
method: 'DELETE',
|
|
769
|
+
headers: headerParameters,
|
|
770
|
+
query: queryParameters,
|
|
771
|
+
}, initOverrides);
|
|
772
|
+
|
|
773
|
+
return new runtime.VoidApiResponse(response);
|
|
774
|
+
}
|
|
775
|
+
|
|
776
|
+
/**
|
|
777
|
+
* Delete a conversation engagement
|
|
778
|
+
* Delete a conversation engagement
|
|
779
|
+
*/
|
|
780
|
+
async deleteEngagement(requestParameters: DeleteEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
781
|
+
await this.deleteEngagementRaw(requestParameters, initOverrides);
|
|
782
|
+
}
|
|
783
|
+
|
|
604
784
|
/**
|
|
605
785
|
* Called periodically by the conversation API to keep the session alive.
|
|
606
786
|
* Agent keep alive
|
|
@@ -25,12 +25,6 @@ export interface ConversationDepartment {
|
|
|
25
25
|
* @memberof ConversationDepartment
|
|
26
26
|
*/
|
|
27
27
|
conversation_department_oid?: number;
|
|
28
|
-
/**
|
|
29
|
-
*
|
|
30
|
-
* @type {boolean}
|
|
31
|
-
* @memberof ConversationDepartment
|
|
32
|
-
*/
|
|
33
|
-
delete_me?: boolean;
|
|
34
28
|
/**
|
|
35
29
|
*
|
|
36
30
|
* @type {string}
|
|
@@ -62,7 +56,6 @@ export function ConversationDepartmentFromJSONTyped(json: any, ignoreDiscriminat
|
|
|
62
56
|
return {
|
|
63
57
|
|
|
64
58
|
'conversation_department_oid': !exists(json, 'conversation_department_oid') ? undefined : json['conversation_department_oid'],
|
|
65
|
-
'delete_me': !exists(json, 'delete_me') ? undefined : json['delete_me'],
|
|
66
59
|
'department_name': !exists(json, 'department_name') ? undefined : json['department_name'],
|
|
67
60
|
'merchant_id': !exists(json, 'merchant_id') ? undefined : json['merchant_id'],
|
|
68
61
|
'settings': !exists(json, 'settings') ? undefined : json['settings'],
|
|
@@ -79,7 +72,6 @@ export function ConversationDepartmentToJSON(value?: ConversationDepartment | nu
|
|
|
79
72
|
return {
|
|
80
73
|
|
|
81
74
|
'conversation_department_oid': value.conversation_department_oid,
|
|
82
|
-
'delete_me': value.delete_me,
|
|
83
75
|
'department_name': value.department_name,
|
|
84
76
|
'merchant_id': value.merchant_id,
|
|
85
77
|
'settings': value.settings,
|
|
@@ -26,6 +26,12 @@ import {
|
|
|
26
26
|
* @interface ConversationEngagement
|
|
27
27
|
*/
|
|
28
28
|
export interface ConversationEngagement {
|
|
29
|
+
/**
|
|
30
|
+
*
|
|
31
|
+
* @type {boolean}
|
|
32
|
+
* @memberof ConversationEngagement
|
|
33
|
+
*/
|
|
34
|
+
active?: boolean;
|
|
29
35
|
/**
|
|
30
36
|
*
|
|
31
37
|
* @type {number}
|
|
@@ -92,6 +98,7 @@ export function ConversationEngagementFromJSONTyped(json: any, ignoreDiscriminat
|
|
|
92
98
|
}
|
|
93
99
|
return {
|
|
94
100
|
|
|
101
|
+
'active': !exists(json, 'active') ? undefined : json['active'],
|
|
95
102
|
'conversation_engagement_oid': !exists(json, 'conversation_engagement_oid') ? undefined : json['conversation_engagement_oid'],
|
|
96
103
|
'customer_greeting': !exists(json, 'customer_greeting') ? undefined : json['customer_greeting'],
|
|
97
104
|
'department_oids': !exists(json, 'department_oids') ? undefined : json['department_oids'],
|
|
@@ -111,6 +118,7 @@ export function ConversationEngagementToJSON(value?: ConversationEngagement | nu
|
|
|
111
118
|
}
|
|
112
119
|
return {
|
|
113
120
|
|
|
121
|
+
'active': value.active,
|
|
114
122
|
'conversation_engagement_oid': value.conversation_engagement_oid,
|
|
115
123
|
'customer_greeting': value.customer_greeting,
|
|
116
124
|
'department_oids': value.department_oids,
|