@lorikeetai/node-sdk 0.6.3 → 0.8.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.
@@ -86,16 +86,27 @@ export interface ChatGenerateResponse {
86
86
  */
87
87
  createdAt: string;
88
88
 
89
+ /**
90
+ * The events that have occurred in the conversation. Can be used for deriving more
91
+ * information about the conversation.
92
+ */
93
+ events: Array<ChatGenerateResponse.Event>;
94
+
89
95
  /**
90
96
  * The latest message type - useful for polling
91
97
  */
92
- latestMessageType: 'CUSTOMER' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE' | 'BOT_RESPONSE';
98
+ latestMessageType: 'CUSTOMER' | 'BOT_RESPONSE' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE';
93
99
 
94
100
  /**
95
101
  * The full list of messages. This endpoint supports markdown.
96
102
  */
97
103
  messages: Array<ChatGenerateResponse.Message>;
98
104
 
105
+ /**
106
+ * The status of the conversation
107
+ */
108
+ status: 'Unprocessed' | 'Processing' | 'Unhandled' | 'Responded' | 'Error' | 'Escalated' | 'Processed';
109
+
99
110
  /**
100
111
  * The timestamp of when the ticket was last updated in our system.
101
112
  */
@@ -103,12 +114,45 @@ export interface ChatGenerateResponse {
103
114
  }
104
115
 
105
116
  export namespace ChatGenerateResponse {
117
+ export interface Event {
118
+ /**
119
+ * The ID of the event
120
+ */
121
+ id: string;
122
+
123
+ /**
124
+ * The timestamp of the event
125
+ */
126
+ createdAt: string;
127
+
128
+ /**
129
+ * Any specific data associated with the event
130
+ */
131
+ data: unknown;
132
+
133
+ /**
134
+ * The type of the event
135
+ */
136
+ type:
137
+ | 'ASSIGNED'
138
+ | 'CLOSED'
139
+ | 'ESCALATED'
140
+ | 'ESCALATION_REQUEST'
141
+ | 'PROCESSING_CANCELLED'
142
+ | 'HOSTILE_MESSAGE';
143
+ }
144
+
106
145
  export interface Message {
107
146
  /**
108
147
  * The ID of the conversation message
109
148
  */
110
149
  id: string;
111
150
 
151
+ /**
152
+ * Attachments that were attached to the message
153
+ */
154
+ attachments: Array<Message.Attachment>;
155
+
112
156
  /**
113
157
  * The content of the message. Markdown on plain text.
114
158
  */
@@ -127,7 +171,26 @@ export namespace ChatGenerateResponse {
127
171
  /**
128
172
  * The type of the message
129
173
  */
130
- type: 'CUSTOMER' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE' | 'BOT_RESPONSE';
174
+ type: 'CUSTOMER' | 'BOT_RESPONSE' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE';
175
+ }
176
+
177
+ export namespace Message {
178
+ export interface Attachment {
179
+ /**
180
+ * The name of the attachment
181
+ */
182
+ name: string;
183
+
184
+ /**
185
+ * The type of the attachment
186
+ */
187
+ type: string;
188
+
189
+ /**
190
+ * The URL of the attachment
191
+ */
192
+ url: string;
193
+ }
131
194
  }
132
195
  }
133
196
 
@@ -142,16 +205,27 @@ export interface ChatGetResponse {
142
205
  */
143
206
  createdAt: string;
144
207
 
208
+ /**
209
+ * The events that have occurred in the conversation. Can be used for deriving more
210
+ * information about the conversation.
211
+ */
212
+ events: Array<ChatGetResponse.Event>;
213
+
145
214
  /**
146
215
  * The latest message type - useful for polling
147
216
  */
148
- latestMessageType: 'CUSTOMER' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE' | 'BOT_RESPONSE';
217
+ latestMessageType: 'CUSTOMER' | 'BOT_RESPONSE' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE';
149
218
 
150
219
  /**
151
220
  * The full list of messages. This endpoint supports markdown.
152
221
  */
153
222
  messages: Array<ChatGetResponse.Message>;
154
223
 
224
+ /**
225
+ * The status of the conversation
226
+ */
227
+ status: 'Unprocessed' | 'Processing' | 'Unhandled' | 'Responded' | 'Error' | 'Escalated' | 'Processed';
228
+
155
229
  /**
156
230
  * The timestamp of when the ticket was last updated in our system.
157
231
  */
@@ -159,12 +233,45 @@ export interface ChatGetResponse {
159
233
  }
160
234
 
161
235
  export namespace ChatGetResponse {
236
+ export interface Event {
237
+ /**
238
+ * The ID of the event
239
+ */
240
+ id: string;
241
+
242
+ /**
243
+ * The timestamp of the event
244
+ */
245
+ createdAt: string;
246
+
247
+ /**
248
+ * Any specific data associated with the event
249
+ */
250
+ data: unknown;
251
+
252
+ /**
253
+ * The type of the event
254
+ */
255
+ type:
256
+ | 'ASSIGNED'
257
+ | 'CLOSED'
258
+ | 'ESCALATED'
259
+ | 'ESCALATION_REQUEST'
260
+ | 'PROCESSING_CANCELLED'
261
+ | 'HOSTILE_MESSAGE';
262
+ }
263
+
162
264
  export interface Message {
163
265
  /**
164
266
  * The ID of the conversation message
165
267
  */
166
268
  id: string;
167
269
 
270
+ /**
271
+ * Attachments that were attached to the message
272
+ */
273
+ attachments: Array<Message.Attachment>;
274
+
168
275
  /**
169
276
  * The content of the message. Markdown on plain text.
170
277
  */
@@ -183,7 +290,26 @@ export namespace ChatGetResponse {
183
290
  /**
184
291
  * The type of the message
185
292
  */
186
- type: 'CUSTOMER' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE' | 'BOT_RESPONSE';
293
+ type: 'CUSTOMER' | 'BOT_RESPONSE' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE';
294
+ }
295
+
296
+ export namespace Message {
297
+ export interface Attachment {
298
+ /**
299
+ * The name of the attachment
300
+ */
301
+ name: string;
302
+
303
+ /**
304
+ * The type of the attachment
305
+ */
306
+ type: string;
307
+
308
+ /**
309
+ * The URL of the attachment
310
+ */
311
+ url: string;
312
+ }
187
313
  }
188
314
  }
189
315
 
@@ -197,9 +323,55 @@ export interface ChatStartResponse {
197
323
  * The timestamp of the when the conversation was created in our system.
198
324
  */
199
325
  createdAt: string;
326
+
327
+ /**
328
+ * The events that have occurred in the conversation. Can be used for deriving more
329
+ * information about the conversation.
330
+ */
331
+ events: Array<ChatStartResponse.Event>;
332
+
333
+ /**
334
+ * The status of the conversation
335
+ */
336
+ status: 'Unprocessed' | 'Processing' | 'Unhandled' | 'Responded' | 'Error' | 'Escalated' | 'Processed';
337
+ }
338
+
339
+ export namespace ChatStartResponse {
340
+ export interface Event {
341
+ /**
342
+ * The ID of the event
343
+ */
344
+ id: string;
345
+
346
+ /**
347
+ * The timestamp of the event
348
+ */
349
+ createdAt: string;
350
+
351
+ /**
352
+ * Any specific data associated with the event
353
+ */
354
+ data: unknown;
355
+
356
+ /**
357
+ * The type of the event
358
+ */
359
+ type:
360
+ | 'ASSIGNED'
361
+ | 'CLOSED'
362
+ | 'ESCALATED'
363
+ | 'ESCALATION_REQUEST'
364
+ | 'PROCESSING_CANCELLED'
365
+ | 'HOSTILE_MESSAGE';
366
+ }
200
367
  }
201
368
 
202
369
  export interface ChatGenerateParams {
370
+ /**
371
+ * Attachments to be sent with the message
372
+ */
373
+ attachments: Array<ChatGenerateParams.Attachment>;
374
+
203
375
  /**
204
376
  * The ID of the conversation
205
377
  */
@@ -218,6 +390,23 @@ export interface ChatGenerateParams {
218
390
  }
219
391
 
220
392
  export namespace ChatGenerateParams {
393
+ export interface Attachment {
394
+ /**
395
+ * The name of the attachment
396
+ */
397
+ name: string;
398
+
399
+ /**
400
+ * The type of the attachment
401
+ */
402
+ type: string;
403
+
404
+ /**
405
+ * The URL of the attachment
406
+ */
407
+ url: string;
408
+ }
409
+
221
410
  /**
222
411
  * Any additional customer information, that has changed in the course of the
223
412
  * conversation.
@@ -28,16 +28,27 @@ export interface EmailGenerateResponse {
28
28
  */
29
29
  createdAt: string;
30
30
 
31
+ /**
32
+ * The events that have occurred in the conversation. Can be used for deriving more
33
+ * information about the conversation.
34
+ */
35
+ events: Array<EmailGenerateResponse.Event>;
36
+
31
37
  /**
32
38
  * The latest message type - useful for polling
33
39
  */
34
- latestMessageType: 'CUSTOMER' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE' | 'BOT_RESPONSE';
40
+ latestMessageType: 'CUSTOMER' | 'BOT_RESPONSE' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE';
35
41
 
36
42
  /**
37
43
  * The full list of messages. This endpoint supports markdown.
38
44
  */
39
45
  messages: Array<EmailGenerateResponse.Message>;
40
46
 
47
+ /**
48
+ * The status of the conversation
49
+ */
50
+ status: 'Unprocessed' | 'Processing' | 'Unhandled' | 'Responded' | 'Error' | 'Escalated' | 'Processed';
51
+
41
52
  /**
42
53
  * The timestamp of when the ticket was last updated in our system.
43
54
  */
@@ -45,12 +56,45 @@ export interface EmailGenerateResponse {
45
56
  }
46
57
 
47
58
  export namespace EmailGenerateResponse {
59
+ export interface Event {
60
+ /**
61
+ * The ID of the event
62
+ */
63
+ id: string;
64
+
65
+ /**
66
+ * The timestamp of the event
67
+ */
68
+ createdAt: string;
69
+
70
+ /**
71
+ * Any specific data associated with the event
72
+ */
73
+ data: unknown;
74
+
75
+ /**
76
+ * The type of the event
77
+ */
78
+ type:
79
+ | 'ASSIGNED'
80
+ | 'CLOSED'
81
+ | 'ESCALATED'
82
+ | 'ESCALATION_REQUEST'
83
+ | 'PROCESSING_CANCELLED'
84
+ | 'HOSTILE_MESSAGE';
85
+ }
86
+
48
87
  export interface Message {
49
88
  /**
50
89
  * The ID of the conversation message
51
90
  */
52
91
  id: string;
53
92
 
93
+ /**
94
+ * Attachments that were attached to the message
95
+ */
96
+ attachments: Array<Message.Attachment>;
97
+
54
98
  /**
55
99
  * The content of the message. Markdown on plain text.
56
100
  */
@@ -69,7 +113,26 @@ export namespace EmailGenerateResponse {
69
113
  /**
70
114
  * The type of the message
71
115
  */
72
- type: 'CUSTOMER' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE' | 'BOT_RESPONSE';
116
+ type: 'CUSTOMER' | 'BOT_RESPONSE' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE';
117
+ }
118
+
119
+ export namespace Message {
120
+ export interface Attachment {
121
+ /**
122
+ * The name of the attachment
123
+ */
124
+ name: string;
125
+
126
+ /**
127
+ * The type of the attachment
128
+ */
129
+ type: string;
130
+
131
+ /**
132
+ * The URL of the attachment
133
+ */
134
+ url: string;
135
+ }
73
136
  }
74
137
  }
75
138
 
@@ -84,16 +147,27 @@ export interface EmailGetResponse {
84
147
  */
85
148
  createdAt: string;
86
149
 
150
+ /**
151
+ * The events that have occurred in the conversation. Can be used for deriving more
152
+ * information about the conversation.
153
+ */
154
+ events: Array<EmailGetResponse.Event>;
155
+
87
156
  /**
88
157
  * The latest message type - useful for polling
89
158
  */
90
- latestMessageType: 'CUSTOMER' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE' | 'BOT_RESPONSE';
159
+ latestMessageType: 'CUSTOMER' | 'BOT_RESPONSE' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE';
91
160
 
92
161
  /**
93
162
  * The full list of messages. This endpoint supports markdown.
94
163
  */
95
164
  messages: Array<EmailGetResponse.Message>;
96
165
 
166
+ /**
167
+ * The status of the conversation
168
+ */
169
+ status: 'Unprocessed' | 'Processing' | 'Unhandled' | 'Responded' | 'Error' | 'Escalated' | 'Processed';
170
+
97
171
  /**
98
172
  * The timestamp of when the ticket was last updated in our system.
99
173
  */
@@ -101,12 +175,45 @@ export interface EmailGetResponse {
101
175
  }
102
176
 
103
177
  export namespace EmailGetResponse {
178
+ export interface Event {
179
+ /**
180
+ * The ID of the event
181
+ */
182
+ id: string;
183
+
184
+ /**
185
+ * The timestamp of the event
186
+ */
187
+ createdAt: string;
188
+
189
+ /**
190
+ * Any specific data associated with the event
191
+ */
192
+ data: unknown;
193
+
194
+ /**
195
+ * The type of the event
196
+ */
197
+ type:
198
+ | 'ASSIGNED'
199
+ | 'CLOSED'
200
+ | 'ESCALATED'
201
+ | 'ESCALATION_REQUEST'
202
+ | 'PROCESSING_CANCELLED'
203
+ | 'HOSTILE_MESSAGE';
204
+ }
205
+
104
206
  export interface Message {
105
207
  /**
106
208
  * The ID of the conversation message
107
209
  */
108
210
  id: string;
109
211
 
212
+ /**
213
+ * Attachments that were attached to the message
214
+ */
215
+ attachments: Array<Message.Attachment>;
216
+
110
217
  /**
111
218
  * The content of the message. Markdown on plain text.
112
219
  */
@@ -125,7 +232,26 @@ export namespace EmailGetResponse {
125
232
  /**
126
233
  * The type of the message
127
234
  */
128
- type: 'CUSTOMER' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE' | 'BOT_RESPONSE';
235
+ type: 'CUSTOMER' | 'BOT_RESPONSE' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE';
236
+ }
237
+
238
+ export namespace Message {
239
+ export interface Attachment {
240
+ /**
241
+ * The name of the attachment
242
+ */
243
+ name: string;
244
+
245
+ /**
246
+ * The type of the attachment
247
+ */
248
+ type: string;
249
+
250
+ /**
251
+ * The URL of the attachment
252
+ */
253
+ url: string;
254
+ }
129
255
  }
130
256
  }
131
257
 
@@ -139,9 +265,55 @@ export interface EmailStartResponse {
139
265
  * The timestamp of the when the conversation was created in our system.
140
266
  */
141
267
  createdAt: string;
268
+
269
+ /**
270
+ * The events that have occurred in the conversation. Can be used for deriving more
271
+ * information about the conversation.
272
+ */
273
+ events: Array<EmailStartResponse.Event>;
274
+
275
+ /**
276
+ * The status of the conversation
277
+ */
278
+ status: 'Unprocessed' | 'Processing' | 'Unhandled' | 'Responded' | 'Error' | 'Escalated' | 'Processed';
279
+ }
280
+
281
+ export namespace EmailStartResponse {
282
+ export interface Event {
283
+ /**
284
+ * The ID of the event
285
+ */
286
+ id: string;
287
+
288
+ /**
289
+ * The timestamp of the event
290
+ */
291
+ createdAt: string;
292
+
293
+ /**
294
+ * Any specific data associated with the event
295
+ */
296
+ data: unknown;
297
+
298
+ /**
299
+ * The type of the event
300
+ */
301
+ type:
302
+ | 'ASSIGNED'
303
+ | 'CLOSED'
304
+ | 'ESCALATED'
305
+ | 'ESCALATION_REQUEST'
306
+ | 'PROCESSING_CANCELLED'
307
+ | 'HOSTILE_MESSAGE';
308
+ }
142
309
  }
143
310
 
144
311
  export interface EmailGenerateParams {
312
+ /**
313
+ * Attachments to be sent with the message
314
+ */
315
+ attachments: Array<EmailGenerateParams.Attachment>;
316
+
145
317
  /**
146
318
  * The ID of the conversation
147
319
  */
@@ -160,6 +332,23 @@ export interface EmailGenerateParams {
160
332
  }
161
333
 
162
334
  export namespace EmailGenerateParams {
335
+ export interface Attachment {
336
+ /**
337
+ * The name of the attachment
338
+ */
339
+ name: string;
340
+
341
+ /**
342
+ * The type of the attachment
343
+ */
344
+ type: string;
345
+
346
+ /**
347
+ * The URL of the attachment
348
+ */
349
+ url: string;
350
+ }
351
+
163
352
  /**
164
353
  * Any additional customer information, that has changed in the course of the
165
354
  * conversation.
@@ -21,11 +21,7 @@ export class Customer extends APIResource {
21
21
  }
22
22
 
23
23
  token(body: CustomerTokenParams, options?: Core.RequestOptions): Core.APIPromise<string> {
24
- return this._client.post('/v1/customer/token', {
25
- body,
26
- ...options,
27
- headers: { Accept: 'application/json', ...options?.headers },
28
- });
24
+ return this._client.post('/v1/customer/token', { body, ...options });
29
25
  }
30
26
  }
31
27
 
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.6.3'; // x-release-please-version
1
+ export const VERSION = '0.8.0'; // x-release-please-version
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.6.3";
1
+ export declare const VERSION = "0.8.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '0.6.3'; // x-release-please-version
4
+ exports.VERSION = '0.8.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '0.6.3'; // x-release-please-version
1
+ export const VERSION = '0.8.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map