ultracart_rest_api_v2_typescript 4.0.63-RC → 4.0.64-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/.openapi-generator/FILES +1 -0
- package/README.md +3 -2
- package/dist/apis/ConversationApi.d.ts +57 -1
- package/dist/apis/ConversationApi.js +122 -0
- package/dist/models/ConversationMessagesResponse.d.ts +55 -0
- package/dist/models/ConversationMessagesResponse.js +54 -0
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/package.json +1 -1
- package/src/apis/ConversationApi.ts +133 -0
- package/src/models/ConversationMessagesResponse.ts +113 -0
- package/src/models/index.ts +1 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -149,6 +149,7 @@ src/models/ConversationEventReadMessage.ts
|
|
|
149
149
|
src/models/ConversationEventTyping.ts
|
|
150
150
|
src/models/ConversationMessage.ts
|
|
151
151
|
src/models/ConversationMessageTransportStatus.ts
|
|
152
|
+
src/models/ConversationMessagesResponse.ts
|
|
152
153
|
src/models/ConversationMultimediaUploadUrl.ts
|
|
153
154
|
src/models/ConversationMultimediaUploadUrlResponse.ts
|
|
154
155
|
src/models/ConversationParticipant.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## ultracart_rest_api_v2_typescript@4.0.
|
|
1
|
+
## ultracart_rest_api_v2_typescript@4.0.64-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.64-RC --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
|
|
|
54
54
|
|
|
55
55
|
| Version | Date | Comments |
|
|
56
56
|
| --: | :-: | --- |
|
|
57
|
+
| 4.0.64-RC | 09/19/2022 | conversations pagination |
|
|
57
58
|
| 4.0.63-RC | 09/13/2022 | storefront comms - postcard tracking |
|
|
58
59
|
| 4.0.62-RC | 09/12/2022 | storefront comm - send back reviews.io configured flag on getEmailSettings |
|
|
59
60
|
| 4.0.61-RC | 09/07/2022 | sf comms - using aws event ruler for bigquery segmentation validation |
|
|
@@ -10,9 +10,15 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { ConversationAgentAuthResponse, ConversationMultimediaUploadUrlResponse, ConversationResponse, ConversationStartRequest, ConversationStartResponse, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse } from '../models';
|
|
13
|
+
import { ConversationAgentAuthResponse, ConversationMessagesResponse, ConversationMultimediaUploadUrlResponse, ConversationResponse, ConversationStartRequest, ConversationStartResponse, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse } from '../models';
|
|
14
14
|
export interface GetConversationRequest {
|
|
15
15
|
conversationUuid: string;
|
|
16
|
+
limit?: number;
|
|
17
|
+
}
|
|
18
|
+
export interface GetConversationMessagesRequest {
|
|
19
|
+
conversationUuid: string;
|
|
20
|
+
since: number;
|
|
21
|
+
limit?: number;
|
|
16
22
|
}
|
|
17
23
|
export interface GetConversationMultimediaUploadUrlRequest {
|
|
18
24
|
extension: string;
|
|
@@ -42,6 +48,19 @@ export interface UpdateConversationWebchatQueueStatusRequest {
|
|
|
42
48
|
* @interface ConversationApiInterface
|
|
43
49
|
*/
|
|
44
50
|
export interface ConversationApiInterface {
|
|
51
|
+
/**
|
|
52
|
+
* Called periodically by the conversation API to keep the session alive.
|
|
53
|
+
* @summary Agent keep alive
|
|
54
|
+
* @param {*} [options] Override http request option.
|
|
55
|
+
* @throws {RequiredError}
|
|
56
|
+
* @memberof ConversationApiInterface
|
|
57
|
+
*/
|
|
58
|
+
getAgentKeepAliveRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
59
|
+
/**
|
|
60
|
+
* Called periodically by the conversation API to keep the session alive.
|
|
61
|
+
* Agent keep alive
|
|
62
|
+
*/
|
|
63
|
+
getAgentKeepAlive(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
45
64
|
/**
|
|
46
65
|
* Retrieve a JWT to authorize an agent to make a websocket connection.
|
|
47
66
|
* @summary Get agent websocket authorization
|
|
@@ -59,6 +78,7 @@ export interface ConversationApiInterface {
|
|
|
59
78
|
* Retrieve a conversation including the participants and messages
|
|
60
79
|
* @summary Retrieve a conversation
|
|
61
80
|
* @param {string} conversationUuid
|
|
81
|
+
* @param {number} [limit]
|
|
62
82
|
* @param {*} [options] Override http request option.
|
|
63
83
|
* @throws {RequiredError}
|
|
64
84
|
* @memberof ConversationApiInterface
|
|
@@ -69,6 +89,22 @@ export interface ConversationApiInterface {
|
|
|
69
89
|
* Retrieve a conversation
|
|
70
90
|
*/
|
|
71
91
|
getConversation(requestParameters: GetConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationResponse>;
|
|
92
|
+
/**
|
|
93
|
+
* Retrieve conversation messages since a particular time
|
|
94
|
+
* @summary Retrieve conversation messages
|
|
95
|
+
* @param {string} conversationUuid
|
|
96
|
+
* @param {number} since
|
|
97
|
+
* @param {number} [limit]
|
|
98
|
+
* @param {*} [options] Override http request option.
|
|
99
|
+
* @throws {RequiredError}
|
|
100
|
+
* @memberof ConversationApiInterface
|
|
101
|
+
*/
|
|
102
|
+
getConversationMessagesRaw(requestParameters: GetConversationMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationMessagesResponse>>;
|
|
103
|
+
/**
|
|
104
|
+
* Retrieve conversation messages since a particular time
|
|
105
|
+
* Retrieve conversation messages
|
|
106
|
+
*/
|
|
107
|
+
getConversationMessages(requestParameters: GetConversationMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationMessagesResponse>;
|
|
72
108
|
/**
|
|
73
109
|
* Get a presigned conersation multimedia upload URL
|
|
74
110
|
* @summary Get a presigned conersation multimedia upload URL
|
|
@@ -174,6 +210,16 @@ export interface ConversationApiInterface {
|
|
|
174
210
|
*
|
|
175
211
|
*/
|
|
176
212
|
export declare class ConversationApi extends runtime.BaseAPI implements ConversationApiInterface {
|
|
213
|
+
/**
|
|
214
|
+
* Called periodically by the conversation API to keep the session alive.
|
|
215
|
+
* Agent keep alive
|
|
216
|
+
*/
|
|
217
|
+
getAgentKeepAliveRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
218
|
+
/**
|
|
219
|
+
* Called periodically by the conversation API to keep the session alive.
|
|
220
|
+
* Agent keep alive
|
|
221
|
+
*/
|
|
222
|
+
getAgentKeepAlive(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
177
223
|
/**
|
|
178
224
|
* Retrieve a JWT to authorize an agent to make a websocket connection.
|
|
179
225
|
* Get agent websocket authorization
|
|
@@ -194,6 +240,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
|
|
|
194
240
|
* Retrieve a conversation
|
|
195
241
|
*/
|
|
196
242
|
getConversation(requestParameters: GetConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationResponse>;
|
|
243
|
+
/**
|
|
244
|
+
* Retrieve conversation messages since a particular time
|
|
245
|
+
* Retrieve conversation messages
|
|
246
|
+
*/
|
|
247
|
+
getConversationMessagesRaw(requestParameters: GetConversationMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationMessagesResponse>>;
|
|
248
|
+
/**
|
|
249
|
+
* Retrieve conversation messages since a particular time
|
|
250
|
+
* Retrieve conversation messages
|
|
251
|
+
*/
|
|
252
|
+
getConversationMessages(requestParameters: GetConversationMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationMessagesResponse>;
|
|
197
253
|
/**
|
|
198
254
|
* Get a presigned conersation multimedia upload URL
|
|
199
255
|
* Get a presigned conersation multimedia upload URL
|
|
@@ -75,6 +75,60 @@ var ConversationApi = /** @class */ (function (_super) {
|
|
|
75
75
|
function ConversationApi() {
|
|
76
76
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
77
77
|
}
|
|
78
|
+
/**
|
|
79
|
+
* Called periodically by the conversation API to keep the session alive.
|
|
80
|
+
* Agent keep alive
|
|
81
|
+
*/
|
|
82
|
+
ConversationApi.prototype.getAgentKeepAliveRaw = function (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
|
+
queryParameters = {};
|
|
89
|
+
headerParameters = {};
|
|
90
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
91
|
+
// oauth required
|
|
92
|
+
_a = headerParameters;
|
|
93
|
+
_b = "Authorization";
|
|
94
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["conversation_write"])];
|
|
95
|
+
case 1:
|
|
96
|
+
// oauth required
|
|
97
|
+
_a[_b] = _c.sent();
|
|
98
|
+
_c.label = 2;
|
|
99
|
+
case 2:
|
|
100
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
101
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
102
|
+
}
|
|
103
|
+
return [4 /*yield*/, this.request({
|
|
104
|
+
path: "/conversation/agent/keepalive",
|
|
105
|
+
method: 'GET',
|
|
106
|
+
headers: headerParameters,
|
|
107
|
+
query: queryParameters,
|
|
108
|
+
}, initOverrides)];
|
|
109
|
+
case 3:
|
|
110
|
+
response = _c.sent();
|
|
111
|
+
return [2 /*return*/, new runtime.VoidApiResponse(response)];
|
|
112
|
+
}
|
|
113
|
+
});
|
|
114
|
+
});
|
|
115
|
+
};
|
|
116
|
+
/**
|
|
117
|
+
* Called periodically by the conversation API to keep the session alive.
|
|
118
|
+
* Agent keep alive
|
|
119
|
+
*/
|
|
120
|
+
ConversationApi.prototype.getAgentKeepAlive = function (initOverrides) {
|
|
121
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
122
|
+
return __generator(this, function (_a) {
|
|
123
|
+
switch (_a.label) {
|
|
124
|
+
case 0: return [4 /*yield*/, this.getAgentKeepAliveRaw(initOverrides)];
|
|
125
|
+
case 1:
|
|
126
|
+
_a.sent();
|
|
127
|
+
return [2 /*return*/];
|
|
128
|
+
}
|
|
129
|
+
});
|
|
130
|
+
});
|
|
131
|
+
};
|
|
78
132
|
/**
|
|
79
133
|
* Retrieve a JWT to authorize an agent to make a websocket connection.
|
|
80
134
|
* Get agent websocket authorization
|
|
@@ -145,6 +199,9 @@ var ConversationApi = /** @class */ (function (_super) {
|
|
|
145
199
|
throw new runtime.RequiredError('conversationUuid', 'Required parameter requestParameters.conversationUuid was null or undefined when calling getConversation.');
|
|
146
200
|
}
|
|
147
201
|
queryParameters = {};
|
|
202
|
+
if (requestParameters.limit !== undefined) {
|
|
203
|
+
queryParameters['limit'] = requestParameters.limit;
|
|
204
|
+
}
|
|
148
205
|
headerParameters = {};
|
|
149
206
|
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
150
207
|
// oauth required
|
|
@@ -190,6 +247,71 @@ var ConversationApi = /** @class */ (function (_super) {
|
|
|
190
247
|
});
|
|
191
248
|
});
|
|
192
249
|
};
|
|
250
|
+
/**
|
|
251
|
+
* Retrieve conversation messages since a particular time
|
|
252
|
+
* Retrieve conversation messages
|
|
253
|
+
*/
|
|
254
|
+
ConversationApi.prototype.getConversationMessagesRaw = function (requestParameters, initOverrides) {
|
|
255
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
256
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
257
|
+
return __generator(this, function (_c) {
|
|
258
|
+
switch (_c.label) {
|
|
259
|
+
case 0:
|
|
260
|
+
if (requestParameters.conversationUuid === null || requestParameters.conversationUuid === undefined) {
|
|
261
|
+
throw new runtime.RequiredError('conversationUuid', 'Required parameter requestParameters.conversationUuid was null or undefined when calling getConversationMessages.');
|
|
262
|
+
}
|
|
263
|
+
if (requestParameters.since === null || requestParameters.since === undefined) {
|
|
264
|
+
throw new runtime.RequiredError('since', 'Required parameter requestParameters.since was null or undefined when calling getConversationMessages.');
|
|
265
|
+
}
|
|
266
|
+
queryParameters = {};
|
|
267
|
+
if (requestParameters.limit !== undefined) {
|
|
268
|
+
queryParameters['limit'] = requestParameters.limit;
|
|
269
|
+
}
|
|
270
|
+
headerParameters = {};
|
|
271
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
272
|
+
// oauth required
|
|
273
|
+
_a = headerParameters;
|
|
274
|
+
_b = "Authorization";
|
|
275
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["conversation_read"])];
|
|
276
|
+
case 1:
|
|
277
|
+
// oauth required
|
|
278
|
+
_a[_b] = _c.sent();
|
|
279
|
+
_c.label = 2;
|
|
280
|
+
case 2:
|
|
281
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
282
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
283
|
+
}
|
|
284
|
+
return [4 /*yield*/, this.request({
|
|
285
|
+
path: "/conversation/conversations/{conversation_uuid}/messages/{since}".replace("{".concat("conversation_uuid", "}"), encodeURIComponent(String(requestParameters.conversationUuid))).replace("{".concat("since", "}"), encodeURIComponent(String(requestParameters.since))),
|
|
286
|
+
method: 'GET',
|
|
287
|
+
headers: headerParameters,
|
|
288
|
+
query: queryParameters,
|
|
289
|
+
}, initOverrides)];
|
|
290
|
+
case 3:
|
|
291
|
+
response = _c.sent();
|
|
292
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ConversationMessagesResponseFromJSON)(jsonValue); })];
|
|
293
|
+
}
|
|
294
|
+
});
|
|
295
|
+
});
|
|
296
|
+
};
|
|
297
|
+
/**
|
|
298
|
+
* Retrieve conversation messages since a particular time
|
|
299
|
+
* Retrieve conversation messages
|
|
300
|
+
*/
|
|
301
|
+
ConversationApi.prototype.getConversationMessages = function (requestParameters, initOverrides) {
|
|
302
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
303
|
+
var response;
|
|
304
|
+
return __generator(this, function (_a) {
|
|
305
|
+
switch (_a.label) {
|
|
306
|
+
case 0: return [4 /*yield*/, this.getConversationMessagesRaw(requestParameters, initOverrides)];
|
|
307
|
+
case 1:
|
|
308
|
+
response = _a.sent();
|
|
309
|
+
return [4 /*yield*/, response.value()];
|
|
310
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
311
|
+
}
|
|
312
|
+
});
|
|
313
|
+
});
|
|
314
|
+
};
|
|
193
315
|
/**
|
|
194
316
|
* Get a presigned conersation multimedia upload URL
|
|
195
317
|
* Get a presigned conersation multimedia upload URL
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* UltraCart Rest API V2
|
|
3
|
+
* UltraCart REST API Version 2
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.0.0
|
|
6
|
+
* Contact: support@ultracart.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { ConversationMessage } from './ConversationMessage';
|
|
13
|
+
import { ModelError } from './ModelError';
|
|
14
|
+
import { ResponseMetadata } from './ResponseMetadata';
|
|
15
|
+
import { Warning } from './Warning';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface ConversationMessagesResponse
|
|
20
|
+
*/
|
|
21
|
+
export interface ConversationMessagesResponse {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @type {Array<ConversationMessage>}
|
|
25
|
+
* @memberof ConversationMessagesResponse
|
|
26
|
+
*/
|
|
27
|
+
conversation_messages?: Array<ConversationMessage>;
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
* @type {ModelError}
|
|
31
|
+
* @memberof ConversationMessagesResponse
|
|
32
|
+
*/
|
|
33
|
+
error?: ModelError;
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
* @type {ResponseMetadata}
|
|
37
|
+
* @memberof ConversationMessagesResponse
|
|
38
|
+
*/
|
|
39
|
+
metadata?: ResponseMetadata;
|
|
40
|
+
/**
|
|
41
|
+
* Indicates if API call was successful
|
|
42
|
+
* @type {boolean}
|
|
43
|
+
* @memberof ConversationMessagesResponse
|
|
44
|
+
*/
|
|
45
|
+
success?: boolean;
|
|
46
|
+
/**
|
|
47
|
+
*
|
|
48
|
+
* @type {Warning}
|
|
49
|
+
* @memberof ConversationMessagesResponse
|
|
50
|
+
*/
|
|
51
|
+
warning?: Warning;
|
|
52
|
+
}
|
|
53
|
+
export declare function ConversationMessagesResponseFromJSON(json: any): ConversationMessagesResponse;
|
|
54
|
+
export declare function ConversationMessagesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationMessagesResponse;
|
|
55
|
+
export declare function ConversationMessagesResponseToJSON(value?: ConversationMessagesResponse | null): any;
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* UltraCart Rest API V2
|
|
6
|
+
* UltraCart REST API Version 2
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2.0.0
|
|
9
|
+
* Contact: support@ultracart.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.ConversationMessagesResponseToJSON = exports.ConversationMessagesResponseFromJSONTyped = exports.ConversationMessagesResponseFromJSON = void 0;
|
|
17
|
+
var runtime_1 = require("../runtime");
|
|
18
|
+
var ConversationMessage_1 = require("./ConversationMessage");
|
|
19
|
+
var ModelError_1 = require("./ModelError");
|
|
20
|
+
var ResponseMetadata_1 = require("./ResponseMetadata");
|
|
21
|
+
var Warning_1 = require("./Warning");
|
|
22
|
+
function ConversationMessagesResponseFromJSON(json) {
|
|
23
|
+
return ConversationMessagesResponseFromJSONTyped(json, false);
|
|
24
|
+
}
|
|
25
|
+
exports.ConversationMessagesResponseFromJSON = ConversationMessagesResponseFromJSON;
|
|
26
|
+
function ConversationMessagesResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
27
|
+
if ((json === undefined) || (json === null)) {
|
|
28
|
+
return json;
|
|
29
|
+
}
|
|
30
|
+
return {
|
|
31
|
+
'conversation_messages': !(0, runtime_1.exists)(json, 'conversation_messages') ? undefined : (json['conversation_messages'].map(ConversationMessage_1.ConversationMessageFromJSON)),
|
|
32
|
+
'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
|
|
33
|
+
'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
|
|
34
|
+
'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
|
|
35
|
+
'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
|
|
36
|
+
};
|
|
37
|
+
}
|
|
38
|
+
exports.ConversationMessagesResponseFromJSONTyped = ConversationMessagesResponseFromJSONTyped;
|
|
39
|
+
function ConversationMessagesResponseToJSON(value) {
|
|
40
|
+
if (value === undefined) {
|
|
41
|
+
return undefined;
|
|
42
|
+
}
|
|
43
|
+
if (value === null) {
|
|
44
|
+
return null;
|
|
45
|
+
}
|
|
46
|
+
return {
|
|
47
|
+
'conversation_messages': value.conversation_messages === undefined ? undefined : (value.conversation_messages.map(ConversationMessage_1.ConversationMessageToJSON)),
|
|
48
|
+
'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
|
|
49
|
+
'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
|
|
50
|
+
'success': value.success,
|
|
51
|
+
'warning': (0, Warning_1.WarningToJSON)(value.warning),
|
|
52
|
+
};
|
|
53
|
+
}
|
|
54
|
+
exports.ConversationMessagesResponseToJSON = ConversationMessagesResponseToJSON;
|
package/dist/models/index.d.ts
CHANGED
|
@@ -124,6 +124,7 @@ export * from './ConversationEventReadMessage';
|
|
|
124
124
|
export * from './ConversationEventTyping';
|
|
125
125
|
export * from './ConversationMessage';
|
|
126
126
|
export * from './ConversationMessageTransportStatus';
|
|
127
|
+
export * from './ConversationMessagesResponse';
|
|
127
128
|
export * from './ConversationMultimediaUploadUrl';
|
|
128
129
|
export * from './ConversationMultimediaUploadUrlResponse';
|
|
129
130
|
export * from './ConversationParticipant';
|
package/dist/models/index.js
CHANGED
|
@@ -142,6 +142,7 @@ __exportStar(require("./ConversationEventReadMessage"), exports);
|
|
|
142
142
|
__exportStar(require("./ConversationEventTyping"), exports);
|
|
143
143
|
__exportStar(require("./ConversationMessage"), exports);
|
|
144
144
|
__exportStar(require("./ConversationMessageTransportStatus"), exports);
|
|
145
|
+
__exportStar(require("./ConversationMessagesResponse"), exports);
|
|
145
146
|
__exportStar(require("./ConversationMultimediaUploadUrl"), exports);
|
|
146
147
|
__exportStar(require("./ConversationMultimediaUploadUrlResponse"), exports);
|
|
147
148
|
__exportStar(require("./ConversationParticipant"), exports);
|
package/package.json
CHANGED
|
@@ -18,6 +18,9 @@ import {
|
|
|
18
18
|
ConversationAgentAuthResponse,
|
|
19
19
|
ConversationAgentAuthResponseFromJSON,
|
|
20
20
|
ConversationAgentAuthResponseToJSON,
|
|
21
|
+
ConversationMessagesResponse,
|
|
22
|
+
ConversationMessagesResponseFromJSON,
|
|
23
|
+
ConversationMessagesResponseToJSON,
|
|
21
24
|
ConversationMultimediaUploadUrlResponse,
|
|
22
25
|
ConversationMultimediaUploadUrlResponseFromJSON,
|
|
23
26
|
ConversationMultimediaUploadUrlResponseToJSON,
|
|
@@ -46,6 +49,13 @@ import {
|
|
|
46
49
|
|
|
47
50
|
export interface GetConversationRequest {
|
|
48
51
|
conversationUuid: string;
|
|
52
|
+
limit?: number;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
export interface GetConversationMessagesRequest {
|
|
56
|
+
conversationUuid: string;
|
|
57
|
+
since: number;
|
|
58
|
+
limit?: number;
|
|
49
59
|
}
|
|
50
60
|
|
|
51
61
|
export interface GetConversationMultimediaUploadUrlRequest {
|
|
@@ -82,6 +92,21 @@ export interface UpdateConversationWebchatQueueStatusRequest {
|
|
|
82
92
|
* @interface ConversationApiInterface
|
|
83
93
|
*/
|
|
84
94
|
export interface ConversationApiInterface {
|
|
95
|
+
/**
|
|
96
|
+
* Called periodically by the conversation API to keep the session alive.
|
|
97
|
+
* @summary Agent keep alive
|
|
98
|
+
* @param {*} [options] Override http request option.
|
|
99
|
+
* @throws {RequiredError}
|
|
100
|
+
* @memberof ConversationApiInterface
|
|
101
|
+
*/
|
|
102
|
+
getAgentKeepAliveRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
103
|
+
|
|
104
|
+
/**
|
|
105
|
+
* Called periodically by the conversation API to keep the session alive.
|
|
106
|
+
* Agent keep alive
|
|
107
|
+
*/
|
|
108
|
+
getAgentKeepAlive(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
109
|
+
|
|
85
110
|
/**
|
|
86
111
|
* Retrieve a JWT to authorize an agent to make a websocket connection.
|
|
87
112
|
* @summary Get agent websocket authorization
|
|
@@ -101,6 +126,7 @@ export interface ConversationApiInterface {
|
|
|
101
126
|
* Retrieve a conversation including the participants and messages
|
|
102
127
|
* @summary Retrieve a conversation
|
|
103
128
|
* @param {string} conversationUuid
|
|
129
|
+
* @param {number} [limit]
|
|
104
130
|
* @param {*} [options] Override http request option.
|
|
105
131
|
* @throws {RequiredError}
|
|
106
132
|
* @memberof ConversationApiInterface
|
|
@@ -113,6 +139,24 @@ export interface ConversationApiInterface {
|
|
|
113
139
|
*/
|
|
114
140
|
getConversation(requestParameters: GetConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationResponse>;
|
|
115
141
|
|
|
142
|
+
/**
|
|
143
|
+
* Retrieve conversation messages since a particular time
|
|
144
|
+
* @summary Retrieve conversation messages
|
|
145
|
+
* @param {string} conversationUuid
|
|
146
|
+
* @param {number} since
|
|
147
|
+
* @param {number} [limit]
|
|
148
|
+
* @param {*} [options] Override http request option.
|
|
149
|
+
* @throws {RequiredError}
|
|
150
|
+
* @memberof ConversationApiInterface
|
|
151
|
+
*/
|
|
152
|
+
getConversationMessagesRaw(requestParameters: GetConversationMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationMessagesResponse>>;
|
|
153
|
+
|
|
154
|
+
/**
|
|
155
|
+
* Retrieve conversation messages since a particular time
|
|
156
|
+
* Retrieve conversation messages
|
|
157
|
+
*/
|
|
158
|
+
getConversationMessages(requestParameters: GetConversationMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationMessagesResponse>;
|
|
159
|
+
|
|
116
160
|
/**
|
|
117
161
|
* Get a presigned conersation multimedia upload URL
|
|
118
162
|
* @summary Get a presigned conersation multimedia upload URL
|
|
@@ -234,6 +278,42 @@ export interface ConversationApiInterface {
|
|
|
234
278
|
*/
|
|
235
279
|
export class ConversationApi extends runtime.BaseAPI implements ConversationApiInterface {
|
|
236
280
|
|
|
281
|
+
/**
|
|
282
|
+
* Called periodically by the conversation API to keep the session alive.
|
|
283
|
+
* Agent keep alive
|
|
284
|
+
*/
|
|
285
|
+
async getAgentKeepAliveRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
286
|
+
const queryParameters: any = {};
|
|
287
|
+
|
|
288
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
289
|
+
|
|
290
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
291
|
+
// oauth required
|
|
292
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["conversation_write"]);
|
|
293
|
+
}
|
|
294
|
+
|
|
295
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
296
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
297
|
+
}
|
|
298
|
+
|
|
299
|
+
const response = await this.request({
|
|
300
|
+
path: `/conversation/agent/keepalive`,
|
|
301
|
+
method: 'GET',
|
|
302
|
+
headers: headerParameters,
|
|
303
|
+
query: queryParameters,
|
|
304
|
+
}, initOverrides);
|
|
305
|
+
|
|
306
|
+
return new runtime.VoidApiResponse(response);
|
|
307
|
+
}
|
|
308
|
+
|
|
309
|
+
/**
|
|
310
|
+
* Called periodically by the conversation API to keep the session alive.
|
|
311
|
+
* Agent keep alive
|
|
312
|
+
*/
|
|
313
|
+
async getAgentKeepAlive(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
314
|
+
await this.getAgentKeepAliveRaw(initOverrides);
|
|
315
|
+
}
|
|
316
|
+
|
|
237
317
|
/**
|
|
238
318
|
* Retrieve a JWT to authorize an agent to make a websocket connection.
|
|
239
319
|
* Get agent websocket authorization
|
|
@@ -282,6 +362,10 @@ export class ConversationApi extends runtime.BaseAPI implements ConversationApiI
|
|
|
282
362
|
|
|
283
363
|
const queryParameters: any = {};
|
|
284
364
|
|
|
365
|
+
if (requestParameters.limit !== undefined) {
|
|
366
|
+
queryParameters['limit'] = requestParameters.limit;
|
|
367
|
+
}
|
|
368
|
+
|
|
285
369
|
const headerParameters: runtime.HTTPHeaders = {};
|
|
286
370
|
|
|
287
371
|
if (this.configuration && this.configuration.accessToken) {
|
|
@@ -312,6 +396,55 @@ export class ConversationApi extends runtime.BaseAPI implements ConversationApiI
|
|
|
312
396
|
return await response.value();
|
|
313
397
|
}
|
|
314
398
|
|
|
399
|
+
/**
|
|
400
|
+
* Retrieve conversation messages since a particular time
|
|
401
|
+
* Retrieve conversation messages
|
|
402
|
+
*/
|
|
403
|
+
async getConversationMessagesRaw(requestParameters: GetConversationMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationMessagesResponse>> {
|
|
404
|
+
if (requestParameters.conversationUuid === null || requestParameters.conversationUuid === undefined) {
|
|
405
|
+
throw new runtime.RequiredError('conversationUuid','Required parameter requestParameters.conversationUuid was null or undefined when calling getConversationMessages.');
|
|
406
|
+
}
|
|
407
|
+
|
|
408
|
+
if (requestParameters.since === null || requestParameters.since === undefined) {
|
|
409
|
+
throw new runtime.RequiredError('since','Required parameter requestParameters.since was null or undefined when calling getConversationMessages.');
|
|
410
|
+
}
|
|
411
|
+
|
|
412
|
+
const queryParameters: any = {};
|
|
413
|
+
|
|
414
|
+
if (requestParameters.limit !== undefined) {
|
|
415
|
+
queryParameters['limit'] = requestParameters.limit;
|
|
416
|
+
}
|
|
417
|
+
|
|
418
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
419
|
+
|
|
420
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
421
|
+
// oauth required
|
|
422
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["conversation_read"]);
|
|
423
|
+
}
|
|
424
|
+
|
|
425
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
426
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
427
|
+
}
|
|
428
|
+
|
|
429
|
+
const response = await this.request({
|
|
430
|
+
path: `/conversation/conversations/{conversation_uuid}/messages/{since}`.replace(`{${"conversation_uuid"}}`, encodeURIComponent(String(requestParameters.conversationUuid))).replace(`{${"since"}}`, encodeURIComponent(String(requestParameters.since))),
|
|
431
|
+
method: 'GET',
|
|
432
|
+
headers: headerParameters,
|
|
433
|
+
query: queryParameters,
|
|
434
|
+
}, initOverrides);
|
|
435
|
+
|
|
436
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => ConversationMessagesResponseFromJSON(jsonValue));
|
|
437
|
+
}
|
|
438
|
+
|
|
439
|
+
/**
|
|
440
|
+
* Retrieve conversation messages since a particular time
|
|
441
|
+
* Retrieve conversation messages
|
|
442
|
+
*/
|
|
443
|
+
async getConversationMessages(requestParameters: GetConversationMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationMessagesResponse> {
|
|
444
|
+
const response = await this.getConversationMessagesRaw(requestParameters, initOverrides);
|
|
445
|
+
return await response.value();
|
|
446
|
+
}
|
|
447
|
+
|
|
315
448
|
/**
|
|
316
449
|
* Get a presigned conersation multimedia upload URL
|
|
317
450
|
* Get a presigned conersation multimedia upload URL
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* UltraCart Rest API V2
|
|
5
|
+
* UltraCart REST API Version 2
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2.0.0
|
|
8
|
+
* Contact: support@ultracart.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { exists, mapValues } from '../runtime';
|
|
16
|
+
import {
|
|
17
|
+
ConversationMessage,
|
|
18
|
+
ConversationMessageFromJSON,
|
|
19
|
+
ConversationMessageFromJSONTyped,
|
|
20
|
+
ConversationMessageToJSON,
|
|
21
|
+
} from './ConversationMessage';
|
|
22
|
+
import {
|
|
23
|
+
ModelError,
|
|
24
|
+
ModelErrorFromJSON,
|
|
25
|
+
ModelErrorFromJSONTyped,
|
|
26
|
+
ModelErrorToJSON,
|
|
27
|
+
} from './ModelError';
|
|
28
|
+
import {
|
|
29
|
+
ResponseMetadata,
|
|
30
|
+
ResponseMetadataFromJSON,
|
|
31
|
+
ResponseMetadataFromJSONTyped,
|
|
32
|
+
ResponseMetadataToJSON,
|
|
33
|
+
} from './ResponseMetadata';
|
|
34
|
+
import {
|
|
35
|
+
Warning,
|
|
36
|
+
WarningFromJSON,
|
|
37
|
+
WarningFromJSONTyped,
|
|
38
|
+
WarningToJSON,
|
|
39
|
+
} from './Warning';
|
|
40
|
+
|
|
41
|
+
/**
|
|
42
|
+
*
|
|
43
|
+
* @export
|
|
44
|
+
* @interface ConversationMessagesResponse
|
|
45
|
+
*/
|
|
46
|
+
export interface ConversationMessagesResponse {
|
|
47
|
+
/**
|
|
48
|
+
*
|
|
49
|
+
* @type {Array<ConversationMessage>}
|
|
50
|
+
* @memberof ConversationMessagesResponse
|
|
51
|
+
*/
|
|
52
|
+
conversation_messages?: Array<ConversationMessage>;
|
|
53
|
+
/**
|
|
54
|
+
*
|
|
55
|
+
* @type {ModelError}
|
|
56
|
+
* @memberof ConversationMessagesResponse
|
|
57
|
+
*/
|
|
58
|
+
error?: ModelError;
|
|
59
|
+
/**
|
|
60
|
+
*
|
|
61
|
+
* @type {ResponseMetadata}
|
|
62
|
+
* @memberof ConversationMessagesResponse
|
|
63
|
+
*/
|
|
64
|
+
metadata?: ResponseMetadata;
|
|
65
|
+
/**
|
|
66
|
+
* Indicates if API call was successful
|
|
67
|
+
* @type {boolean}
|
|
68
|
+
* @memberof ConversationMessagesResponse
|
|
69
|
+
*/
|
|
70
|
+
success?: boolean;
|
|
71
|
+
/**
|
|
72
|
+
*
|
|
73
|
+
* @type {Warning}
|
|
74
|
+
* @memberof ConversationMessagesResponse
|
|
75
|
+
*/
|
|
76
|
+
warning?: Warning;
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
export function ConversationMessagesResponseFromJSON(json: any): ConversationMessagesResponse {
|
|
80
|
+
return ConversationMessagesResponseFromJSONTyped(json, false);
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
export function ConversationMessagesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationMessagesResponse {
|
|
84
|
+
if ((json === undefined) || (json === null)) {
|
|
85
|
+
return json;
|
|
86
|
+
}
|
|
87
|
+
return {
|
|
88
|
+
|
|
89
|
+
'conversation_messages': !exists(json, 'conversation_messages') ? undefined : ((json['conversation_messages'] as Array<any>).map(ConversationMessageFromJSON)),
|
|
90
|
+
'error': !exists(json, 'error') ? undefined : ModelErrorFromJSON(json['error']),
|
|
91
|
+
'metadata': !exists(json, 'metadata') ? undefined : ResponseMetadataFromJSON(json['metadata']),
|
|
92
|
+
'success': !exists(json, 'success') ? undefined : json['success'],
|
|
93
|
+
'warning': !exists(json, 'warning') ? undefined : WarningFromJSON(json['warning']),
|
|
94
|
+
};
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
export function ConversationMessagesResponseToJSON(value?: ConversationMessagesResponse | null): any {
|
|
98
|
+
if (value === undefined) {
|
|
99
|
+
return undefined;
|
|
100
|
+
}
|
|
101
|
+
if (value === null) {
|
|
102
|
+
return null;
|
|
103
|
+
}
|
|
104
|
+
return {
|
|
105
|
+
|
|
106
|
+
'conversation_messages': value.conversation_messages === undefined ? undefined : ((value.conversation_messages as Array<any>).map(ConversationMessageToJSON)),
|
|
107
|
+
'error': ModelErrorToJSON(value.error),
|
|
108
|
+
'metadata': ResponseMetadataToJSON(value.metadata),
|
|
109
|
+
'success': value.success,
|
|
110
|
+
'warning': WarningToJSON(value.warning),
|
|
111
|
+
};
|
|
112
|
+
}
|
|
113
|
+
|
package/src/models/index.ts
CHANGED
|
@@ -126,6 +126,7 @@ export * from './ConversationEventReadMessage';
|
|
|
126
126
|
export * from './ConversationEventTyping';
|
|
127
127
|
export * from './ConversationMessage';
|
|
128
128
|
export * from './ConversationMessageTransportStatus';
|
|
129
|
+
export * from './ConversationMessagesResponse';
|
|
129
130
|
export * from './ConversationMultimediaUploadUrl';
|
|
130
131
|
export * from './ConversationMultimediaUploadUrlResponse';
|
|
131
132
|
export * from './ConversationParticipant';
|