@epilot/message-client 1.1.0 → 1.1.4

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.
Files changed (9) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +75 -26
  3. package/dist/client.d.ts +2 -1
  4. package/dist/client.js +16 -1
  5. package/dist/definition.js +1 -1
  6. package/dist/index.js +5 -1
  7. package/dist/openapi.d.ts +1276 -1059
  8. package/dist/openapi.json +82 -4449
  9. package/package.json +28 -12
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,1261 @@ 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?: File;
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?: File;
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.File;
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
- }
319
+ namespace CreateDraft {
320
+ export type RequestBody = Components.Schemas.MessageRequestParams;
321
+ namespace Responses {
322
+ export interface $201 {
323
+ /**
324
+ * Entity ID
325
+ * example:
326
+ * 3fa85f64-5717-4562-b3fc-2c963f66afa6
327
+ */
328
+ _id: string;
329
+ /**
330
+ * Entity title
331
+ */
332
+ _title: string;
333
+ /**
334
+ * Ivy Organization ID the entity belongs to
335
+ * example:
336
+ * 206801
337
+ */
338
+ _org: string;
339
+ /**
340
+ * URL-friendly identifier for the entity schema
341
+ * example:
342
+ * message
343
+ */
344
+ _schema: string;
345
+ /**
346
+ * Entity tags
347
+ * example:
348
+ * [
349
+ * "pricing",
350
+ * "INBOX"
351
+ * ]
352
+ */
353
+ _tags?: string[];
354
+ /**
355
+ * Created date
356
+ * example:
357
+ * 2021-02-09T12:41:43.662Z
358
+ */
359
+ _created_at: string; // date-time
360
+ /**
361
+ * Updated date
362
+ * example:
363
+ * 2021-02-10T09:14:31.990Z
364
+ */
365
+ _updated_at: string; // date-time
366
+ /**
367
+ * Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
368
+ * example:
369
+ * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
370
+ */
371
+ message_id?: string;
372
+ /**
373
+ * Ivy User ID of user sends the message.
374
+ * example:
375
+ * 206801
376
+ */
377
+ sender?: string;
378
+ /**
379
+ * Subject
380
+ * example:
381
+ * Request for solar panel price
382
+ */
383
+ subject: string;
384
+ /**
385
+ * HTML body
386
+ * example:
387
+ * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
388
+ */
389
+ html?: string;
390
+ /**
391
+ * Text body
392
+ * example:
393
+ * We at ABC GmbH would like to request a price quote for the solar panel.
394
+ */
395
+ text?: string;
396
+ from: Components.Schemas.Address;
397
+ reply_to?: Components.Schemas.Address;
398
+ /**
399
+ * To email addresses
400
+ */
401
+ to?: Components.Schemas.Address[];
402
+ /**
403
+ * Cc email addresses
404
+ */
405
+ cc?: Components.Schemas.Address[];
406
+ /**
407
+ * Bcc email addresses
408
+ */
409
+ bcc?: Components.Schemas.Address[];
410
+ file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
411
+ /**
412
+ * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\
413
+ * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
414
+ * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
415
+ *
416
+ * example:
417
+ * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
418
+ */
419
+ references?: string;
420
+ /**
421
+ * In-Reply-To header. Value is the `message_id` of parent message.
422
+ *
423
+ * example:
424
+ * <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
425
+ */
426
+ in_reply_to?: string;
427
+ /**
428
+ * Ivy User ID of user read the message.
429
+ */
430
+ user_read_message?: string[];
431
+ /**
432
+ * Ivy Organization ID of organization read the message.
433
+ */
434
+ org_read_message?: string[];
435
+ /**
436
+ * 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`\
437
+ * Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
438
+ *
439
+ */
440
+ send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
441
+ /**
442
+ * Message type
443
+ */
444
+ type?: "SENT" | "RECEIVED";
445
+ }
446
+ export interface $403 {
447
+ }
448
+ }
445
449
  }
446
- }
447
- namespace DeleteMessage {
448
- namespace Parameters {
449
- export type Id = string;
450
+ namespace DeleteMessage {
451
+ namespace Parameters {
452
+ export type Id = string;
453
+ }
454
+ export interface PathParameters {
455
+ id: Parameters.Id;
456
+ }
457
+ namespace Responses {
458
+ export interface $204 {
459
+ }
460
+ export interface $403 {
461
+ }
462
+ }
450
463
  }
451
- export interface PathParameters {
452
- id: Parameters.Id;
464
+ namespace DeleteThread {
465
+ namespace Parameters {
466
+ export type Id = string;
467
+ }
468
+ export interface PathParameters {
469
+ id: Parameters.Id;
470
+ }
471
+ namespace Responses {
472
+ export interface $204 {
473
+ }
474
+ export interface $403 {
475
+ }
476
+ }
453
477
  }
454
- }
455
- namespace DeleteThread {
456
- namespace Parameters {
457
- export type Id = string;
478
+ namespace GetMessage {
479
+ namespace Parameters {
480
+ export type Id = string;
481
+ }
482
+ export interface PathParameters {
483
+ id: Parameters.Id;
484
+ }
485
+ namespace Responses {
486
+ export interface $201 {
487
+ /**
488
+ * Entity ID
489
+ * example:
490
+ * 3fa85f64-5717-4562-b3fc-2c963f66afa6
491
+ */
492
+ _id: string;
493
+ /**
494
+ * Entity title
495
+ */
496
+ _title: string;
497
+ /**
498
+ * Ivy Organization ID the entity belongs to
499
+ * example:
500
+ * 206801
501
+ */
502
+ _org: string;
503
+ /**
504
+ * URL-friendly identifier for the entity schema
505
+ * example:
506
+ * message
507
+ */
508
+ _schema: string;
509
+ /**
510
+ * Entity tags
511
+ * example:
512
+ * [
513
+ * "pricing",
514
+ * "INBOX"
515
+ * ]
516
+ */
517
+ _tags?: string[];
518
+ /**
519
+ * Created date
520
+ * example:
521
+ * 2021-02-09T12:41:43.662Z
522
+ */
523
+ _created_at: string; // date-time
524
+ /**
525
+ * Updated date
526
+ * example:
527
+ * 2021-02-10T09:14:31.990Z
528
+ */
529
+ _updated_at: string; // date-time
530
+ /**
531
+ * Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
532
+ * example:
533
+ * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
534
+ */
535
+ message_id?: string;
536
+ /**
537
+ * Ivy User ID of user sends the message.
538
+ * example:
539
+ * 206801
540
+ */
541
+ sender?: string;
542
+ /**
543
+ * Subject
544
+ * example:
545
+ * Request for solar panel price
546
+ */
547
+ subject: string;
548
+ /**
549
+ * HTML body
550
+ * example:
551
+ * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
552
+ */
553
+ html?: string;
554
+ /**
555
+ * Text body
556
+ * example:
557
+ * We at ABC GmbH would like to request a price quote for the solar panel.
558
+ */
559
+ text?: string;
560
+ from: Components.Schemas.Address;
561
+ reply_to?: Components.Schemas.Address;
562
+ /**
563
+ * To email addresses
564
+ */
565
+ to?: Components.Schemas.Address[];
566
+ /**
567
+ * Cc email addresses
568
+ */
569
+ cc?: Components.Schemas.Address[];
570
+ /**
571
+ * Bcc email addresses
572
+ */
573
+ bcc?: Components.Schemas.Address[];
574
+ file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
575
+ /**
576
+ * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\
577
+ * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
578
+ * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
579
+ *
580
+ * example:
581
+ * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
582
+ */
583
+ references?: string;
584
+ /**
585
+ * In-Reply-To header. Value is the `message_id` of parent message.
586
+ *
587
+ * example:
588
+ * <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
589
+ */
590
+ in_reply_to?: string;
591
+ /**
592
+ * Ivy User ID of user read the message.
593
+ */
594
+ user_read_message?: string[];
595
+ /**
596
+ * Ivy Organization ID of organization read the message.
597
+ */
598
+ org_read_message?: string[];
599
+ /**
600
+ * 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`\
601
+ * Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
602
+ *
603
+ */
604
+ send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
605
+ /**
606
+ * Message type
607
+ */
608
+ type?: "SENT" | "RECEIVED";
609
+ }
610
+ export interface $403 {
611
+ }
612
+ }
458
613
  }
459
- export interface PathParameters {
460
- id: Parameters.Id;
614
+ namespace MarkReadMessage {
615
+ namespace Parameters {
616
+ export type Id = string;
617
+ }
618
+ export interface PathParameters {
619
+ id: Parameters.Id;
620
+ }
621
+ namespace Responses {
622
+ export interface $204 {
623
+ }
624
+ export interface $403 {
625
+ }
626
+ }
461
627
  }
462
- }
463
- namespace MarkReadMessage {
464
- namespace Parameters {
465
- export type Id = string;
628
+ namespace MarkReadThread {
629
+ namespace Parameters {
630
+ export type Id = string;
631
+ }
632
+ export interface PathParameters {
633
+ id: Parameters.Id;
634
+ }
635
+ namespace Responses {
636
+ export interface $204 {
637
+ }
638
+ export interface $403 {
639
+ }
640
+ }
466
641
  }
467
- export interface PathParameters {
468
- id: Parameters.Id;
642
+ namespace MarkUnreadMessage {
643
+ namespace Parameters {
644
+ export type Id = string;
645
+ }
646
+ export interface PathParameters {
647
+ id: Parameters.Id;
648
+ }
649
+ namespace Responses {
650
+ export interface $204 {
651
+ }
652
+ export interface $403 {
653
+ }
654
+ }
469
655
  }
470
- }
471
- namespace MarkReadThread {
472
- namespace Parameters {
473
- export type Id = string;
656
+ namespace MarkUnreadThread {
657
+ namespace Parameters {
658
+ export type Id = string;
659
+ }
660
+ export interface PathParameters {
661
+ id: Parameters.Id;
662
+ }
663
+ namespace Responses {
664
+ export interface $204 {
665
+ }
666
+ export interface $403 {
667
+ }
668
+ }
474
669
  }
475
- export interface PathParameters {
476
- id: Parameters.Id;
670
+ namespace SearchThreads {
671
+ export type RequestBody = Components.Schemas.SearchParams;
672
+ namespace Responses {
673
+ export interface $200 {
674
+ /**
675
+ * Total of matched threads
676
+ * example:
677
+ * 14
678
+ */
679
+ hits: number;
680
+ /**
681
+ * Matched threads
682
+ */
683
+ results: {
684
+ /**
685
+ * Entity ID
686
+ * example:
687
+ * 3fa85f64-5717-4562-b3fc-2c963f66afa6
688
+ */
689
+ _id: string;
690
+ /**
691
+ * Entity title
692
+ */
693
+ _title: string;
694
+ /**
695
+ * Ivy Organization ID the entity belongs to
696
+ * example:
697
+ * 206801
698
+ */
699
+ _org: string;
700
+ /**
701
+ * URL-friendly identifier for the entity schema
702
+ * example:
703
+ * message
704
+ */
705
+ _schema: string;
706
+ /**
707
+ * Entity tags
708
+ * example:
709
+ * [
710
+ * "pricing",
711
+ * "INBOX"
712
+ * ]
713
+ */
714
+ _tags?: string[];
715
+ /**
716
+ * Created date
717
+ * example:
718
+ * 2021-02-09T12:41:43.662Z
719
+ */
720
+ _created_at: string; // date-time
721
+ /**
722
+ * Updated date
723
+ * example:
724
+ * 2021-02-10T09:14:31.990Z
725
+ */
726
+ _updated_at: string; // date-time
727
+ /**
728
+ * Message topic (e.g. which service sends the message or message category)
729
+ * example:
730
+ * CUSTOMER_MESSAGE
731
+ */
732
+ topic: string;
733
+ /**
734
+ * Ivy User ID of who the message is assigned to. Default is the user who sends message.
735
+ */
736
+ assigned_to?: string[];
737
+ /**
738
+ * Ivy Organization ID of organization read the message.
739
+ */
740
+ org_read_message?: string[];
741
+ latest_message?: Components.Schemas.Message;
742
+ latest_trash_message?: Components.Schemas.Message;
743
+ }[];
744
+ }
745
+ export interface $403 {
746
+ }
747
+ }
477
748
  }
478
- }
479
- namespace MarkUnreadMessage {
480
- namespace Parameters {
481
- export type Id = string;
749
+ namespace SendDraft {
750
+ namespace Responses {
751
+ export interface $201 {
752
+ /**
753
+ * Entity ID
754
+ * example:
755
+ * 3fa85f64-5717-4562-b3fc-2c963f66afa6
756
+ */
757
+ _id: string;
758
+ /**
759
+ * Entity title
760
+ */
761
+ _title: string;
762
+ /**
763
+ * Ivy Organization ID the entity belongs to
764
+ * example:
765
+ * 206801
766
+ */
767
+ _org: string;
768
+ /**
769
+ * URL-friendly identifier for the entity schema
770
+ * example:
771
+ * message
772
+ */
773
+ _schema: string;
774
+ /**
775
+ * Entity tags
776
+ * example:
777
+ * [
778
+ * "pricing",
779
+ * "INBOX"
780
+ * ]
781
+ */
782
+ _tags?: string[];
783
+ /**
784
+ * Created date
785
+ * example:
786
+ * 2021-02-09T12:41:43.662Z
787
+ */
788
+ _created_at: string; // date-time
789
+ /**
790
+ * Updated date
791
+ * example:
792
+ * 2021-02-10T09:14:31.990Z
793
+ */
794
+ _updated_at: string; // date-time
795
+ /**
796
+ * Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
797
+ * example:
798
+ * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
799
+ */
800
+ message_id?: string;
801
+ /**
802
+ * Ivy User ID of user sends the message.
803
+ * example:
804
+ * 206801
805
+ */
806
+ sender?: string;
807
+ /**
808
+ * Subject
809
+ * example:
810
+ * Request for solar panel price
811
+ */
812
+ subject: string;
813
+ /**
814
+ * HTML body
815
+ * example:
816
+ * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
817
+ */
818
+ html?: string;
819
+ /**
820
+ * Text body
821
+ * example:
822
+ * We at ABC GmbH would like to request a price quote for the solar panel.
823
+ */
824
+ text?: string;
825
+ from: Components.Schemas.Address;
826
+ reply_to?: Components.Schemas.Address;
827
+ /**
828
+ * To email addresses
829
+ */
830
+ to?: Components.Schemas.Address[];
831
+ /**
832
+ * Cc email addresses
833
+ */
834
+ cc?: Components.Schemas.Address[];
835
+ /**
836
+ * Bcc email addresses
837
+ */
838
+ bcc?: Components.Schemas.Address[];
839
+ file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
840
+ /**
841
+ * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\
842
+ * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
843
+ * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
844
+ *
845
+ * example:
846
+ * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
847
+ */
848
+ references?: string;
849
+ /**
850
+ * In-Reply-To header. Value is the `message_id` of parent message.
851
+ *
852
+ * example:
853
+ * <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
854
+ */
855
+ in_reply_to?: string;
856
+ /**
857
+ * Ivy User ID of user read the message.
858
+ */
859
+ user_read_message?: string[];
860
+ /**
861
+ * Ivy Organization ID of organization read the message.
862
+ */
863
+ org_read_message?: string[];
864
+ /**
865
+ * 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`\
866
+ * Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
867
+ *
868
+ */
869
+ send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
870
+ /**
871
+ * Message type
872
+ */
873
+ type?: "SENT" | "RECEIVED";
874
+ }
875
+ export interface $403 {
876
+ }
877
+ }
482
878
  }
483
- export interface PathParameters {
484
- id: Parameters.Id;
879
+ namespace SendMessage {
880
+ export type RequestBody = Components.Schemas.MessageRequestParams;
881
+ namespace Responses {
882
+ export interface $201 {
883
+ /**
884
+ * Entity ID
885
+ * example:
886
+ * 3fa85f64-5717-4562-b3fc-2c963f66afa6
887
+ */
888
+ _id: string;
889
+ /**
890
+ * Entity title
891
+ */
892
+ _title: string;
893
+ /**
894
+ * Ivy Organization ID the entity belongs to
895
+ * example:
896
+ * 206801
897
+ */
898
+ _org: string;
899
+ /**
900
+ * URL-friendly identifier for the entity schema
901
+ * example:
902
+ * message
903
+ */
904
+ _schema: string;
905
+ /**
906
+ * Entity tags
907
+ * example:
908
+ * [
909
+ * "pricing",
910
+ * "INBOX"
911
+ * ]
912
+ */
913
+ _tags?: string[];
914
+ /**
915
+ * Created date
916
+ * example:
917
+ * 2021-02-09T12:41:43.662Z
918
+ */
919
+ _created_at: string; // date-time
920
+ /**
921
+ * Updated date
922
+ * example:
923
+ * 2021-02-10T09:14:31.990Z
924
+ */
925
+ _updated_at: string; // date-time
926
+ /**
927
+ * Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
928
+ * example:
929
+ * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
930
+ */
931
+ message_id?: string;
932
+ /**
933
+ * Ivy User ID of user sends the message.
934
+ * example:
935
+ * 206801
936
+ */
937
+ sender?: string;
938
+ /**
939
+ * Subject
940
+ * example:
941
+ * Request for solar panel price
942
+ */
943
+ subject: string;
944
+ /**
945
+ * HTML body
946
+ * example:
947
+ * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
948
+ */
949
+ html?: string;
950
+ /**
951
+ * Text body
952
+ * example:
953
+ * We at ABC GmbH would like to request a price quote for the solar panel.
954
+ */
955
+ text?: string;
956
+ from: Components.Schemas.Address;
957
+ reply_to?: Components.Schemas.Address;
958
+ /**
959
+ * To email addresses
960
+ */
961
+ to?: Components.Schemas.Address[];
962
+ /**
963
+ * Cc email addresses
964
+ */
965
+ cc?: Components.Schemas.Address[];
966
+ /**
967
+ * Bcc email addresses
968
+ */
969
+ bcc?: Components.Schemas.Address[];
970
+ file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
971
+ /**
972
+ * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\
973
+ * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
974
+ * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
975
+ *
976
+ * example:
977
+ * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
978
+ */
979
+ references?: string;
980
+ /**
981
+ * In-Reply-To header. Value is the `message_id` of parent message.
982
+ *
983
+ * example:
984
+ * <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
985
+ */
986
+ in_reply_to?: string;
987
+ /**
988
+ * Ivy User ID of user read the message.
989
+ */
990
+ user_read_message?: string[];
991
+ /**
992
+ * Ivy Organization ID of organization read the message.
993
+ */
994
+ org_read_message?: string[];
995
+ /**
996
+ * 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`\
997
+ * Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
998
+ *
999
+ */
1000
+ send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
1001
+ /**
1002
+ * Message type
1003
+ */
1004
+ type?: "SENT" | "RECEIVED";
1005
+ }
1006
+ export interface $403 {
1007
+ }
1008
+ }
485
1009
  }
486
- }
487
- namespace MarkUnreadThread {
488
- namespace Parameters {
489
- export type Id = string;
1010
+ namespace TrashMessage {
1011
+ namespace Parameters {
1012
+ export type Id = string;
1013
+ }
1014
+ export interface PathParameters {
1015
+ id: Parameters.Id;
1016
+ }
1017
+ namespace Responses {
1018
+ export interface $204 {
1019
+ }
1020
+ export interface $403 {
1021
+ }
1022
+ }
490
1023
  }
491
- export interface PathParameters {
492
- id: Parameters.Id;
1024
+ namespace TrashThread {
1025
+ namespace Parameters {
1026
+ export type Id = string;
1027
+ }
1028
+ export interface PathParameters {
1029
+ id: Parameters.Id;
1030
+ }
1031
+ namespace Responses {
1032
+ export interface $204 {
1033
+ }
1034
+ export interface $403 {
1035
+ }
1036
+ }
493
1037
  }
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
- }
1038
+ namespace UntrashMessage {
1039
+ namespace Parameters {
1040
+ export type Id = string;
1041
+ }
1042
+ export interface PathParameters {
1043
+ id: Parameters.Id;
1044
+ }
1045
+ namespace Responses {
1046
+ export interface $204 {
1047
+ }
1048
+ export interface $403 {
1049
+ }
1050
+ }
576
1051
  }
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.File;
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
- }
1052
+ namespace UntrashThread {
1053
+ namespace Parameters {
1054
+ export type Id = string;
1055
+ }
1056
+ export interface PathParameters {
1057
+ id: Parameters.Id;
1058
+ }
1059
+ namespace Responses {
1060
+ export interface $204 {
1061
+ }
1062
+ export interface $403 {
1063
+ }
1064
+ }
704
1065
  }
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.File;
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
- }
1066
+ namespace UpdateMessage {
1067
+ namespace Responses {
1068
+ export interface $201 {
1069
+ /**
1070
+ * Entity ID
1071
+ * example:
1072
+ * 3fa85f64-5717-4562-b3fc-2c963f66afa6
1073
+ */
1074
+ _id: string;
1075
+ /**
1076
+ * Entity title
1077
+ */
1078
+ _title: string;
1079
+ /**
1080
+ * Ivy Organization ID the entity belongs to
1081
+ * example:
1082
+ * 206801
1083
+ */
1084
+ _org: string;
1085
+ /**
1086
+ * URL-friendly identifier for the entity schema
1087
+ * example:
1088
+ * message
1089
+ */
1090
+ _schema: string;
1091
+ /**
1092
+ * Entity tags
1093
+ * example:
1094
+ * [
1095
+ * "pricing",
1096
+ * "INBOX"
1097
+ * ]
1098
+ */
1099
+ _tags?: string[];
1100
+ /**
1101
+ * Created date
1102
+ * example:
1103
+ * 2021-02-09T12:41:43.662Z
1104
+ */
1105
+ _created_at: string; // date-time
1106
+ /**
1107
+ * Updated date
1108
+ * example:
1109
+ * 2021-02-10T09:14:31.990Z
1110
+ */
1111
+ _updated_at: string; // date-time
1112
+ /**
1113
+ * Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
1114
+ * example:
1115
+ * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
1116
+ */
1117
+ message_id?: string;
1118
+ /**
1119
+ * Ivy User ID of user sends the message.
1120
+ * example:
1121
+ * 206801
1122
+ */
1123
+ sender?: string;
1124
+ /**
1125
+ * Subject
1126
+ * example:
1127
+ * Request for solar panel price
1128
+ */
1129
+ subject: string;
1130
+ /**
1131
+ * HTML body
1132
+ * example:
1133
+ * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
1134
+ */
1135
+ html?: string;
1136
+ /**
1137
+ * Text body
1138
+ * example:
1139
+ * We at ABC GmbH would like to request a price quote for the solar panel.
1140
+ */
1141
+ text?: string;
1142
+ from: Components.Schemas.Address;
1143
+ reply_to?: Components.Schemas.Address;
1144
+ /**
1145
+ * To email addresses
1146
+ */
1147
+ to?: Components.Schemas.Address[];
1148
+ /**
1149
+ * Cc email addresses
1150
+ */
1151
+ cc?: Components.Schemas.Address[];
1152
+ /**
1153
+ * Bcc email addresses
1154
+ */
1155
+ bcc?: Components.Schemas.Address[];
1156
+ file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
1157
+ /**
1158
+ * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\
1159
+ * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\
1160
+ * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.
1161
+ *
1162
+ * example:
1163
+ * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
1164
+ */
1165
+ references?: string;
1166
+ /**
1167
+ * In-Reply-To header. Value is the `message_id` of parent message.
1168
+ *
1169
+ * example:
1170
+ * <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
1171
+ */
1172
+ in_reply_to?: string;
1173
+ /**
1174
+ * Ivy User ID of user read the message.
1175
+ */
1176
+ user_read_message?: string[];
1177
+ /**
1178
+ * Ivy Organization ID of organization read the message.
1179
+ */
1180
+ org_read_message?: string[];
1181
+ /**
1182
+ * 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`\
1183
+ * Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
1184
+ *
1185
+ */
1186
+ send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
1187
+ /**
1188
+ * Message type
1189
+ */
1190
+ type?: "SENT" | "RECEIVED";
1191
+ }
1192
+ export interface $403 {
1193
+ }
1194
+ }
833
1195
  }
834
- }
835
- namespace TrashMessage {
836
- namespace Parameters {
837
- export type Id = string;
838
- }
839
- export interface PathParameters {
840
- id: Parameters.Id;
841
- }
842
- }
843
- namespace TrashThread {
844
- namespace Parameters {
845
- export type Id = string;
846
- }
847
- export interface PathParameters {
848
- id: Parameters.Id;
849
- }
850
- }
851
- namespace UntrashMessage {
852
- namespace Parameters {
853
- export type Id = string;
854
- }
855
- export interface PathParameters {
856
- id: Parameters.Id;
1196
+ namespace UpdateThread {
1197
+ namespace Responses {
1198
+ /**
1199
+ * Thread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing.
1200
+ */
1201
+ export interface $201 {
1202
+ /**
1203
+ * Entity ID
1204
+ * example:
1205
+ * 3fa85f64-5717-4562-b3fc-2c963f66afa6
1206
+ */
1207
+ _id: string;
1208
+ /**
1209
+ * Entity title
1210
+ */
1211
+ _title: string;
1212
+ /**
1213
+ * Ivy Organization ID the entity belongs to
1214
+ * example:
1215
+ * 206801
1216
+ */
1217
+ _org: string;
1218
+ /**
1219
+ * URL-friendly identifier for the entity schema
1220
+ * example:
1221
+ * message
1222
+ */
1223
+ _schema: string;
1224
+ /**
1225
+ * Entity tags
1226
+ * example:
1227
+ * [
1228
+ * "pricing",
1229
+ * "INBOX"
1230
+ * ]
1231
+ */
1232
+ _tags?: string[];
1233
+ /**
1234
+ * Created date
1235
+ * example:
1236
+ * 2021-02-09T12:41:43.662Z
1237
+ */
1238
+ _created_at: string; // date-time
1239
+ /**
1240
+ * Updated date
1241
+ * example:
1242
+ * 2021-02-10T09:14:31.990Z
1243
+ */
1244
+ _updated_at: string; // date-time
1245
+ /**
1246
+ * Message topic (e.g. which service sends the message or message category)
1247
+ * example:
1248
+ * CUSTOMER_MESSAGE
1249
+ */
1250
+ topic: string;
1251
+ /**
1252
+ * Ivy User ID of who the message is assigned to. Default is the user who sends message.
1253
+ */
1254
+ assigned_to?: string[];
1255
+ /**
1256
+ * Ivy Organization ID of organization read the message.
1257
+ */
1258
+ org_read_message?: string[];
1259
+ latest_message?: Components.Schemas.Message;
1260
+ latest_trash_message?: Components.Schemas.Message;
1261
+ }
1262
+ export interface $403 {
1263
+ }
1264
+ }
857
1265
  }
858
- }
859
- namespace UntrashThread {
860
- namespace Parameters {
861
- export type Id = string;
862
- }
863
- export interface PathParameters {
864
- id: Parameters.Id;
865
- }
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.File;
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
- }
993
- }
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
- }
1067
- }
1068
- }
1069
1266
  }
1070
1267
 
1071
1268
  export interface OperationMethods {
@@ -1089,6 +1286,16 @@ export interface OperationMethods {
1089
1286
  data?: Paths.SendMessage.RequestBody,
1090
1287
  config?: AxiosRequestConfig
1091
1288
  ): OperationResponse<Paths.SendMessage.Responses.$201>
1289
+ /**
1290
+ * getMessage - getMessage
1291
+ *
1292
+ * Get an email message by id
1293
+ */
1294
+ 'getMessage'(
1295
+ parameters?: Parameters<Paths.GetMessage.PathParameters> | null,
1296
+ data?: any,
1297
+ config?: AxiosRequestConfig
1298
+ ): OperationResponse<Paths.GetMessage.Responses.$201>
1092
1299
  /**
1093
1300
  * deleteMessage - deleteMessage
1094
1301
  *
@@ -1098,7 +1305,7 @@ export interface OperationMethods {
1098
1305
  parameters?: Parameters<Paths.DeleteMessage.PathParameters> | null,
1099
1306
  data?: any,
1100
1307
  config?: AxiosRequestConfig
1101
- ): OperationResponse<any>
1308
+ ): OperationResponse<Paths.DeleteMessage.Responses.$204>
1102
1309
  /**
1103
1310
  * trashMessage - trashMessage
1104
1311
  *
@@ -1108,7 +1315,7 @@ export interface OperationMethods {
1108
1315
  parameters?: Parameters<Paths.TrashMessage.PathParameters> | null,
1109
1316
  data?: any,
1110
1317
  config?: AxiosRequestConfig
1111
- ): OperationResponse<any>
1318
+ ): OperationResponse<Paths.TrashMessage.Responses.$204>
1112
1319
  /**
1113
1320
  * untrashMessage - untrashMessage
1114
1321
  *
@@ -1118,7 +1325,7 @@ export interface OperationMethods {
1118
1325
  parameters?: Parameters<Paths.UntrashMessage.PathParameters> | null,
1119
1326
  data?: any,
1120
1327
  config?: AxiosRequestConfig
1121
- ): OperationResponse<any>
1328
+ ): OperationResponse<Paths.UntrashMessage.Responses.$204>
1122
1329
  /**
1123
1330
  * markReadMessage - markReadMessage
1124
1331
  *
@@ -1128,7 +1335,7 @@ export interface OperationMethods {
1128
1335
  parameters?: Parameters<Paths.MarkReadMessage.PathParameters> | null,
1129
1336
  data?: any,
1130
1337
  config?: AxiosRequestConfig
1131
- ): OperationResponse<any>
1338
+ ): OperationResponse<Paths.MarkReadMessage.Responses.$204>
1132
1339
  /**
1133
1340
  * markUnreadMessage - markUnreadMessage
1134
1341
  *
@@ -1138,7 +1345,7 @@ export interface OperationMethods {
1138
1345
  parameters?: Parameters<Paths.MarkUnreadMessage.PathParameters> | null,
1139
1346
  data?: any,
1140
1347
  config?: AxiosRequestConfig
1141
- ): OperationResponse<any>
1348
+ ): OperationResponse<Paths.MarkUnreadMessage.Responses.$204>
1142
1349
  /**
1143
1350
  * searchThreads - searchThreads
1144
1351
  *
@@ -1173,7 +1380,7 @@ export interface OperationMethods {
1173
1380
  parameters?: Parameters<Paths.DeleteThread.PathParameters> | null,
1174
1381
  data?: any,
1175
1382
  config?: AxiosRequestConfig
1176
- ): OperationResponse<any>
1383
+ ): OperationResponse<Paths.DeleteThread.Responses.$204>
1177
1384
  /**
1178
1385
  * trashThread - trashThread
1179
1386
  *
@@ -1183,7 +1390,7 @@ export interface OperationMethods {
1183
1390
  parameters?: Parameters<Paths.TrashThread.PathParameters> | null,
1184
1391
  data?: any,
1185
1392
  config?: AxiosRequestConfig
1186
- ): OperationResponse<any>
1393
+ ): OperationResponse<Paths.TrashThread.Responses.$204>
1187
1394
  /**
1188
1395
  * untrashThread - untrashThread
1189
1396
  *
@@ -1193,7 +1400,7 @@ export interface OperationMethods {
1193
1400
  parameters?: Parameters<Paths.UntrashThread.PathParameters> | null,
1194
1401
  data?: any,
1195
1402
  config?: AxiosRequestConfig
1196
- ): OperationResponse<any>
1403
+ ): OperationResponse<Paths.UntrashThread.Responses.$204>
1197
1404
  /**
1198
1405
  * markReadThread - markReadThread
1199
1406
  *
@@ -1203,7 +1410,7 @@ export interface OperationMethods {
1203
1410
  parameters?: Parameters<Paths.MarkReadThread.PathParameters> | null,
1204
1411
  data?: any,
1205
1412
  config?: AxiosRequestConfig
1206
- ): OperationResponse<any>
1413
+ ): OperationResponse<Paths.MarkReadThread.Responses.$204>
1207
1414
  /**
1208
1415
  * markUnreadThread - markUnreadThread
1209
1416
  *
@@ -1213,7 +1420,7 @@ export interface OperationMethods {
1213
1420
  parameters?: Parameters<Paths.MarkUnreadThread.PathParameters> | null,
1214
1421
  data?: any,
1215
1422
  config?: AxiosRequestConfig
1216
- ): OperationResponse<any>
1423
+ ): OperationResponse<Paths.MarkUnreadThread.Responses.$204>
1217
1424
  /**
1218
1425
  * createDraft - createDraft
1219
1426
  *
@@ -1260,6 +1467,16 @@ export interface PathsDictionary {
1260
1467
  ): OperationResponse<Paths.UpdateMessage.Responses.$201>
1261
1468
  }
1262
1469
  ['/v1/message/messages/{id}']: {
1470
+ /**
1471
+ * getMessage - getMessage
1472
+ *
1473
+ * Get an email message by id
1474
+ */
1475
+ 'get'(
1476
+ parameters?: Parameters<Paths.GetMessage.PathParameters> | null,
1477
+ data?: any,
1478
+ config?: AxiosRequestConfig
1479
+ ): OperationResponse<Paths.GetMessage.Responses.$201>
1263
1480
  /**
1264
1481
  * deleteMessage - deleteMessage
1265
1482
  *
@@ -1269,7 +1486,7 @@ export interface PathsDictionary {
1269
1486
  parameters?: Parameters<Paths.DeleteMessage.PathParameters> | null,
1270
1487
  data?: any,
1271
1488
  config?: AxiosRequestConfig
1272
- ): OperationResponse<any>
1489
+ ): OperationResponse<Paths.DeleteMessage.Responses.$204>
1273
1490
  }
1274
1491
  ['/v1/message/messages/{id}/trash']: {
1275
1492
  /**
@@ -1281,7 +1498,7 @@ export interface PathsDictionary {
1281
1498
  parameters?: Parameters<Paths.TrashMessage.PathParameters> | null,
1282
1499
  data?: any,
1283
1500
  config?: AxiosRequestConfig
1284
- ): OperationResponse<any>
1501
+ ): OperationResponse<Paths.TrashMessage.Responses.$204>
1285
1502
  }
1286
1503
  ['/v1/message/messages/{id}/untrash']: {
1287
1504
  /**
@@ -1293,7 +1510,7 @@ export interface PathsDictionary {
1293
1510
  parameters?: Parameters<Paths.UntrashMessage.PathParameters> | null,
1294
1511
  data?: any,
1295
1512
  config?: AxiosRequestConfig
1296
- ): OperationResponse<any>
1513
+ ): OperationResponse<Paths.UntrashMessage.Responses.$204>
1297
1514
  }
1298
1515
  ['/v1/message/messages/{id}/read']: {
1299
1516
  /**
@@ -1305,7 +1522,7 @@ export interface PathsDictionary {
1305
1522
  parameters?: Parameters<Paths.MarkReadMessage.PathParameters> | null,
1306
1523
  data?: any,
1307
1524
  config?: AxiosRequestConfig
1308
- ): OperationResponse<any>
1525
+ ): OperationResponse<Paths.MarkReadMessage.Responses.$204>
1309
1526
  }
1310
1527
  ['/v1/message/messages/{id}/unread']: {
1311
1528
  /**
@@ -1317,7 +1534,7 @@ export interface PathsDictionary {
1317
1534
  parameters?: Parameters<Paths.MarkUnreadMessage.PathParameters> | null,
1318
1535
  data?: any,
1319
1536
  config?: AxiosRequestConfig
1320
- ): OperationResponse<any>
1537
+ ): OperationResponse<Paths.MarkUnreadMessage.Responses.$204>
1321
1538
  }
1322
1539
  ['/v1/message/threads:search']: {
1323
1540
  /**
@@ -1358,7 +1575,7 @@ export interface PathsDictionary {
1358
1575
  parameters?: Parameters<Paths.DeleteThread.PathParameters> | null,
1359
1576
  data?: any,
1360
1577
  config?: AxiosRequestConfig
1361
- ): OperationResponse<any>
1578
+ ): OperationResponse<Paths.DeleteThread.Responses.$204>
1362
1579
  }
1363
1580
  ['/v1/message/threads/{id}/trash']: {
1364
1581
  /**
@@ -1370,7 +1587,7 @@ export interface PathsDictionary {
1370
1587
  parameters?: Parameters<Paths.TrashThread.PathParameters> | null,
1371
1588
  data?: any,
1372
1589
  config?: AxiosRequestConfig
1373
- ): OperationResponse<any>
1590
+ ): OperationResponse<Paths.TrashThread.Responses.$204>
1374
1591
  }
1375
1592
  ['/v1/message/threads/{id}/untrash']: {
1376
1593
  /**
@@ -1382,7 +1599,7 @@ export interface PathsDictionary {
1382
1599
  parameters?: Parameters<Paths.UntrashThread.PathParameters> | null,
1383
1600
  data?: any,
1384
1601
  config?: AxiosRequestConfig
1385
- ): OperationResponse<any>
1602
+ ): OperationResponse<Paths.UntrashThread.Responses.$204>
1386
1603
  }
1387
1604
  ['/v1/message/threads/{id}/read']: {
1388
1605
  /**
@@ -1394,7 +1611,7 @@ export interface PathsDictionary {
1394
1611
  parameters?: Parameters<Paths.MarkReadThread.PathParameters> | null,
1395
1612
  data?: any,
1396
1613
  config?: AxiosRequestConfig
1397
- ): OperationResponse<any>
1614
+ ): OperationResponse<Paths.MarkReadThread.Responses.$204>
1398
1615
  }
1399
1616
  ['/v1/message/threads/{id}/unread']: {
1400
1617
  /**
@@ -1406,7 +1623,7 @@ export interface PathsDictionary {
1406
1623
  parameters?: Parameters<Paths.MarkUnreadThread.PathParameters> | null,
1407
1624
  data?: any,
1408
1625
  config?: AxiosRequestConfig
1409
- ): OperationResponse<any>
1626
+ ): OperationResponse<Paths.MarkUnreadThread.Responses.$204>
1410
1627
  }
1411
1628
  ['/v1/message/drafts']: {
1412
1629
  /**