ultracart_rest_api_v2_typescript 4.0.104-RC → 4.0.106-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/models/ConversationWebsocketMessage.d.ts +27 -0
- package/dist/models/ConversationWebsocketMessage.js +11 -0
- package/dist/models/EmailFlow.d.ts +6 -0
- package/dist/models/EmailFlow.js +2 -0
- package/package.json +1 -1
- package/src/models/ConversationWebsocketMessage.ts +40 -0
- package/src/models/EmailFlow.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.106-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.106-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.106-RC | 01/05/2023 | communications - added maximum_enrolled flag on flow object |
|
|
58
|
+
| 4.0.105-RC | 01/03/2023 | conversation events for party leave and join |
|
|
57
59
|
| 4.0.104-RC | 01/03/2023 | order point of sale details |
|
|
58
60
|
| 4.0.103-RC | 12/27/2022 | additional loyalty related coupons |
|
|
59
61
|
| 4.0.102-RC | 12/21/2022 | conversation development |
|
|
@@ -17,6 +17,7 @@ import { ConversationEventReadMessage } from './ConversationEventReadMessage';
|
|
|
17
17
|
import { ConversationEventTyping } from './ConversationEventTyping';
|
|
18
18
|
import { ConversationEventWebchatContext } from './ConversationEventWebchatContext';
|
|
19
19
|
import { ConversationMessage } from './ConversationMessage';
|
|
20
|
+
import { ConversationParticipant } from './ConversationParticipant';
|
|
20
21
|
import { ConversationSummary } from './ConversationSummary';
|
|
21
22
|
import { ConversationWebchatQueueStatus } from './ConversationWebchatQueueStatus';
|
|
22
23
|
/**
|
|
@@ -61,6 +62,30 @@ export interface ConversationWebsocketMessage {
|
|
|
61
62
|
* @memberof ConversationWebsocketMessage
|
|
62
63
|
*/
|
|
63
64
|
event_new_message?: ConversationSummary;
|
|
65
|
+
/**
|
|
66
|
+
*
|
|
67
|
+
* @type {ConversationSummary}
|
|
68
|
+
* @memberof ConversationWebsocketMessage
|
|
69
|
+
*/
|
|
70
|
+
event_participant_join?: ConversationSummary;
|
|
71
|
+
/**
|
|
72
|
+
*
|
|
73
|
+
* @type {ConversationParticipant}
|
|
74
|
+
* @memberof ConversationWebsocketMessage
|
|
75
|
+
*/
|
|
76
|
+
event_participant_join_participant?: ConversationParticipant;
|
|
77
|
+
/**
|
|
78
|
+
*
|
|
79
|
+
* @type {ConversationSummary}
|
|
80
|
+
* @memberof ConversationWebsocketMessage
|
|
81
|
+
*/
|
|
82
|
+
event_participant_left?: ConversationSummary;
|
|
83
|
+
/**
|
|
84
|
+
*
|
|
85
|
+
* @type {ConversationParticipant}
|
|
86
|
+
* @memberof ConversationWebsocketMessage
|
|
87
|
+
*/
|
|
88
|
+
event_participant_left_participant?: ConversationParticipant;
|
|
64
89
|
/**
|
|
65
90
|
*
|
|
66
91
|
* @type {ConversationSummary}
|
|
@@ -141,6 +166,8 @@ export declare const ConversationWebsocketMessageEventTypeEnum: {
|
|
|
141
166
|
readonly QueueStatusUpdate: "queue status update";
|
|
142
167
|
readonly Rrweb: "rrweb";
|
|
143
168
|
readonly ParticipantUpdate: "participant update";
|
|
169
|
+
readonly ParticipantJoin: "participant join";
|
|
170
|
+
readonly ParticipantLeave: "participant leave";
|
|
144
171
|
readonly ReadMessage: "read message";
|
|
145
172
|
readonly Typing: "typing";
|
|
146
173
|
readonly AddCoupon: "add coupon";
|
|
@@ -23,6 +23,7 @@ var ConversationEventReadMessage_1 = require("./ConversationEventReadMessage");
|
|
|
23
23
|
var ConversationEventTyping_1 = require("./ConversationEventTyping");
|
|
24
24
|
var ConversationEventWebchatContext_1 = require("./ConversationEventWebchatContext");
|
|
25
25
|
var ConversationMessage_1 = require("./ConversationMessage");
|
|
26
|
+
var ConversationParticipant_1 = require("./ConversationParticipant");
|
|
26
27
|
var ConversationSummary_1 = require("./ConversationSummary");
|
|
27
28
|
var ConversationWebchatQueueStatus_1 = require("./ConversationWebchatQueueStatus");
|
|
28
29
|
/**
|
|
@@ -38,6 +39,8 @@ exports.ConversationWebsocketMessageEventTypeEnum = {
|
|
|
38
39
|
QueueStatusUpdate: 'queue status update',
|
|
39
40
|
Rrweb: 'rrweb',
|
|
40
41
|
ParticipantUpdate: 'participant update',
|
|
42
|
+
ParticipantJoin: 'participant join',
|
|
43
|
+
ParticipantLeave: 'participant leave',
|
|
41
44
|
ReadMessage: 'read message',
|
|
42
45
|
Typing: 'typing',
|
|
43
46
|
AddCoupon: 'add coupon',
|
|
@@ -68,6 +71,10 @@ function ConversationWebsocketMessageFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
68
71
|
'event_conversation_closed': !(0, runtime_1.exists)(json, 'event_conversation_closed') ? undefined : (0, ConversationSummary_1.ConversationSummaryFromJSON)(json['event_conversation_closed']),
|
|
69
72
|
'event_new_conversation': !(0, runtime_1.exists)(json, 'event_new_conversation') ? undefined : (0, ConversationSummary_1.ConversationSummaryFromJSON)(json['event_new_conversation']),
|
|
70
73
|
'event_new_message': !(0, runtime_1.exists)(json, 'event_new_message') ? undefined : (0, ConversationSummary_1.ConversationSummaryFromJSON)(json['event_new_message']),
|
|
74
|
+
'event_participant_join': !(0, runtime_1.exists)(json, 'event_participant_join') ? undefined : (0, ConversationSummary_1.ConversationSummaryFromJSON)(json['event_participant_join']),
|
|
75
|
+
'event_participant_join_participant': !(0, runtime_1.exists)(json, 'event_participant_join_participant') ? undefined : (0, ConversationParticipant_1.ConversationParticipantFromJSON)(json['event_participant_join_participant']),
|
|
76
|
+
'event_participant_left': !(0, runtime_1.exists)(json, 'event_participant_left') ? undefined : (0, ConversationSummary_1.ConversationSummaryFromJSON)(json['event_participant_left']),
|
|
77
|
+
'event_participant_left_participant': !(0, runtime_1.exists)(json, 'event_participant_left_participant') ? undefined : (0, ConversationParticipant_1.ConversationParticipantFromJSON)(json['event_participant_left_participant']),
|
|
71
78
|
'event_participant_update': !(0, runtime_1.exists)(json, 'event_participant_update') ? undefined : (0, ConversationSummary_1.ConversationSummaryFromJSON)(json['event_participant_update']),
|
|
72
79
|
'event_queue_position': !(0, runtime_1.exists)(json, 'event_queue_position') ? undefined : (0, ConversationEventQueuePosition_1.ConversationEventQueuePositionFromJSON)(json['event_queue_position']),
|
|
73
80
|
'event_queue_status_update': !(0, runtime_1.exists)(json, 'event_queue_status_update') ? undefined : (0, ConversationWebchatQueueStatus_1.ConversationWebchatQueueStatusFromJSON)(json['event_queue_status_update']),
|
|
@@ -96,6 +103,10 @@ function ConversationWebsocketMessageToJSON(value) {
|
|
|
96
103
|
'event_conversation_closed': (0, ConversationSummary_1.ConversationSummaryToJSON)(value.event_conversation_closed),
|
|
97
104
|
'event_new_conversation': (0, ConversationSummary_1.ConversationSummaryToJSON)(value.event_new_conversation),
|
|
98
105
|
'event_new_message': (0, ConversationSummary_1.ConversationSummaryToJSON)(value.event_new_message),
|
|
106
|
+
'event_participant_join': (0, ConversationSummary_1.ConversationSummaryToJSON)(value.event_participant_join),
|
|
107
|
+
'event_participant_join_participant': (0, ConversationParticipant_1.ConversationParticipantToJSON)(value.event_participant_join_participant),
|
|
108
|
+
'event_participant_left': (0, ConversationSummary_1.ConversationSummaryToJSON)(value.event_participant_left),
|
|
109
|
+
'event_participant_left_participant': (0, ConversationParticipant_1.ConversationParticipantToJSON)(value.event_participant_left_participant),
|
|
99
110
|
'event_participant_update': (0, ConversationSummary_1.ConversationSummaryToJSON)(value.event_participant_update),
|
|
100
111
|
'event_queue_position': (0, ConversationEventQueuePosition_1.ConversationEventQueuePositionToJSON)(value.event_queue_position),
|
|
101
112
|
'event_queue_status_update': (0, ConversationWebchatQueueStatus_1.ConversationWebchatQueueStatusToJSON)(value.event_queue_status_update),
|
|
@@ -111,6 +111,12 @@ export interface EmailFlow {
|
|
|
111
111
|
* @memberof EmailFlow
|
|
112
112
|
*/
|
|
113
113
|
library_item_oid?: number;
|
|
114
|
+
/**
|
|
115
|
+
* The number of maximum customers for the plan are currently enrolled in this flow.
|
|
116
|
+
* @type {boolean}
|
|
117
|
+
* @memberof EmailFlow
|
|
118
|
+
*/
|
|
119
|
+
maximum_enrolled?: boolean;
|
|
114
120
|
/**
|
|
115
121
|
* Merchant ID
|
|
116
122
|
* @type {string}
|
package/dist/models/EmailFlow.js
CHANGED
|
@@ -40,6 +40,7 @@ function EmailFlowFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
40
40
|
'esp_friendly_name': !(0, runtime_1.exists)(json, 'esp_friendly_name') ? undefined : json['esp_friendly_name'],
|
|
41
41
|
'filter_profile_equation_json': !(0, runtime_1.exists)(json, 'filter_profile_equation_json') ? undefined : json['filter_profile_equation_json'],
|
|
42
42
|
'library_item_oid': !(0, runtime_1.exists)(json, 'library_item_oid') ? undefined : json['library_item_oid'],
|
|
43
|
+
'maximum_enrolled': !(0, runtime_1.exists)(json, 'maximum_enrolled') ? undefined : json['maximum_enrolled'],
|
|
43
44
|
'merchant_id': !(0, runtime_1.exists)(json, 'merchant_id') ? undefined : json['merchant_id'],
|
|
44
45
|
'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
|
|
45
46
|
'open_rate_formatted': !(0, runtime_1.exists)(json, 'open_rate_formatted') ? undefined : json['open_rate_formatted'],
|
|
@@ -81,6 +82,7 @@ function EmailFlowToJSON(value) {
|
|
|
81
82
|
'esp_friendly_name': value.esp_friendly_name,
|
|
82
83
|
'filter_profile_equation_json': value.filter_profile_equation_json,
|
|
83
84
|
'library_item_oid': value.library_item_oid,
|
|
85
|
+
'maximum_enrolled': value.maximum_enrolled,
|
|
84
86
|
'merchant_id': value.merchant_id,
|
|
85
87
|
'name': value.name,
|
|
86
88
|
'open_rate_formatted': value.open_rate_formatted,
|
package/package.json
CHANGED
|
@@ -61,6 +61,12 @@ import {
|
|
|
61
61
|
ConversationMessageFromJSONTyped,
|
|
62
62
|
ConversationMessageToJSON,
|
|
63
63
|
} from './ConversationMessage';
|
|
64
|
+
import {
|
|
65
|
+
ConversationParticipant,
|
|
66
|
+
ConversationParticipantFromJSON,
|
|
67
|
+
ConversationParticipantFromJSONTyped,
|
|
68
|
+
ConversationParticipantToJSON,
|
|
69
|
+
} from './ConversationParticipant';
|
|
64
70
|
import {
|
|
65
71
|
ConversationSummary,
|
|
66
72
|
ConversationSummaryFromJSON,
|
|
@@ -116,6 +122,30 @@ export interface ConversationWebsocketMessage {
|
|
|
116
122
|
* @memberof ConversationWebsocketMessage
|
|
117
123
|
*/
|
|
118
124
|
event_new_message?: ConversationSummary;
|
|
125
|
+
/**
|
|
126
|
+
*
|
|
127
|
+
* @type {ConversationSummary}
|
|
128
|
+
* @memberof ConversationWebsocketMessage
|
|
129
|
+
*/
|
|
130
|
+
event_participant_join?: ConversationSummary;
|
|
131
|
+
/**
|
|
132
|
+
*
|
|
133
|
+
* @type {ConversationParticipant}
|
|
134
|
+
* @memberof ConversationWebsocketMessage
|
|
135
|
+
*/
|
|
136
|
+
event_participant_join_participant?: ConversationParticipant;
|
|
137
|
+
/**
|
|
138
|
+
*
|
|
139
|
+
* @type {ConversationSummary}
|
|
140
|
+
* @memberof ConversationWebsocketMessage
|
|
141
|
+
*/
|
|
142
|
+
event_participant_left?: ConversationSummary;
|
|
143
|
+
/**
|
|
144
|
+
*
|
|
145
|
+
* @type {ConversationParticipant}
|
|
146
|
+
* @memberof ConversationWebsocketMessage
|
|
147
|
+
*/
|
|
148
|
+
event_participant_left_participant?: ConversationParticipant;
|
|
119
149
|
/**
|
|
120
150
|
*
|
|
121
151
|
* @type {ConversationSummary}
|
|
@@ -198,6 +228,8 @@ export const ConversationWebsocketMessageEventTypeEnum = {
|
|
|
198
228
|
QueueStatusUpdate: 'queue status update',
|
|
199
229
|
Rrweb: 'rrweb',
|
|
200
230
|
ParticipantUpdate: 'participant update',
|
|
231
|
+
ParticipantJoin: 'participant join',
|
|
232
|
+
ParticipantLeave: 'participant leave',
|
|
201
233
|
ReadMessage: 'read message',
|
|
202
234
|
Typing: 'typing',
|
|
203
235
|
AddCoupon: 'add coupon',
|
|
@@ -234,6 +266,10 @@ export function ConversationWebsocketMessageFromJSONTyped(json: any, ignoreDiscr
|
|
|
234
266
|
'event_conversation_closed': !exists(json, 'event_conversation_closed') ? undefined : ConversationSummaryFromJSON(json['event_conversation_closed']),
|
|
235
267
|
'event_new_conversation': !exists(json, 'event_new_conversation') ? undefined : ConversationSummaryFromJSON(json['event_new_conversation']),
|
|
236
268
|
'event_new_message': !exists(json, 'event_new_message') ? undefined : ConversationSummaryFromJSON(json['event_new_message']),
|
|
269
|
+
'event_participant_join': !exists(json, 'event_participant_join') ? undefined : ConversationSummaryFromJSON(json['event_participant_join']),
|
|
270
|
+
'event_participant_join_participant': !exists(json, 'event_participant_join_participant') ? undefined : ConversationParticipantFromJSON(json['event_participant_join_participant']),
|
|
271
|
+
'event_participant_left': !exists(json, 'event_participant_left') ? undefined : ConversationSummaryFromJSON(json['event_participant_left']),
|
|
272
|
+
'event_participant_left_participant': !exists(json, 'event_participant_left_participant') ? undefined : ConversationParticipantFromJSON(json['event_participant_left_participant']),
|
|
237
273
|
'event_participant_update': !exists(json, 'event_participant_update') ? undefined : ConversationSummaryFromJSON(json['event_participant_update']),
|
|
238
274
|
'event_queue_position': !exists(json, 'event_queue_position') ? undefined : ConversationEventQueuePositionFromJSON(json['event_queue_position']),
|
|
239
275
|
'event_queue_status_update': !exists(json, 'event_queue_status_update') ? undefined : ConversationWebchatQueueStatusFromJSON(json['event_queue_status_update']),
|
|
@@ -263,6 +299,10 @@ export function ConversationWebsocketMessageToJSON(value?: ConversationWebsocket
|
|
|
263
299
|
'event_conversation_closed': ConversationSummaryToJSON(value.event_conversation_closed),
|
|
264
300
|
'event_new_conversation': ConversationSummaryToJSON(value.event_new_conversation),
|
|
265
301
|
'event_new_message': ConversationSummaryToJSON(value.event_new_message),
|
|
302
|
+
'event_participant_join': ConversationSummaryToJSON(value.event_participant_join),
|
|
303
|
+
'event_participant_join_participant': ConversationParticipantToJSON(value.event_participant_join_participant),
|
|
304
|
+
'event_participant_left': ConversationSummaryToJSON(value.event_participant_left),
|
|
305
|
+
'event_participant_left_participant': ConversationParticipantToJSON(value.event_participant_left_participant),
|
|
266
306
|
'event_participant_update': ConversationSummaryToJSON(value.event_participant_update),
|
|
267
307
|
'event_queue_position': ConversationEventQueuePositionToJSON(value.event_queue_position),
|
|
268
308
|
'event_queue_status_update': ConversationWebchatQueueStatusToJSON(value.event_queue_status_update),
|
package/src/models/EmailFlow.ts
CHANGED
|
@@ -115,6 +115,12 @@ export interface EmailFlow {
|
|
|
115
115
|
* @memberof EmailFlow
|
|
116
116
|
*/
|
|
117
117
|
library_item_oid?: number;
|
|
118
|
+
/**
|
|
119
|
+
* The number of maximum customers for the plan are currently enrolled in this flow.
|
|
120
|
+
* @type {boolean}
|
|
121
|
+
* @memberof EmailFlow
|
|
122
|
+
*/
|
|
123
|
+
maximum_enrolled?: boolean;
|
|
118
124
|
/**
|
|
119
125
|
* Merchant ID
|
|
120
126
|
* @type {string}
|
|
@@ -227,6 +233,7 @@ export function EmailFlowFromJSONTyped(json: any, ignoreDiscriminator: boolean):
|
|
|
227
233
|
'esp_friendly_name': !exists(json, 'esp_friendly_name') ? undefined : json['esp_friendly_name'],
|
|
228
234
|
'filter_profile_equation_json': !exists(json, 'filter_profile_equation_json') ? undefined : json['filter_profile_equation_json'],
|
|
229
235
|
'library_item_oid': !exists(json, 'library_item_oid') ? undefined : json['library_item_oid'],
|
|
236
|
+
'maximum_enrolled': !exists(json, 'maximum_enrolled') ? undefined : json['maximum_enrolled'],
|
|
230
237
|
'merchant_id': !exists(json, 'merchant_id') ? undefined : json['merchant_id'],
|
|
231
238
|
'name': !exists(json, 'name') ? undefined : json['name'],
|
|
232
239
|
'open_rate_formatted': !exists(json, 'open_rate_formatted') ? undefined : json['open_rate_formatted'],
|
|
@@ -269,6 +276,7 @@ export function EmailFlowToJSON(value?: EmailFlow | null): any {
|
|
|
269
276
|
'esp_friendly_name': value.esp_friendly_name,
|
|
270
277
|
'filter_profile_equation_json': value.filter_profile_equation_json,
|
|
271
278
|
'library_item_oid': value.library_item_oid,
|
|
279
|
+
'maximum_enrolled': value.maximum_enrolled,
|
|
272
280
|
'merchant_id': value.merchant_id,
|
|
273
281
|
'name': value.name,
|
|
274
282
|
'open_rate_formatted': value.open_rate_formatted,
|