@epilot/message-client 1.1.1 → 1.1.5

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/dist/openapi.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  /* eslint-disable */
2
- import {
2
+ import type {
3
3
  OpenAPIClient,
4
4
  Parameters,
5
5
  UnknownParamsObject,
@@ -8,1064 +8,1298 @@ import {
8
8
  } from 'openapi-client-axios';
9
9
 
10
10
  declare namespace Components {
11
- namespace Schemas {
12
- export interface Address {
13
- /**
14
- * Email address alias
15
- * example:
16
- * epilot
17
- */
18
- name?: string;
19
- /**
20
- * Email address
21
- * example:
22
- * messaging@epilot.cloud
23
- */
24
- address: string;
25
- /**
26
- * Sent message status regarding to this recipient.\
27
- * Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
28
- *
29
- */
30
- send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR";
31
- /**
32
- * Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\
33
- * JSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>
34
- *
35
- */
36
- send_error?: {
37
- };
11
+ namespace Schemas {
12
+ export interface Address {
13
+ /**
14
+ * Email address alias
15
+ * example:
16
+ * epilot
17
+ */
18
+ name?: string;
19
+ /**
20
+ * Email address
21
+ * example:
22
+ * messaging@epilot.cloud
23
+ */
24
+ address: string;
25
+ /**
26
+ * Sent message status regarding to this recipient.\
27
+ * Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
28
+ *
29
+ */
30
+ send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR";
31
+ /**
32
+ * Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\
33
+ * JSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>
34
+ *
35
+ */
36
+ send_error?: {
37
+ [key: string]: any;
38
+ };
39
+ }
40
+ /**
41
+ * Message attachments
42
+ */
43
+ export interface AttachmentsRelation {
44
+ /**
45
+ * It's normal entity relation with some additional properties for sending message attachment.
46
+ */
47
+ $relation?: File[];
48
+ }
49
+ export interface BaseEntity {
50
+ /**
51
+ * Entity ID
52
+ * example:
53
+ * 3fa85f64-5717-4562-b3fc-2c963f66afa6
54
+ */
55
+ _id: string;
56
+ /**
57
+ * Entity title
58
+ */
59
+ _title: string;
60
+ /**
61
+ * Ivy Organization ID the entity belongs to
62
+ * example:
63
+ * 206801
64
+ */
65
+ _org: string;
66
+ /**
67
+ * URL-friendly identifier for the entity schema
68
+ * example:
69
+ * message
70
+ */
71
+ _schema: string;
72
+ /**
73
+ * Entity tags
74
+ * example:
75
+ * [
76
+ * "pricing",
77
+ * "INBOX"
78
+ * ]
79
+ */
80
+ _tags?: string[];
81
+ /**
82
+ * Created date
83
+ * example:
84
+ * 2021-02-09T12:41:43.662Z
85
+ */
86
+ _created_at: string; // date-time
87
+ /**
88
+ * Updated date
89
+ * example:
90
+ * 2021-02-10T09:14:31.990Z
91
+ */
92
+ _updated_at: string; // date-time
93
+ }
94
+ export interface File {
95
+ /**
96
+ * File entity ID
97
+ * example:
98
+ * f820ce3b-07b0-45ae-bcc6-babb2f53f79f
99
+ */
100
+ entity_id: string;
101
+ /**
102
+ * File name
103
+ * example:
104
+ * Produktinformationen_epilot360_Double_Opt_in.pdf
105
+ */
106
+ filename?: string;
107
+ /**
108
+ * To indicate this file relation is message attachment. If false then this file will not be sent and simply kept as a file relation.
109
+ */
110
+ is_message_attachment?: boolean;
111
+ /**
112
+ * Content ID (for inline)
113
+ * example:
114
+ * fb222496-a1a5-4639-94f2-07b5e35e4068
115
+ */
116
+ cid?: string;
117
+ /**
118
+ * If true then this attachment should not be offered for download (at least not in the main attachments list).\
119
+ * The usecase is CID embedded image (aka inline image).
120
+ *
121
+ */
122
+ inline?: boolean;
123
+ /**
124
+ * If true then this attachment is sent via link. The link have to be inserted to email body by API caller.\
125
+ * In this case, service doesn't process this attachment.
126
+ *
127
+ */
128
+ send_as_link?: boolean;
129
+ }
130
+ export interface Message {
131
+ /**
132
+ * Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
133
+ * example:
134
+ * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
135
+ */
136
+ message_id?: string;
137
+ /**
138
+ * Ivy User ID of user sends the message.
139
+ * example:
140
+ * 206801
141
+ */
142
+ sender?: string;
143
+ /**
144
+ * Subject
145
+ * example:
146
+ * Request for solar panel price
147
+ */
148
+ subject: string;
149
+ /**
150
+ * HTML body
151
+ * example:
152
+ * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
153
+ */
154
+ html?: string;
155
+ /**
156
+ * Text body
157
+ * example:
158
+ * We at ABC GmbH would like to request a price quote for the solar panel.
159
+ */
160
+ text?: string;
161
+ from: Address;
162
+ reply_to?: Address;
163
+ /**
164
+ * To email addresses
165
+ */
166
+ to?: Address[];
167
+ /**
168
+ * Cc email addresses
169
+ */
170
+ cc?: Address[];
171
+ /**
172
+ * Bcc email addresses
173
+ */
174
+ bcc?: Address[];
175
+ file?: /* Message attachments */ AttachmentsRelation;
176
+ /**
177
+ * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\
178
+ * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
179
+ * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
180
+ *
181
+ * example:
182
+ * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
183
+ */
184
+ references?: string;
185
+ /**
186
+ * In-Reply-To header. Value is the `message_id` of parent message.
187
+ *
188
+ * example:
189
+ * <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
190
+ */
191
+ in_reply_to?: string;
192
+ /**
193
+ * Ivy User ID of user read the message.
194
+ */
195
+ user_read_message?: string[];
196
+ /**
197
+ * Ivy Organization ID of organization read the message.
198
+ */
199
+ org_read_message?: string[];
200
+ /**
201
+ * Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\
202
+ * Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
203
+ *
204
+ */
205
+ send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
206
+ /**
207
+ * Message type
208
+ */
209
+ type?: "SENT" | "RECEIVED";
210
+ }
211
+ export interface MessageRequestParams {
212
+ /**
213
+ * Open new thread when sending the very first message in conversation. Thread should contains context related to all messages in it (eg. topic, brand_id, opportunity_id, assigned_to,...).\
214
+ * Thread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing.\
215
+ * `thread` or `parent_id` must be provided either.
216
+ *
217
+ * example:
218
+ * {
219
+ * "topic": "CUSTOMER_MESSAGE",
220
+ * "assigned_to": [
221
+ * "206801",
222
+ * "200109"
223
+ * ],
224
+ * "opportunity_id": 829072
225
+ * }
226
+ */
227
+ thread?: {
228
+ /**
229
+ * Message topic (e.g. which service sends the message or message category)
230
+ */
231
+ topic: string;
232
+ /**
233
+ * Ivy User ID of who the message is assigned to. Default is the user who sends message.
234
+ */
235
+ assigned_to?: string[];
236
+ };
237
+ /**
238
+ * Entity ID of parent message which this message replies to or forwards from.\
239
+ * If both `parent_id` and `thread` are provided, `thread` is discarded.
240
+ *
241
+ * example:
242
+ * 44d7a3eb-0cce-4bd3-a7cd-0b3e652de0c2
243
+ */
244
+ parent_id?: string;
245
+ /**
246
+ * Subject
247
+ * example:
248
+ * Request for solar panel price
249
+ */
250
+ subject: string;
251
+ /**
252
+ * HTML body
253
+ * example:
254
+ * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
255
+ */
256
+ html?: string;
257
+ /**
258
+ * Text body. If not provided, text body is converted from HTML body using [html-to-text](https://www.npmjs.com/package/html-to-text)
259
+ * example:
260
+ * We at ABC GmbH would like to request a price quote for the solar panel.
261
+ */
262
+ text?: string;
263
+ from: Address;
264
+ reply_to?: Address;
265
+ /**
266
+ * To email addresses
267
+ */
268
+ to?: Address[];
269
+ /**
270
+ * Cc email addresses
271
+ */
272
+ cc?: Address[];
273
+ /**
274
+ * Bcc email addresses
275
+ */
276
+ bcc?: Address[];
277
+ file?: /* Message attachments */ AttachmentsRelation;
278
+ }
279
+ export interface SearchParams {
280
+ /**
281
+ * Lucene query syntax supported with ElasticSearch
282
+ * example:
283
+ * subject:"Request for solar panel price" AND _tags:INBOX
284
+ */
285
+ q: string;
286
+ from?: number;
287
+ size?: number;
288
+ }
289
+ /**
290
+ * Thread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing.
291
+ */
292
+ export interface Thread {
293
+ /**
294
+ * Message topic (e.g. which service sends the message or message category)
295
+ * example:
296
+ * CUSTOMER_MESSAGE
297
+ */
298
+ topic: string;
299
+ /**
300
+ * Ivy User ID of who the message is assigned to. Default is the user who sends message.
301
+ */
302
+ assigned_to?: string[];
303
+ /**
304
+ * Ivy Organization ID of organization read the message.
305
+ */
306
+ org_read_message?: string[];
307
+ /**
308
+ * Latest message of thread
309
+ */
310
+ latest_message?: Message;
311
+ /**
312
+ * Latest trash message of thread
313
+ */
314
+ latest_trash_message?: Message;
315
+ }
38
316
  }
39
- /**
40
- * Message attachments
41
- */
42
- export interface AttachmentsRelation {
43
- /**
44
- * It's normal entity relation with some additional properties for sending message attachment.
45
- */
46
- $relation?: File[];
47
- }
48
- export interface BaseEntity {
49
- /**
50
- * Entity ID
51
- * example:
52
- * 3fa85f64-5717-4562-b3fc-2c963f66afa6
53
- */
54
- _id: string;
55
- /**
56
- * Entity title
57
- */
58
- _title: string;
59
- /**
60
- * Ivy Organization ID the entity belongs to
61
- * example:
62
- * 206801
63
- */
64
- _org: string;
65
- /**
66
- * URL-friendly identifier for the entity schema
67
- * example:
68
- * message
69
- */
70
- _schema: string;
71
- /**
72
- * Entity tags
73
- * example:
74
- * [
75
- * "pricing",
76
- * "INBOX"
77
- * ]
78
- */
79
- _tags?: string[];
80
- /**
81
- * Created date
82
- * example:
83
- * "2021-02-09T12:41:43.662Z"
84
- */
85
- _created_at: string; // date-time
86
- /**
87
- * Updated date
88
- * example:
89
- * "2021-02-10T09:14:31.990Z"
90
- */
91
- _updated_at: string; // date-time
92
- }
93
- export interface File {
94
- /**
95
- * File entity ID
96
- * example:
97
- * f820ce3b-07b0-45ae-bcc6-babb2f53f79f
98
- */
99
- entity_id: string;
100
- /**
101
- * File name
102
- * example:
103
- * Produktinformationen_epilot360_Double_Opt_in.pdf
104
- */
105
- filename?: string;
106
- /**
107
- * To indicate this file relation is message attachment. If false then this file will not be sent and simply kept as a file relation.
108
- */
109
- is_message_attachment?: boolean;
110
- /**
111
- * Content ID (for inline)
112
- * example:
113
- * fb222496-a1a5-4639-94f2-07b5e35e4068
114
- */
115
- cid?: string;
116
- /**
117
- * If true then this attachment should not be offered for download (at least not in the main attachments list).\
118
- * The usecase is CID embedded image (aka inline image).
119
- *
120
- */
121
- inline?: boolean;
122
- /**
123
- * If true then this attachment is sent via link. The link have to be inserted to email body by API caller.\
124
- * In this case, service doesn't process this attachment.
125
- *
126
- */
127
- send_as_link?: boolean;
128
- }
129
- export interface Message {
130
- /**
131
- * Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
132
- * example:
133
- * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
134
- */
135
- message_id?: string;
136
- /**
137
- * Ivy User ID of user sends the message.
138
- * example:
139
- * 206801
140
- */
141
- sender?: string;
142
- /**
143
- * Subject
144
- * example:
145
- * Request for solar panel price
146
- */
147
- subject: string;
148
- /**
149
- * HTML body
150
- * example:
151
- * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
152
- */
153
- html?: string;
154
- /**
155
- * Text body
156
- * example:
157
- * We at ABC GmbH would like to request a price quote for the solar panel.
158
- */
159
- text?: string;
160
- from: Address;
161
- reply_to?: Address;
162
- /**
163
- * To email addresses
164
- */
165
- to?: Address[];
166
- /**
167
- * Cc email addresses
168
- */
169
- cc?: Address[];
170
- /**
171
- * Bcc email addresses
172
- */
173
- bcc?: Address[];
174
- file?: AttachmentsRelation;
175
- /**
176
- * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\
177
- * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
178
- * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
179
- *
180
- * example:
181
- * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
182
- */
183
- references?: string;
184
- /**
185
- * In-Reply-To header. Value is the `message_id` of parent message.
186
- *
187
- * example:
188
- * <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
189
- */
190
- in_reply_to?: string;
191
- /**
192
- * Ivy User ID of user read the message.
193
- */
194
- user_read_message?: string[];
195
- /**
196
- * Ivy Organization ID of organization read the message.
197
- */
198
- org_read_message?: string[];
199
- /**
200
- * Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\
201
- * Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
202
- *
203
- */
204
- send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
205
- /**
206
- * Message type
207
- */
208
- type?: "SENT" | "RECEIVED";
209
- }
210
- export interface MessageRequestParams {
211
- /**
212
- * Open new thread when sending the very first message in conversation. Thread should contains context related to all messages in it (eg. topic, brand_id, opportunity_id, assigned_to,...).\
213
- * Thread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing.\
214
- * `thread` or `parent_id` must be provided either.
215
- *
216
- * example:
217
- * {
218
- * "topic": "CUSTOMER_MESSAGE",
219
- * "assigned_to": [
220
- * "206801",
221
- * "200109"
222
- * ],
223
- * "opportunity_id": 829072
224
- * }
225
- */
226
- thread?: {
227
- /**
228
- * Message topic (e.g. which service sends the message or message category)
229
- */
230
- topic: string;
231
- /**
232
- * Ivy User ID of who the message is assigned to. Default is the user who sends message.
233
- */
234
- assigned_to?: string[];
235
- };
236
- /**
237
- * Entity ID of parent message which this message replies to or forwards from.\
238
- * If both `parent_id` and `thread` are provided, `thread` is discarded.
239
- *
240
- * example:
241
- * 44d7a3eb-0cce-4bd3-a7cd-0b3e652de0c2
242
- */
243
- parent_id?: string;
244
- /**
245
- * Subject
246
- * example:
247
- * Request for solar panel price
248
- */
249
- subject: string;
250
- /**
251
- * HTML body
252
- * example:
253
- * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
254
- */
255
- html?: string;
256
- /**
257
- * Text body. If not provided, text body is converted from HTML body using [html-to-text](https://www.npmjs.com/package/html-to-text)
258
- * example:
259
- * We at ABC GmbH would like to request a price quote for the solar panel.
260
- */
261
- text?: string;
262
- from: Address;
263
- reply_to?: Address;
264
- /**
265
- * To email addresses
266
- */
267
- to?: Address[];
268
- /**
269
- * Cc email addresses
270
- */
271
- cc?: Address[];
272
- /**
273
- * Bcc email addresses
274
- */
275
- bcc?: Address[];
276
- file?: AttachmentsRelation;
277
- }
278
- export interface SearchParams {
279
- /**
280
- * Lucene query syntax supported with ElasticSearch
281
- * example:
282
- * subject:"Request for solar panel price" AND _tags:INBOX
283
- */
284
- q: string;
285
- from?: number;
286
- size?: number;
287
- }
288
- /**
289
- * Thread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing.
290
- */
291
- export interface Thread {
292
- /**
293
- * Message topic (e.g. which service sends the message or message category)
294
- * example:
295
- * CUSTOMER_MESSAGE
296
- */
297
- topic: string;
298
- /**
299
- * Ivy User ID of who the message is assigned to. Default is the user who sends message.
300
- */
301
- assigned_to?: string[];
302
- /**
303
- * Ivy Organization ID of organization read the message.
304
- */
305
- org_read_message?: string[];
306
- /**
307
- * Latest message of thread
308
- */
309
- latest_message?: Message;
310
- /**
311
- * Latest trash message of thread
312
- */
313
- latest_trash_message?: Message;
314
- }
315
- }
316
317
  }
317
318
  declare namespace Paths {
318
- namespace CreateDraft {
319
- export type RequestBody = Components.Schemas.MessageRequestParams;
320
- namespace Responses {
321
- export interface $201 {
322
- /**
323
- * Entity ID
324
- * example:
325
- * 3fa85f64-5717-4562-b3fc-2c963f66afa6
326
- */
327
- _id: string;
328
- /**
329
- * Entity title
330
- */
331
- _title: string;
332
- /**
333
- * Ivy Organization ID the entity belongs to
334
- * example:
335
- * 206801
336
- */
337
- _org: string;
338
- /**
339
- * URL-friendly identifier for the entity schema
340
- * example:
341
- * message
342
- */
343
- _schema: string;
344
- /**
345
- * Entity tags
346
- * example:
347
- * [
348
- * "pricing",
349
- * "INBOX"
350
- * ]
351
- */
352
- _tags?: string[];
353
- /**
354
- * Created date
355
- * example:
356
- * "2021-02-09T12:41:43.662Z"
357
- */
358
- _created_at: string; // date-time
359
- /**
360
- * Updated date
361
- * example:
362
- * "2021-02-10T09:14:31.990Z"
363
- */
364
- _updated_at: string; // date-time
365
- /**
366
- * Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
367
- * example:
368
- * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
369
- */
370
- message_id?: string;
371
- /**
372
- * Ivy User ID of user sends the message.
373
- * example:
374
- * 206801
375
- */
376
- sender?: string;
377
- /**
378
- * Subject
379
- * example:
380
- * Request for solar panel price
381
- */
382
- subject: string;
383
- /**
384
- * HTML body
385
- * example:
386
- * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
387
- */
388
- html?: string;
389
- /**
390
- * Text body
391
- * example:
392
- * We at ABC GmbH would like to request a price quote for the solar panel.
393
- */
394
- text?: string;
395
- from: Components.Schemas.Address;
396
- reply_to?: Components.Schemas.Address;
397
- /**
398
- * To email addresses
399
- */
400
- to?: Components.Schemas.Address[];
401
- /**
402
- * Cc email addresses
403
- */
404
- cc?: Components.Schemas.Address[];
405
- /**
406
- * Bcc email addresses
407
- */
408
- bcc?: Components.Schemas.Address[];
409
- file?: Components.Schemas.AttachmentsRelation;
410
- /**
411
- * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\
412
- * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
413
- * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
414
- *
415
- * example:
416
- * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
417
- */
418
- references?: string;
419
- /**
420
- * In-Reply-To header. Value is the `message_id` of parent message.
421
- *
422
- * example:
423
- * <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
424
- */
425
- in_reply_to?: string;
426
- /**
427
- * Ivy User ID of user read the message.
428
- */
429
- user_read_message?: string[];
430
- /**
431
- * Ivy Organization ID of organization read the message.
432
- */
433
- org_read_message?: string[];
434
- /**
435
- * Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\
436
- * Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
437
- *
438
- */
439
- send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
440
- /**
441
- * Message type
442
- */
443
- type?: "SENT" | "RECEIVED";
444
- }
445
- }
446
- }
447
- namespace DeleteMessage {
448
- namespace Parameters {
449
- export type Id = string;
450
- }
451
- export interface PathParameters {
452
- id: Parameters.Id;
453
- }
454
- }
455
- namespace DeleteThread {
456
- namespace Parameters {
457
- export type Id = string;
458
- }
459
- export interface PathParameters {
460
- id: Parameters.Id;
461
- }
462
- }
463
- namespace MarkReadMessage {
464
- namespace Parameters {
465
- export type Id = string;
466
- }
467
- export interface PathParameters {
468
- id: Parameters.Id;
469
- }
470
- }
471
- namespace MarkReadThread {
472
- namespace Parameters {
473
- export type Id = string;
474
- }
475
- export interface PathParameters {
476
- id: Parameters.Id;
319
+ namespace AssignThread {
320
+ namespace Parameters {
321
+ export type Id = string;
322
+ }
323
+ export interface PathParameters {
324
+ id: Parameters.Id;
325
+ }
326
+ /**
327
+ * Entities which thread is assigned to
328
+ */
329
+ export type RequestBody = {
330
+ /**
331
+ * Entity slug
332
+ * example:
333
+ * contact
334
+ */
335
+ slug?: string;
336
+ /**
337
+ * Entity ID
338
+ * example:
339
+ * 3f34ce73-089c-4d45-a5ee-c161234e41c3
340
+ */
341
+ entity_id?: string;
342
+ /**
343
+ * To indicate this is main entity
344
+ * example:
345
+ * true
346
+ */
347
+ is_main_entity?: boolean;
348
+ }[];
349
+ namespace Responses {
350
+ export interface $204 {
351
+ }
352
+ export interface $403 {
353
+ }
354
+ }
477
355
  }
478
- }
479
- namespace MarkUnreadMessage {
480
- namespace Parameters {
481
- export type Id = string;
356
+ namespace CreateDraft {
357
+ export type RequestBody = Components.Schemas.MessageRequestParams;
358
+ namespace Responses {
359
+ export interface $201 {
360
+ /**
361
+ * Entity ID
362
+ * example:
363
+ * 3fa85f64-5717-4562-b3fc-2c963f66afa6
364
+ */
365
+ _id: string;
366
+ /**
367
+ * Entity title
368
+ */
369
+ _title: string;
370
+ /**
371
+ * Ivy Organization ID the entity belongs to
372
+ * example:
373
+ * 206801
374
+ */
375
+ _org: string;
376
+ /**
377
+ * URL-friendly identifier for the entity schema
378
+ * example:
379
+ * message
380
+ */
381
+ _schema: string;
382
+ /**
383
+ * Entity tags
384
+ * example:
385
+ * [
386
+ * "pricing",
387
+ * "INBOX"
388
+ * ]
389
+ */
390
+ _tags?: string[];
391
+ /**
392
+ * Created date
393
+ * example:
394
+ * 2021-02-09T12:41:43.662Z
395
+ */
396
+ _created_at: string; // date-time
397
+ /**
398
+ * Updated date
399
+ * example:
400
+ * 2021-02-10T09:14:31.990Z
401
+ */
402
+ _updated_at: string; // date-time
403
+ /**
404
+ * Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
405
+ * example:
406
+ * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
407
+ */
408
+ message_id?: string;
409
+ /**
410
+ * Ivy User ID of user sends the message.
411
+ * example:
412
+ * 206801
413
+ */
414
+ sender?: string;
415
+ /**
416
+ * Subject
417
+ * example:
418
+ * Request for solar panel price
419
+ */
420
+ subject: string;
421
+ /**
422
+ * HTML body
423
+ * example:
424
+ * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
425
+ */
426
+ html?: string;
427
+ /**
428
+ * Text body
429
+ * example:
430
+ * We at ABC GmbH would like to request a price quote for the solar panel.
431
+ */
432
+ text?: string;
433
+ from: Components.Schemas.Address;
434
+ reply_to?: Components.Schemas.Address;
435
+ /**
436
+ * To email addresses
437
+ */
438
+ to?: Components.Schemas.Address[];
439
+ /**
440
+ * Cc email addresses
441
+ */
442
+ cc?: Components.Schemas.Address[];
443
+ /**
444
+ * Bcc email addresses
445
+ */
446
+ bcc?: Components.Schemas.Address[];
447
+ file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
448
+ /**
449
+ * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\
450
+ * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
451
+ * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
452
+ *
453
+ * example:
454
+ * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
455
+ */
456
+ references?: string;
457
+ /**
458
+ * In-Reply-To header. Value is the `message_id` of parent message.
459
+ *
460
+ * example:
461
+ * <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
462
+ */
463
+ in_reply_to?: string;
464
+ /**
465
+ * Ivy User ID of user read the message.
466
+ */
467
+ user_read_message?: string[];
468
+ /**
469
+ * Ivy Organization ID of organization read the message.
470
+ */
471
+ org_read_message?: string[];
472
+ /**
473
+ * Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\
474
+ * Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
475
+ *
476
+ */
477
+ send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
478
+ /**
479
+ * Message type
480
+ */
481
+ type?: "SENT" | "RECEIVED";
482
+ }
483
+ export interface $403 {
484
+ }
485
+ }
482
486
  }
483
- export interface PathParameters {
484
- id: Parameters.Id;
487
+ namespace DeleteMessage {
488
+ namespace Parameters {
489
+ export type Id = string;
490
+ }
491
+ export interface PathParameters {
492
+ id: Parameters.Id;
493
+ }
494
+ namespace Responses {
495
+ export interface $204 {
496
+ }
497
+ export interface $403 {
498
+ }
499
+ }
485
500
  }
486
- }
487
- namespace MarkUnreadThread {
488
- namespace Parameters {
489
- export type Id = string;
501
+ namespace DeleteThread {
502
+ namespace Parameters {
503
+ export type Id = string;
504
+ }
505
+ export interface PathParameters {
506
+ id: Parameters.Id;
507
+ }
508
+ namespace Responses {
509
+ export interface $204 {
510
+ }
511
+ export interface $403 {
512
+ }
513
+ }
490
514
  }
491
- export interface PathParameters {
492
- id: Parameters.Id;
515
+ namespace GetMessage {
516
+ namespace Parameters {
517
+ export type Id = string;
518
+ }
519
+ export interface PathParameters {
520
+ id: Parameters.Id;
521
+ }
522
+ namespace Responses {
523
+ export interface $201 {
524
+ /**
525
+ * Entity ID
526
+ * example:
527
+ * 3fa85f64-5717-4562-b3fc-2c963f66afa6
528
+ */
529
+ _id: string;
530
+ /**
531
+ * Entity title
532
+ */
533
+ _title: string;
534
+ /**
535
+ * Ivy Organization ID the entity belongs to
536
+ * example:
537
+ * 206801
538
+ */
539
+ _org: string;
540
+ /**
541
+ * URL-friendly identifier for the entity schema
542
+ * example:
543
+ * message
544
+ */
545
+ _schema: string;
546
+ /**
547
+ * Entity tags
548
+ * example:
549
+ * [
550
+ * "pricing",
551
+ * "INBOX"
552
+ * ]
553
+ */
554
+ _tags?: string[];
555
+ /**
556
+ * Created date
557
+ * example:
558
+ * 2021-02-09T12:41:43.662Z
559
+ */
560
+ _created_at: string; // date-time
561
+ /**
562
+ * Updated date
563
+ * example:
564
+ * 2021-02-10T09:14:31.990Z
565
+ */
566
+ _updated_at: string; // date-time
567
+ /**
568
+ * Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
569
+ * example:
570
+ * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
571
+ */
572
+ message_id?: string;
573
+ /**
574
+ * Ivy User ID of user sends the message.
575
+ * example:
576
+ * 206801
577
+ */
578
+ sender?: string;
579
+ /**
580
+ * Subject
581
+ * example:
582
+ * Request for solar panel price
583
+ */
584
+ subject: string;
585
+ /**
586
+ * HTML body
587
+ * example:
588
+ * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
589
+ */
590
+ html?: string;
591
+ /**
592
+ * Text body
593
+ * example:
594
+ * We at ABC GmbH would like to request a price quote for the solar panel.
595
+ */
596
+ text?: string;
597
+ from: Components.Schemas.Address;
598
+ reply_to?: Components.Schemas.Address;
599
+ /**
600
+ * To email addresses
601
+ */
602
+ to?: Components.Schemas.Address[];
603
+ /**
604
+ * Cc email addresses
605
+ */
606
+ cc?: Components.Schemas.Address[];
607
+ /**
608
+ * Bcc email addresses
609
+ */
610
+ bcc?: Components.Schemas.Address[];
611
+ file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
612
+ /**
613
+ * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\
614
+ * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
615
+ * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
616
+ *
617
+ * example:
618
+ * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
619
+ */
620
+ references?: string;
621
+ /**
622
+ * In-Reply-To header. Value is the `message_id` of parent message.
623
+ *
624
+ * example:
625
+ * <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
626
+ */
627
+ in_reply_to?: string;
628
+ /**
629
+ * Ivy User ID of user read the message.
630
+ */
631
+ user_read_message?: string[];
632
+ /**
633
+ * Ivy Organization ID of organization read the message.
634
+ */
635
+ org_read_message?: string[];
636
+ /**
637
+ * Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\
638
+ * Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
639
+ *
640
+ */
641
+ send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
642
+ /**
643
+ * Message type
644
+ */
645
+ type?: "SENT" | "RECEIVED";
646
+ }
647
+ export interface $403 {
648
+ }
649
+ }
493
650
  }
494
- }
495
- namespace SearchThreads {
496
- export type RequestBody = Components.Schemas.SearchParams;
497
- namespace Responses {
498
- export interface $200 {
499
- /**
500
- * Total of matched threads
501
- * example:
502
- * 14
503
- */
504
- hits: number;
505
- /**
506
- * Matched threads
507
- */
508
- results: {
509
- /**
510
- * Entity ID
511
- * example:
512
- * 3fa85f64-5717-4562-b3fc-2c963f66afa6
513
- */
514
- _id: string;
515
- /**
516
- * Entity title
517
- */
518
- _title: string;
519
- /**
520
- * Ivy Organization ID the entity belongs to
521
- * example:
522
- * 206801
523
- */
524
- _org: string;
525
- /**
526
- * URL-friendly identifier for the entity schema
527
- * example:
528
- * message
529
- */
530
- _schema: string;
531
- /**
532
- * Entity tags
533
- * example:
534
- * [
535
- * "pricing",
536
- * "INBOX"
537
- * ]
538
- */
539
- _tags?: string[];
540
- /**
541
- * Created date
542
- * example:
543
- * "2021-02-09T12:41:43.662Z"
544
- */
545
- _created_at: string; // date-time
546
- /**
547
- * Updated date
548
- * example:
549
- * "2021-02-10T09:14:31.990Z"
550
- */
551
- _updated_at: string; // date-time
552
- /**
553
- * Message topic (e.g. which service sends the message or message category)
554
- * example:
555
- * CUSTOMER_MESSAGE
556
- */
557
- topic: string;
558
- /**
559
- * Ivy User ID of who the message is assigned to. Default is the user who sends message.
560
- */
561
- assigned_to?: string[];
562
- /**
563
- * Ivy Organization ID of organization read the message.
564
- */
565
- org_read_message?: string[];
566
- /**
567
- * Latest message of thread
568
- */
569
- latest_message?: Components.Schemas.Message;
570
- /**
571
- * Latest trash message of thread
572
- */
573
- latest_trash_message?: Components.Schemas.Message;
574
- }[];
575
- }
651
+ namespace MarkReadMessage {
652
+ namespace Parameters {
653
+ export type Id = string;
654
+ }
655
+ export interface PathParameters {
656
+ id: Parameters.Id;
657
+ }
658
+ namespace Responses {
659
+ export interface $204 {
660
+ }
661
+ export interface $403 {
662
+ }
663
+ }
576
664
  }
577
- }
578
- namespace SendDraft {
579
- namespace Responses {
580
- export interface $201 {
581
- /**
582
- * Entity ID
583
- * example:
584
- * 3fa85f64-5717-4562-b3fc-2c963f66afa6
585
- */
586
- _id: string;
587
- /**
588
- * Entity title
589
- */
590
- _title: string;
591
- /**
592
- * Ivy Organization ID the entity belongs to
593
- * example:
594
- * 206801
595
- */
596
- _org: string;
597
- /**
598
- * URL-friendly identifier for the entity schema
599
- * example:
600
- * message
601
- */
602
- _schema: string;
603
- /**
604
- * Entity tags
605
- * example:
606
- * [
607
- * "pricing",
608
- * "INBOX"
609
- * ]
610
- */
611
- _tags?: string[];
612
- /**
613
- * Created date
614
- * example:
615
- * "2021-02-09T12:41:43.662Z"
616
- */
617
- _created_at: string; // date-time
618
- /**
619
- * Updated date
620
- * example:
621
- * "2021-02-10T09:14:31.990Z"
622
- */
623
- _updated_at: string; // date-time
624
- /**
625
- * Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
626
- * example:
627
- * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
628
- */
629
- message_id?: string;
630
- /**
631
- * Ivy User ID of user sends the message.
632
- * example:
633
- * 206801
634
- */
635
- sender?: string;
636
- /**
637
- * Subject
638
- * example:
639
- * Request for solar panel price
640
- */
641
- subject: string;
642
- /**
643
- * HTML body
644
- * example:
645
- * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
646
- */
647
- html?: string;
648
- /**
649
- * Text body
650
- * example:
651
- * We at ABC GmbH would like to request a price quote for the solar panel.
652
- */
653
- text?: string;
654
- from: Components.Schemas.Address;
655
- reply_to?: Components.Schemas.Address;
656
- /**
657
- * To email addresses
658
- */
659
- to?: Components.Schemas.Address[];
660
- /**
661
- * Cc email addresses
662
- */
663
- cc?: Components.Schemas.Address[];
664
- /**
665
- * Bcc email addresses
666
- */
667
- bcc?: Components.Schemas.Address[];
668
- file?: Components.Schemas.AttachmentsRelation;
669
- /**
670
- * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\
671
- * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
672
- * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
673
- *
674
- * example:
675
- * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
676
- */
677
- references?: string;
678
- /**
679
- * In-Reply-To header. Value is the `message_id` of parent message.
680
- *
681
- * example:
682
- * <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
683
- */
684
- in_reply_to?: string;
685
- /**
686
- * Ivy User ID of user read the message.
687
- */
688
- user_read_message?: string[];
689
- /**
690
- * Ivy Organization ID of organization read the message.
691
- */
692
- org_read_message?: string[];
693
- /**
694
- * Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\
695
- * Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
696
- *
697
- */
698
- send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
699
- /**
700
- * Message type
701
- */
702
- type?: "SENT" | "RECEIVED";
703
- }
665
+ namespace MarkReadThread {
666
+ namespace Parameters {
667
+ export type Id = string;
668
+ }
669
+ export interface PathParameters {
670
+ id: Parameters.Id;
671
+ }
672
+ namespace Responses {
673
+ export interface $204 {
674
+ }
675
+ export interface $403 {
676
+ }
677
+ }
704
678
  }
705
- }
706
- namespace SendMessage {
707
- export type RequestBody = Components.Schemas.MessageRequestParams;
708
- namespace Responses {
709
- export interface $201 {
710
- /**
711
- * Entity ID
712
- * example:
713
- * 3fa85f64-5717-4562-b3fc-2c963f66afa6
714
- */
715
- _id: string;
716
- /**
717
- * Entity title
718
- */
719
- _title: string;
720
- /**
721
- * Ivy Organization ID the entity belongs to
722
- * example:
723
- * 206801
724
- */
725
- _org: string;
726
- /**
727
- * URL-friendly identifier for the entity schema
728
- * example:
729
- * message
730
- */
731
- _schema: string;
732
- /**
733
- * Entity tags
734
- * example:
735
- * [
736
- * "pricing",
737
- * "INBOX"
738
- * ]
739
- */
740
- _tags?: string[];
741
- /**
742
- * Created date
743
- * example:
744
- * "2021-02-09T12:41:43.662Z"
745
- */
746
- _created_at: string; // date-time
747
- /**
748
- * Updated date
749
- * example:
750
- * "2021-02-10T09:14:31.990Z"
751
- */
752
- _updated_at: string; // date-time
753
- /**
754
- * Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
755
- * example:
756
- * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
757
- */
758
- message_id?: string;
759
- /**
760
- * Ivy User ID of user sends the message.
761
- * example:
762
- * 206801
763
- */
764
- sender?: string;
765
- /**
766
- * Subject
767
- * example:
768
- * Request for solar panel price
769
- */
770
- subject: string;
771
- /**
772
- * HTML body
773
- * example:
774
- * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
775
- */
776
- html?: string;
777
- /**
778
- * Text body
779
- * example:
780
- * We at ABC GmbH would like to request a price quote for the solar panel.
781
- */
782
- text?: string;
783
- from: Components.Schemas.Address;
784
- reply_to?: Components.Schemas.Address;
785
- /**
786
- * To email addresses
787
- */
788
- to?: Components.Schemas.Address[];
789
- /**
790
- * Cc email addresses
791
- */
792
- cc?: Components.Schemas.Address[];
793
- /**
794
- * Bcc email addresses
795
- */
796
- bcc?: Components.Schemas.Address[];
797
- file?: Components.Schemas.AttachmentsRelation;
798
- /**
799
- * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\
800
- * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
801
- * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
802
- *
803
- * example:
804
- * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
805
- */
806
- references?: string;
807
- /**
808
- * In-Reply-To header. Value is the `message_id` of parent message.
809
- *
810
- * example:
811
- * <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
812
- */
813
- in_reply_to?: string;
814
- /**
815
- * Ivy User ID of user read the message.
816
- */
817
- user_read_message?: string[];
818
- /**
819
- * Ivy Organization ID of organization read the message.
820
- */
821
- org_read_message?: string[];
822
- /**
823
- * Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\
824
- * Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
825
- *
826
- */
827
- send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
828
- /**
829
- * Message type
830
- */
831
- type?: "SENT" | "RECEIVED";
832
- }
679
+ namespace MarkUnreadMessage {
680
+ namespace Parameters {
681
+ export type Id = string;
682
+ }
683
+ export interface PathParameters {
684
+ id: Parameters.Id;
685
+ }
686
+ namespace Responses {
687
+ export interface $204 {
688
+ }
689
+ export interface $403 {
690
+ }
691
+ }
833
692
  }
834
- }
835
- namespace TrashMessage {
836
- namespace Parameters {
837
- export type Id = string;
693
+ namespace MarkUnreadThread {
694
+ namespace Parameters {
695
+ export type Id = string;
696
+ }
697
+ export interface PathParameters {
698
+ id: Parameters.Id;
699
+ }
700
+ namespace Responses {
701
+ export interface $204 {
702
+ }
703
+ export interface $403 {
704
+ }
705
+ }
838
706
  }
839
- export interface PathParameters {
840
- id: Parameters.Id;
707
+ namespace SearchThreads {
708
+ export type RequestBody = Components.Schemas.SearchParams;
709
+ namespace Responses {
710
+ export interface $200 {
711
+ /**
712
+ * Total of matched threads
713
+ * example:
714
+ * 14
715
+ */
716
+ hits: number;
717
+ /**
718
+ * Matched threads
719
+ */
720
+ results: {
721
+ /**
722
+ * Entity ID
723
+ * example:
724
+ * 3fa85f64-5717-4562-b3fc-2c963f66afa6
725
+ */
726
+ _id: string;
727
+ /**
728
+ * Entity title
729
+ */
730
+ _title: string;
731
+ /**
732
+ * Ivy Organization ID the entity belongs to
733
+ * example:
734
+ * 206801
735
+ */
736
+ _org: string;
737
+ /**
738
+ * URL-friendly identifier for the entity schema
739
+ * example:
740
+ * message
741
+ */
742
+ _schema: string;
743
+ /**
744
+ * Entity tags
745
+ * example:
746
+ * [
747
+ * "pricing",
748
+ * "INBOX"
749
+ * ]
750
+ */
751
+ _tags?: string[];
752
+ /**
753
+ * Created date
754
+ * example:
755
+ * 2021-02-09T12:41:43.662Z
756
+ */
757
+ _created_at: string; // date-time
758
+ /**
759
+ * Updated date
760
+ * example:
761
+ * 2021-02-10T09:14:31.990Z
762
+ */
763
+ _updated_at: string; // date-time
764
+ /**
765
+ * Message topic (e.g. which service sends the message or message category)
766
+ * example:
767
+ * CUSTOMER_MESSAGE
768
+ */
769
+ topic: string;
770
+ /**
771
+ * Ivy User ID of who the message is assigned to. Default is the user who sends message.
772
+ */
773
+ assigned_to?: string[];
774
+ /**
775
+ * Ivy Organization ID of organization read the message.
776
+ */
777
+ org_read_message?: string[];
778
+ latest_message?: Components.Schemas.Message;
779
+ latest_trash_message?: Components.Schemas.Message;
780
+ }[];
781
+ }
782
+ export interface $403 {
783
+ }
784
+ }
841
785
  }
842
- }
843
- namespace TrashThread {
844
- namespace Parameters {
845
- export type Id = string;
786
+ namespace SendDraft {
787
+ namespace Responses {
788
+ export interface $201 {
789
+ /**
790
+ * Entity ID
791
+ * example:
792
+ * 3fa85f64-5717-4562-b3fc-2c963f66afa6
793
+ */
794
+ _id: string;
795
+ /**
796
+ * Entity title
797
+ */
798
+ _title: string;
799
+ /**
800
+ * Ivy Organization ID the entity belongs to
801
+ * example:
802
+ * 206801
803
+ */
804
+ _org: string;
805
+ /**
806
+ * URL-friendly identifier for the entity schema
807
+ * example:
808
+ * message
809
+ */
810
+ _schema: string;
811
+ /**
812
+ * Entity tags
813
+ * example:
814
+ * [
815
+ * "pricing",
816
+ * "INBOX"
817
+ * ]
818
+ */
819
+ _tags?: string[];
820
+ /**
821
+ * Created date
822
+ * example:
823
+ * 2021-02-09T12:41:43.662Z
824
+ */
825
+ _created_at: string; // date-time
826
+ /**
827
+ * Updated date
828
+ * example:
829
+ * 2021-02-10T09:14:31.990Z
830
+ */
831
+ _updated_at: string; // date-time
832
+ /**
833
+ * Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
834
+ * example:
835
+ * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
836
+ */
837
+ message_id?: string;
838
+ /**
839
+ * Ivy User ID of user sends the message.
840
+ * example:
841
+ * 206801
842
+ */
843
+ sender?: string;
844
+ /**
845
+ * Subject
846
+ * example:
847
+ * Request for solar panel price
848
+ */
849
+ subject: string;
850
+ /**
851
+ * HTML body
852
+ * example:
853
+ * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
854
+ */
855
+ html?: string;
856
+ /**
857
+ * Text body
858
+ * example:
859
+ * We at ABC GmbH would like to request a price quote for the solar panel.
860
+ */
861
+ text?: string;
862
+ from: Components.Schemas.Address;
863
+ reply_to?: Components.Schemas.Address;
864
+ /**
865
+ * To email addresses
866
+ */
867
+ to?: Components.Schemas.Address[];
868
+ /**
869
+ * Cc email addresses
870
+ */
871
+ cc?: Components.Schemas.Address[];
872
+ /**
873
+ * Bcc email addresses
874
+ */
875
+ bcc?: Components.Schemas.Address[];
876
+ file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
877
+ /**
878
+ * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\
879
+ * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
880
+ * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
881
+ *
882
+ * example:
883
+ * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
884
+ */
885
+ references?: string;
886
+ /**
887
+ * In-Reply-To header. Value is the `message_id` of parent message.
888
+ *
889
+ * example:
890
+ * <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
891
+ */
892
+ in_reply_to?: string;
893
+ /**
894
+ * Ivy User ID of user read the message.
895
+ */
896
+ user_read_message?: string[];
897
+ /**
898
+ * Ivy Organization ID of organization read the message.
899
+ */
900
+ org_read_message?: string[];
901
+ /**
902
+ * Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\
903
+ * Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
904
+ *
905
+ */
906
+ send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
907
+ /**
908
+ * Message type
909
+ */
910
+ type?: "SENT" | "RECEIVED";
911
+ }
912
+ export interface $403 {
913
+ }
914
+ }
846
915
  }
847
- export interface PathParameters {
848
- id: Parameters.Id;
916
+ namespace SendMessage {
917
+ export type RequestBody = Components.Schemas.MessageRequestParams;
918
+ namespace Responses {
919
+ export interface $201 {
920
+ /**
921
+ * Entity ID
922
+ * example:
923
+ * 3fa85f64-5717-4562-b3fc-2c963f66afa6
924
+ */
925
+ _id: string;
926
+ /**
927
+ * Entity title
928
+ */
929
+ _title: string;
930
+ /**
931
+ * Ivy Organization ID the entity belongs to
932
+ * example:
933
+ * 206801
934
+ */
935
+ _org: string;
936
+ /**
937
+ * URL-friendly identifier for the entity schema
938
+ * example:
939
+ * message
940
+ */
941
+ _schema: string;
942
+ /**
943
+ * Entity tags
944
+ * example:
945
+ * [
946
+ * "pricing",
947
+ * "INBOX"
948
+ * ]
949
+ */
950
+ _tags?: string[];
951
+ /**
952
+ * Created date
953
+ * example:
954
+ * 2021-02-09T12:41:43.662Z
955
+ */
956
+ _created_at: string; // date-time
957
+ /**
958
+ * Updated date
959
+ * example:
960
+ * 2021-02-10T09:14:31.990Z
961
+ */
962
+ _updated_at: string; // date-time
963
+ /**
964
+ * Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
965
+ * example:
966
+ * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
967
+ */
968
+ message_id?: string;
969
+ /**
970
+ * Ivy User ID of user sends the message.
971
+ * example:
972
+ * 206801
973
+ */
974
+ sender?: string;
975
+ /**
976
+ * Subject
977
+ * example:
978
+ * Request for solar panel price
979
+ */
980
+ subject: string;
981
+ /**
982
+ * HTML body
983
+ * example:
984
+ * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
985
+ */
986
+ html?: string;
987
+ /**
988
+ * Text body
989
+ * example:
990
+ * We at ABC GmbH would like to request a price quote for the solar panel.
991
+ */
992
+ text?: string;
993
+ from: Components.Schemas.Address;
994
+ reply_to?: Components.Schemas.Address;
995
+ /**
996
+ * To email addresses
997
+ */
998
+ to?: Components.Schemas.Address[];
999
+ /**
1000
+ * Cc email addresses
1001
+ */
1002
+ cc?: Components.Schemas.Address[];
1003
+ /**
1004
+ * Bcc email addresses
1005
+ */
1006
+ bcc?: Components.Schemas.Address[];
1007
+ file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
1008
+ /**
1009
+ * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\
1010
+ * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
1011
+ * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
1012
+ *
1013
+ * example:
1014
+ * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
1015
+ */
1016
+ references?: string;
1017
+ /**
1018
+ * In-Reply-To header. Value is the `message_id` of parent message.
1019
+ *
1020
+ * example:
1021
+ * <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
1022
+ */
1023
+ in_reply_to?: string;
1024
+ /**
1025
+ * Ivy User ID of user read the message.
1026
+ */
1027
+ user_read_message?: string[];
1028
+ /**
1029
+ * Ivy Organization ID of organization read the message.
1030
+ */
1031
+ org_read_message?: string[];
1032
+ /**
1033
+ * Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\
1034
+ * Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
1035
+ *
1036
+ */
1037
+ send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
1038
+ /**
1039
+ * Message type
1040
+ */
1041
+ type?: "SENT" | "RECEIVED";
1042
+ }
1043
+ export interface $403 {
1044
+ }
1045
+ }
849
1046
  }
850
- }
851
- namespace UntrashMessage {
852
- namespace Parameters {
853
- export type Id = string;
1047
+ namespace TrashMessage {
1048
+ namespace Parameters {
1049
+ export type Id = string;
1050
+ }
1051
+ export interface PathParameters {
1052
+ id: Parameters.Id;
1053
+ }
1054
+ namespace Responses {
1055
+ export interface $204 {
1056
+ }
1057
+ export interface $403 {
1058
+ }
1059
+ }
854
1060
  }
855
- export interface PathParameters {
856
- id: Parameters.Id;
1061
+ namespace TrashThread {
1062
+ namespace Parameters {
1063
+ export type Id = string;
1064
+ }
1065
+ export interface PathParameters {
1066
+ id: Parameters.Id;
1067
+ }
1068
+ namespace Responses {
1069
+ export interface $204 {
1070
+ }
1071
+ export interface $403 {
1072
+ }
1073
+ }
857
1074
  }
858
- }
859
- namespace UntrashThread {
860
- namespace Parameters {
861
- export type Id = string;
1075
+ namespace UntrashMessage {
1076
+ namespace Parameters {
1077
+ export type Id = string;
1078
+ }
1079
+ export interface PathParameters {
1080
+ id: Parameters.Id;
1081
+ }
1082
+ namespace Responses {
1083
+ export interface $204 {
1084
+ }
1085
+ export interface $403 {
1086
+ }
1087
+ }
862
1088
  }
863
- export interface PathParameters {
864
- id: Parameters.Id;
1089
+ namespace UntrashThread {
1090
+ namespace Parameters {
1091
+ export type Id = string;
1092
+ }
1093
+ export interface PathParameters {
1094
+ id: Parameters.Id;
1095
+ }
1096
+ namespace Responses {
1097
+ export interface $204 {
1098
+ }
1099
+ export interface $403 {
1100
+ }
1101
+ }
865
1102
  }
866
- }
867
- namespace UpdateMessage {
868
- namespace Responses {
869
- export interface $201 {
870
- /**
871
- * Entity ID
872
- * example:
873
- * 3fa85f64-5717-4562-b3fc-2c963f66afa6
874
- */
875
- _id: string;
876
- /**
877
- * Entity title
878
- */
879
- _title: string;
880
- /**
881
- * Ivy Organization ID the entity belongs to
882
- * example:
883
- * 206801
884
- */
885
- _org: string;
886
- /**
887
- * URL-friendly identifier for the entity schema
888
- * example:
889
- * message
890
- */
891
- _schema: string;
892
- /**
893
- * Entity tags
894
- * example:
895
- * [
896
- * "pricing",
897
- * "INBOX"
898
- * ]
899
- */
900
- _tags?: string[];
901
- /**
902
- * Created date
903
- * example:
904
- * "2021-02-09T12:41:43.662Z"
905
- */
906
- _created_at: string; // date-time
907
- /**
908
- * Updated date
909
- * example:
910
- * "2021-02-10T09:14:31.990Z"
911
- */
912
- _updated_at: string; // date-time
913
- /**
914
- * Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
915
- * example:
916
- * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
917
- */
918
- message_id?: string;
919
- /**
920
- * Ivy User ID of user sends the message.
921
- * example:
922
- * 206801
923
- */
924
- sender?: string;
925
- /**
926
- * Subject
927
- * example:
928
- * Request for solar panel price
929
- */
930
- subject: string;
931
- /**
932
- * HTML body
933
- * example:
934
- * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
935
- */
936
- html?: string;
937
- /**
938
- * Text body
939
- * example:
940
- * We at ABC GmbH would like to request a price quote for the solar panel.
941
- */
942
- text?: string;
943
- from: Components.Schemas.Address;
944
- reply_to?: Components.Schemas.Address;
945
- /**
946
- * To email addresses
947
- */
948
- to?: Components.Schemas.Address[];
949
- /**
950
- * Cc email addresses
951
- */
952
- cc?: Components.Schemas.Address[];
953
- /**
954
- * Bcc email addresses
955
- */
956
- bcc?: Components.Schemas.Address[];
957
- file?: Components.Schemas.AttachmentsRelation;
958
- /**
959
- * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\
960
- * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
961
- * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
962
- *
963
- * example:
964
- * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
965
- */
966
- references?: string;
967
- /**
968
- * In-Reply-To header. Value is the `message_id` of parent message.
969
- *
970
- * example:
971
- * <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
972
- */
973
- in_reply_to?: string;
974
- /**
975
- * Ivy User ID of user read the message.
976
- */
977
- user_read_message?: string[];
978
- /**
979
- * Ivy Organization ID of organization read the message.
980
- */
981
- org_read_message?: string[];
982
- /**
983
- * Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\
984
- * Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
985
- *
986
- */
987
- send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
988
- /**
989
- * Message type
990
- */
991
- type?: "SENT" | "RECEIVED";
992
- }
1103
+ namespace UpdateMessage {
1104
+ namespace Responses {
1105
+ export interface $201 {
1106
+ /**
1107
+ * Entity ID
1108
+ * example:
1109
+ * 3fa85f64-5717-4562-b3fc-2c963f66afa6
1110
+ */
1111
+ _id: string;
1112
+ /**
1113
+ * Entity title
1114
+ */
1115
+ _title: string;
1116
+ /**
1117
+ * Ivy Organization ID the entity belongs to
1118
+ * example:
1119
+ * 206801
1120
+ */
1121
+ _org: string;
1122
+ /**
1123
+ * URL-friendly identifier for the entity schema
1124
+ * example:
1125
+ * message
1126
+ */
1127
+ _schema: string;
1128
+ /**
1129
+ * Entity tags
1130
+ * example:
1131
+ * [
1132
+ * "pricing",
1133
+ * "INBOX"
1134
+ * ]
1135
+ */
1136
+ _tags?: string[];
1137
+ /**
1138
+ * Created date
1139
+ * example:
1140
+ * 2021-02-09T12:41:43.662Z
1141
+ */
1142
+ _created_at: string; // date-time
1143
+ /**
1144
+ * Updated date
1145
+ * example:
1146
+ * 2021-02-10T09:14:31.990Z
1147
+ */
1148
+ _updated_at: string; // date-time
1149
+ /**
1150
+ * Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
1151
+ * example:
1152
+ * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
1153
+ */
1154
+ message_id?: string;
1155
+ /**
1156
+ * Ivy User ID of user sends the message.
1157
+ * example:
1158
+ * 206801
1159
+ */
1160
+ sender?: string;
1161
+ /**
1162
+ * Subject
1163
+ * example:
1164
+ * Request for solar panel price
1165
+ */
1166
+ subject: string;
1167
+ /**
1168
+ * HTML body
1169
+ * example:
1170
+ * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
1171
+ */
1172
+ html?: string;
1173
+ /**
1174
+ * Text body
1175
+ * example:
1176
+ * We at ABC GmbH would like to request a price quote for the solar panel.
1177
+ */
1178
+ text?: string;
1179
+ from: Components.Schemas.Address;
1180
+ reply_to?: Components.Schemas.Address;
1181
+ /**
1182
+ * To email addresses
1183
+ */
1184
+ to?: Components.Schemas.Address[];
1185
+ /**
1186
+ * Cc email addresses
1187
+ */
1188
+ cc?: Components.Schemas.Address[];
1189
+ /**
1190
+ * Bcc email addresses
1191
+ */
1192
+ bcc?: Components.Schemas.Address[];
1193
+ file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
1194
+ /**
1195
+ * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\
1196
+ * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
1197
+ * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
1198
+ *
1199
+ * example:
1200
+ * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
1201
+ */
1202
+ references?: string;
1203
+ /**
1204
+ * In-Reply-To header. Value is the `message_id` of parent message.
1205
+ *
1206
+ * example:
1207
+ * <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
1208
+ */
1209
+ in_reply_to?: string;
1210
+ /**
1211
+ * Ivy User ID of user read the message.
1212
+ */
1213
+ user_read_message?: string[];
1214
+ /**
1215
+ * Ivy Organization ID of organization read the message.
1216
+ */
1217
+ org_read_message?: string[];
1218
+ /**
1219
+ * Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\
1220
+ * Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
1221
+ *
1222
+ */
1223
+ send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
1224
+ /**
1225
+ * Message type
1226
+ */
1227
+ type?: "SENT" | "RECEIVED";
1228
+ }
1229
+ export interface $403 {
1230
+ }
1231
+ }
993
1232
  }
994
- }
995
- namespace UpdateThread {
996
- namespace Responses {
997
- /**
998
- * Thread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing.
999
- */
1000
- export interface $201 {
1001
- /**
1002
- * Entity ID
1003
- * example:
1004
- * 3fa85f64-5717-4562-b3fc-2c963f66afa6
1005
- */
1006
- _id: string;
1007
- /**
1008
- * Entity title
1009
- */
1010
- _title: string;
1011
- /**
1012
- * Ivy Organization ID the entity belongs to
1013
- * example:
1014
- * 206801
1015
- */
1016
- _org: string;
1017
- /**
1018
- * URL-friendly identifier for the entity schema
1019
- * example:
1020
- * message
1021
- */
1022
- _schema: string;
1023
- /**
1024
- * Entity tags
1025
- * example:
1026
- * [
1027
- * "pricing",
1028
- * "INBOX"
1029
- * ]
1030
- */
1031
- _tags?: string[];
1032
- /**
1033
- * Created date
1034
- * example:
1035
- * "2021-02-09T12:41:43.662Z"
1036
- */
1037
- _created_at: string; // date-time
1038
- /**
1039
- * Updated date
1040
- * example:
1041
- * "2021-02-10T09:14:31.990Z"
1042
- */
1043
- _updated_at: string; // date-time
1044
- /**
1045
- * Message topic (e.g. which service sends the message or message category)
1046
- * example:
1047
- * CUSTOMER_MESSAGE
1048
- */
1049
- topic: string;
1050
- /**
1051
- * Ivy User ID of who the message is assigned to. Default is the user who sends message.
1052
- */
1053
- assigned_to?: string[];
1054
- /**
1055
- * Ivy Organization ID of organization read the message.
1056
- */
1057
- org_read_message?: string[];
1058
- /**
1059
- * Latest message of thread
1060
- */
1061
- latest_message?: Components.Schemas.Message;
1062
- /**
1063
- * Latest trash message of thread
1064
- */
1065
- latest_trash_message?: Components.Schemas.Message;
1066
- }
1233
+ namespace UpdateThread {
1234
+ namespace Responses {
1235
+ /**
1236
+ * Thread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing.
1237
+ */
1238
+ export interface $201 {
1239
+ /**
1240
+ * Entity ID
1241
+ * example:
1242
+ * 3fa85f64-5717-4562-b3fc-2c963f66afa6
1243
+ */
1244
+ _id: string;
1245
+ /**
1246
+ * Entity title
1247
+ */
1248
+ _title: string;
1249
+ /**
1250
+ * Ivy Organization ID the entity belongs to
1251
+ * example:
1252
+ * 206801
1253
+ */
1254
+ _org: string;
1255
+ /**
1256
+ * URL-friendly identifier for the entity schema
1257
+ * example:
1258
+ * message
1259
+ */
1260
+ _schema: string;
1261
+ /**
1262
+ * Entity tags
1263
+ * example:
1264
+ * [
1265
+ * "pricing",
1266
+ * "INBOX"
1267
+ * ]
1268
+ */
1269
+ _tags?: string[];
1270
+ /**
1271
+ * Created date
1272
+ * example:
1273
+ * 2021-02-09T12:41:43.662Z
1274
+ */
1275
+ _created_at: string; // date-time
1276
+ /**
1277
+ * Updated date
1278
+ * example:
1279
+ * 2021-02-10T09:14:31.990Z
1280
+ */
1281
+ _updated_at: string; // date-time
1282
+ /**
1283
+ * Message topic (e.g. which service sends the message or message category)
1284
+ * example:
1285
+ * CUSTOMER_MESSAGE
1286
+ */
1287
+ topic: string;
1288
+ /**
1289
+ * Ivy User ID of who the message is assigned to. Default is the user who sends message.
1290
+ */
1291
+ assigned_to?: string[];
1292
+ /**
1293
+ * Ivy Organization ID of organization read the message.
1294
+ */
1295
+ org_read_message?: string[];
1296
+ latest_message?: Components.Schemas.Message;
1297
+ latest_trash_message?: Components.Schemas.Message;
1298
+ }
1299
+ export interface $403 {
1300
+ }
1301
+ }
1067
1302
  }
1068
- }
1069
1303
  }
1070
1304
 
1071
1305
  export interface OperationMethods {
@@ -1089,6 +1323,16 @@ export interface OperationMethods {
1089
1323
  data?: Paths.SendMessage.RequestBody,
1090
1324
  config?: AxiosRequestConfig
1091
1325
  ): OperationResponse<Paths.SendMessage.Responses.$201>
1326
+ /**
1327
+ * getMessage - getMessage
1328
+ *
1329
+ * Get an email message by id
1330
+ */
1331
+ 'getMessage'(
1332
+ parameters?: Parameters<Paths.GetMessage.PathParameters> | null,
1333
+ data?: any,
1334
+ config?: AxiosRequestConfig
1335
+ ): OperationResponse<Paths.GetMessage.Responses.$201>
1092
1336
  /**
1093
1337
  * deleteMessage - deleteMessage
1094
1338
  *
@@ -1098,7 +1342,7 @@ export interface OperationMethods {
1098
1342
  parameters?: Parameters<Paths.DeleteMessage.PathParameters> | null,
1099
1343
  data?: any,
1100
1344
  config?: AxiosRequestConfig
1101
- ): OperationResponse<any>
1345
+ ): OperationResponse<Paths.DeleteMessage.Responses.$204>
1102
1346
  /**
1103
1347
  * trashMessage - trashMessage
1104
1348
  *
@@ -1108,7 +1352,7 @@ export interface OperationMethods {
1108
1352
  parameters?: Parameters<Paths.TrashMessage.PathParameters> | null,
1109
1353
  data?: any,
1110
1354
  config?: AxiosRequestConfig
1111
- ): OperationResponse<any>
1355
+ ): OperationResponse<Paths.TrashMessage.Responses.$204>
1112
1356
  /**
1113
1357
  * untrashMessage - untrashMessage
1114
1358
  *
@@ -1118,7 +1362,7 @@ export interface OperationMethods {
1118
1362
  parameters?: Parameters<Paths.UntrashMessage.PathParameters> | null,
1119
1363
  data?: any,
1120
1364
  config?: AxiosRequestConfig
1121
- ): OperationResponse<any>
1365
+ ): OperationResponse<Paths.UntrashMessage.Responses.$204>
1122
1366
  /**
1123
1367
  * markReadMessage - markReadMessage
1124
1368
  *
@@ -1128,7 +1372,7 @@ export interface OperationMethods {
1128
1372
  parameters?: Parameters<Paths.MarkReadMessage.PathParameters> | null,
1129
1373
  data?: any,
1130
1374
  config?: AxiosRequestConfig
1131
- ): OperationResponse<any>
1375
+ ): OperationResponse<Paths.MarkReadMessage.Responses.$204>
1132
1376
  /**
1133
1377
  * markUnreadMessage - markUnreadMessage
1134
1378
  *
@@ -1138,7 +1382,7 @@ export interface OperationMethods {
1138
1382
  parameters?: Parameters<Paths.MarkUnreadMessage.PathParameters> | null,
1139
1383
  data?: any,
1140
1384
  config?: AxiosRequestConfig
1141
- ): OperationResponse<any>
1385
+ ): OperationResponse<Paths.MarkUnreadMessage.Responses.$204>
1142
1386
  /**
1143
1387
  * searchThreads - searchThreads
1144
1388
  *
@@ -1173,7 +1417,7 @@ export interface OperationMethods {
1173
1417
  parameters?: Parameters<Paths.DeleteThread.PathParameters> | null,
1174
1418
  data?: any,
1175
1419
  config?: AxiosRequestConfig
1176
- ): OperationResponse<any>
1420
+ ): OperationResponse<Paths.DeleteThread.Responses.$204>
1177
1421
  /**
1178
1422
  * trashThread - trashThread
1179
1423
  *
@@ -1183,7 +1427,7 @@ export interface OperationMethods {
1183
1427
  parameters?: Parameters<Paths.TrashThread.PathParameters> | null,
1184
1428
  data?: any,
1185
1429
  config?: AxiosRequestConfig
1186
- ): OperationResponse<any>
1430
+ ): OperationResponse<Paths.TrashThread.Responses.$204>
1187
1431
  /**
1188
1432
  * untrashThread - untrashThread
1189
1433
  *
@@ -1193,7 +1437,7 @@ export interface OperationMethods {
1193
1437
  parameters?: Parameters<Paths.UntrashThread.PathParameters> | null,
1194
1438
  data?: any,
1195
1439
  config?: AxiosRequestConfig
1196
- ): OperationResponse<any>
1440
+ ): OperationResponse<Paths.UntrashThread.Responses.$204>
1197
1441
  /**
1198
1442
  * markReadThread - markReadThread
1199
1443
  *
@@ -1203,7 +1447,7 @@ export interface OperationMethods {
1203
1447
  parameters?: Parameters<Paths.MarkReadThread.PathParameters> | null,
1204
1448
  data?: any,
1205
1449
  config?: AxiosRequestConfig
1206
- ): OperationResponse<any>
1450
+ ): OperationResponse<Paths.MarkReadThread.Responses.$204>
1207
1451
  /**
1208
1452
  * markUnreadThread - markUnreadThread
1209
1453
  *
@@ -1213,7 +1457,17 @@ export interface OperationMethods {
1213
1457
  parameters?: Parameters<Paths.MarkUnreadThread.PathParameters> | null,
1214
1458
  data?: any,
1215
1459
  config?: AxiosRequestConfig
1216
- ): OperationResponse<any>
1460
+ ): OperationResponse<Paths.MarkUnreadThread.Responses.$204>
1461
+ /**
1462
+ * assignThread - assignThread
1463
+ *
1464
+ * Assign thread to entities
1465
+ */
1466
+ 'assignThread'(
1467
+ parameters?: Parameters<Paths.AssignThread.PathParameters> | null,
1468
+ data?: Paths.AssignThread.RequestBody,
1469
+ config?: AxiosRequestConfig
1470
+ ): OperationResponse<Paths.AssignThread.Responses.$204>
1217
1471
  /**
1218
1472
  * createDraft - createDraft
1219
1473
  *
@@ -1260,6 +1514,16 @@ export interface PathsDictionary {
1260
1514
  ): OperationResponse<Paths.UpdateMessage.Responses.$201>
1261
1515
  }
1262
1516
  ['/v1/message/messages/{id}']: {
1517
+ /**
1518
+ * getMessage - getMessage
1519
+ *
1520
+ * Get an email message by id
1521
+ */
1522
+ 'get'(
1523
+ parameters?: Parameters<Paths.GetMessage.PathParameters> | null,
1524
+ data?: any,
1525
+ config?: AxiosRequestConfig
1526
+ ): OperationResponse<Paths.GetMessage.Responses.$201>
1263
1527
  /**
1264
1528
  * deleteMessage - deleteMessage
1265
1529
  *
@@ -1269,7 +1533,7 @@ export interface PathsDictionary {
1269
1533
  parameters?: Parameters<Paths.DeleteMessage.PathParameters> | null,
1270
1534
  data?: any,
1271
1535
  config?: AxiosRequestConfig
1272
- ): OperationResponse<any>
1536
+ ): OperationResponse<Paths.DeleteMessage.Responses.$204>
1273
1537
  }
1274
1538
  ['/v1/message/messages/{id}/trash']: {
1275
1539
  /**
@@ -1281,7 +1545,7 @@ export interface PathsDictionary {
1281
1545
  parameters?: Parameters<Paths.TrashMessage.PathParameters> | null,
1282
1546
  data?: any,
1283
1547
  config?: AxiosRequestConfig
1284
- ): OperationResponse<any>
1548
+ ): OperationResponse<Paths.TrashMessage.Responses.$204>
1285
1549
  }
1286
1550
  ['/v1/message/messages/{id}/untrash']: {
1287
1551
  /**
@@ -1293,7 +1557,7 @@ export interface PathsDictionary {
1293
1557
  parameters?: Parameters<Paths.UntrashMessage.PathParameters> | null,
1294
1558
  data?: any,
1295
1559
  config?: AxiosRequestConfig
1296
- ): OperationResponse<any>
1560
+ ): OperationResponse<Paths.UntrashMessage.Responses.$204>
1297
1561
  }
1298
1562
  ['/v1/message/messages/{id}/read']: {
1299
1563
  /**
@@ -1305,7 +1569,7 @@ export interface PathsDictionary {
1305
1569
  parameters?: Parameters<Paths.MarkReadMessage.PathParameters> | null,
1306
1570
  data?: any,
1307
1571
  config?: AxiosRequestConfig
1308
- ): OperationResponse<any>
1572
+ ): OperationResponse<Paths.MarkReadMessage.Responses.$204>
1309
1573
  }
1310
1574
  ['/v1/message/messages/{id}/unread']: {
1311
1575
  /**
@@ -1317,7 +1581,7 @@ export interface PathsDictionary {
1317
1581
  parameters?: Parameters<Paths.MarkUnreadMessage.PathParameters> | null,
1318
1582
  data?: any,
1319
1583
  config?: AxiosRequestConfig
1320
- ): OperationResponse<any>
1584
+ ): OperationResponse<Paths.MarkUnreadMessage.Responses.$204>
1321
1585
  }
1322
1586
  ['/v1/message/threads:search']: {
1323
1587
  /**
@@ -1358,7 +1622,7 @@ export interface PathsDictionary {
1358
1622
  parameters?: Parameters<Paths.DeleteThread.PathParameters> | null,
1359
1623
  data?: any,
1360
1624
  config?: AxiosRequestConfig
1361
- ): OperationResponse<any>
1625
+ ): OperationResponse<Paths.DeleteThread.Responses.$204>
1362
1626
  }
1363
1627
  ['/v1/message/threads/{id}/trash']: {
1364
1628
  /**
@@ -1370,7 +1634,7 @@ export interface PathsDictionary {
1370
1634
  parameters?: Parameters<Paths.TrashThread.PathParameters> | null,
1371
1635
  data?: any,
1372
1636
  config?: AxiosRequestConfig
1373
- ): OperationResponse<any>
1637
+ ): OperationResponse<Paths.TrashThread.Responses.$204>
1374
1638
  }
1375
1639
  ['/v1/message/threads/{id}/untrash']: {
1376
1640
  /**
@@ -1382,7 +1646,7 @@ export interface PathsDictionary {
1382
1646
  parameters?: Parameters<Paths.UntrashThread.PathParameters> | null,
1383
1647
  data?: any,
1384
1648
  config?: AxiosRequestConfig
1385
- ): OperationResponse<any>
1649
+ ): OperationResponse<Paths.UntrashThread.Responses.$204>
1386
1650
  }
1387
1651
  ['/v1/message/threads/{id}/read']: {
1388
1652
  /**
@@ -1394,7 +1658,7 @@ export interface PathsDictionary {
1394
1658
  parameters?: Parameters<Paths.MarkReadThread.PathParameters> | null,
1395
1659
  data?: any,
1396
1660
  config?: AxiosRequestConfig
1397
- ): OperationResponse<any>
1661
+ ): OperationResponse<Paths.MarkReadThread.Responses.$204>
1398
1662
  }
1399
1663
  ['/v1/message/threads/{id}/unread']: {
1400
1664
  /**
@@ -1406,7 +1670,19 @@ export interface PathsDictionary {
1406
1670
  parameters?: Parameters<Paths.MarkUnreadThread.PathParameters> | null,
1407
1671
  data?: any,
1408
1672
  config?: AxiosRequestConfig
1409
- ): OperationResponse<any>
1673
+ ): OperationResponse<Paths.MarkUnreadThread.Responses.$204>
1674
+ }
1675
+ ['/v1/message/threads/{id}/assign']: {
1676
+ /**
1677
+ * assignThread - assignThread
1678
+ *
1679
+ * Assign thread to entities
1680
+ */
1681
+ 'post'(
1682
+ parameters?: Parameters<Paths.AssignThread.PathParameters> | null,
1683
+ data?: Paths.AssignThread.RequestBody,
1684
+ config?: AxiosRequestConfig
1685
+ ): OperationResponse<Paths.AssignThread.Responses.$204>
1410
1686
  }
1411
1687
  ['/v1/message/drafts']: {
1412
1688
  /**