@sendmux/cli 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. package/README.md +26 -0
  2. package/bin/run.js +5 -0
  3. package/dist/base-command.d.ts +25 -0
  4. package/dist/base-command.d.ts.map +1 -0
  5. package/dist/base-command.js +93 -0
  6. package/dist/commands/mailbox/folders/list.d.ts +24 -0
  7. package/dist/commands/mailbox/folders/list.d.ts.map +1 -0
  8. package/dist/commands/mailbox/folders/list.js +6 -0
  9. package/dist/commands/mailbox/me/get.d.ts +21 -0
  10. package/dist/commands/mailbox/me/get.d.ts.map +1 -0
  11. package/dist/commands/mailbox/me/get.js +6 -0
  12. package/dist/commands/mailbox/messages/get.d.ts +24 -0
  13. package/dist/commands/mailbox/messages/get.d.ts.map +1 -0
  14. package/dist/commands/mailbox/messages/get.js +6 -0
  15. package/dist/commands/mailbox/messages/list.d.ts +87 -0
  16. package/dist/commands/mailbox/messages/list.d.ts.map +1 -0
  17. package/dist/commands/mailbox/messages/list.js +6 -0
  18. package/dist/commands/management/domains/get.d.ts +24 -0
  19. package/dist/commands/management/domains/get.d.ts.map +1 -0
  20. package/dist/commands/management/domains/get.js +6 -0
  21. package/dist/commands/management/domains/list.d.ts +24 -0
  22. package/dist/commands/management/domains/list.d.ts.map +1 -0
  23. package/dist/commands/management/domains/list.js +6 -0
  24. package/dist/commands/management/mailboxes/list.d.ts +27 -0
  25. package/dist/commands/management/mailboxes/list.d.ts.map +1 -0
  26. package/dist/commands/management/mailboxes/list.js +6 -0
  27. package/dist/commands/management/providers/list.d.ts +30 -0
  28. package/dist/commands/management/providers/list.d.ts.map +1 -0
  29. package/dist/commands/management/providers/list.js +6 -0
  30. package/dist/commands/profiles/list.d.ts +9 -0
  31. package/dist/commands/profiles/list.d.ts.map +1 -0
  32. package/dist/commands/profiles/list.js +28 -0
  33. package/dist/commands/profiles/set.d.ts +14 -0
  34. package/dist/commands/profiles/set.d.ts.map +1 -0
  35. package/dist/commands/profiles/set.js +57 -0
  36. package/dist/commands/profiles/show.d.ts +9 -0
  37. package/dist/commands/profiles/show.d.ts.map +1 -0
  38. package/dist/commands/profiles/show.js +36 -0
  39. package/dist/commands/sending/send/batch.d.ts +21 -0
  40. package/dist/commands/sending/send/batch.d.ts.map +1 -0
  41. package/dist/commands/sending/send/batch.js +6 -0
  42. package/dist/commands/sending/send.d.ts +21 -0
  43. package/dist/commands/sending/send.d.ts.map +1 -0
  44. package/dist/commands/sending/send.js +6 -0
  45. package/dist/generated/operations.d.ts +2340 -0
  46. package/dist/generated/operations.d.ts.map +1 -0
  47. package/dist/generated/operations.js +2511 -0
  48. package/dist/index.d.ts +2 -0
  49. package/dist/index.d.ts.map +1 -0
  50. package/dist/index.js +1 -0
  51. package/dist/key-kind.d.ts +4 -0
  52. package/dist/key-kind.d.ts.map +1 -0
  53. package/dist/key-kind.js +15 -0
  54. package/dist/operation-command.d.ts +18 -0
  55. package/dist/operation-command.d.ts.map +1 -0
  56. package/dist/operation-command.js +11 -0
  57. package/dist/operation-flags.d.ts +33 -0
  58. package/dist/operation-flags.d.ts.map +1 -0
  59. package/dist/operation-flags.js +103 -0
  60. package/dist/operation-runner.d.ts +5 -0
  61. package/dist/operation-runner.d.ts.map +1 -0
  62. package/dist/operation-runner.js +45 -0
  63. package/dist/operation-types.d.ts +19 -0
  64. package/dist/operation-types.d.ts.map +1 -0
  65. package/dist/operation-types.js +1 -0
  66. package/dist/profiles.d.ts +12 -0
  67. package/dist/profiles.d.ts.map +1 -0
  68. package/dist/profiles.js +35 -0
  69. package/oclif.manifest.json +1546 -0
  70. package/package.json +60 -0
@@ -0,0 +1,2340 @@
1
+ export declare const operations: {
2
+ readonly mailboxBatchDeleteMessages: {
3
+ readonly command: "mailbox:batch-delete-messages";
4
+ readonly description: "Batch delete mailbox messages";
5
+ readonly headerParams: readonly [];
6
+ readonly method: "post";
7
+ readonly operationId: "mailboxBatchDeleteMessages";
8
+ readonly path: "/mailbox/messages:batch-delete";
9
+ readonly pathParams: readonly [];
10
+ readonly queryParams: readonly [];
11
+ readonly requestBodyRequired: false;
12
+ readonly requiredKeyKind: "mailbox";
13
+ readonly surface: "mailbox";
14
+ };
15
+ readonly mailboxBatchGetMessages: {
16
+ readonly command: "mailbox:batch-get-messages";
17
+ readonly description: "Batch get mailbox messages";
18
+ readonly headerParams: readonly [];
19
+ readonly method: "post";
20
+ readonly operationId: "mailboxBatchGetMessages";
21
+ readonly path: "/mailbox/messages:batch-get";
22
+ readonly pathParams: readonly [];
23
+ readonly queryParams: readonly [];
24
+ readonly requestBodyRequired: false;
25
+ readonly requiredKeyKind: "mailbox";
26
+ readonly surface: "mailbox";
27
+ };
28
+ readonly mailboxBatchUpdateMessages: {
29
+ readonly command: "mailbox:batch-update-messages";
30
+ readonly description: "Batch update mailbox messages";
31
+ readonly headerParams: readonly [];
32
+ readonly method: "post";
33
+ readonly operationId: "mailboxBatchUpdateMessages";
34
+ readonly path: "/mailbox/messages:batch-update";
35
+ readonly pathParams: readonly [];
36
+ readonly queryParams: readonly [];
37
+ readonly requestBodyRequired: false;
38
+ readonly requiredKeyKind: "mailbox";
39
+ readonly surface: "mailbox";
40
+ };
41
+ readonly mailboxCountMessages: {
42
+ readonly command: "mailbox:count-messages";
43
+ readonly description: "Count mailbox messages";
44
+ readonly headerParams: readonly [];
45
+ readonly method: "get";
46
+ readonly operationId: "mailboxCountMessages";
47
+ readonly path: "/mailbox/messages/count";
48
+ readonly pathParams: readonly [];
49
+ readonly queryParams: readonly [{
50
+ readonly name: "folder_id";
51
+ readonly required: false;
52
+ }, {
53
+ readonly name: "thread_id";
54
+ readonly required: false;
55
+ }, {
56
+ readonly name: "q";
57
+ readonly required: false;
58
+ }, {
59
+ readonly name: "from";
60
+ readonly required: false;
61
+ }, {
62
+ readonly name: "to";
63
+ readonly required: false;
64
+ }, {
65
+ readonly name: "cc";
66
+ readonly required: false;
67
+ }, {
68
+ readonly name: "bcc";
69
+ readonly required: false;
70
+ }, {
71
+ readonly name: "subject";
72
+ readonly required: false;
73
+ }, {
74
+ readonly name: "body";
75
+ readonly required: false;
76
+ }, {
77
+ readonly name: "header_name";
78
+ readonly required: false;
79
+ }, {
80
+ readonly name: "header_value";
81
+ readonly required: false;
82
+ }, {
83
+ readonly name: "min_size_bytes";
84
+ readonly required: false;
85
+ }, {
86
+ readonly name: "max_size_bytes";
87
+ readonly required: false;
88
+ }, {
89
+ readonly name: "keyword";
90
+ readonly required: false;
91
+ }, {
92
+ readonly name: "not_keyword";
93
+ readonly required: false;
94
+ }, {
95
+ readonly name: "after";
96
+ readonly required: false;
97
+ }, {
98
+ readonly name: "before";
99
+ readonly required: false;
100
+ }, {
101
+ readonly name: "has_attachment";
102
+ readonly required: false;
103
+ }, {
104
+ readonly name: "is_unread";
105
+ readonly required: false;
106
+ }];
107
+ readonly requestBodyRequired: false;
108
+ readonly requiredKeyKind: "mailbox";
109
+ readonly surface: "mailbox";
110
+ };
111
+ readonly mailboxCreateFolder: {
112
+ readonly command: "mailbox:create-folder";
113
+ readonly description: "Create a mailbox folder";
114
+ readonly headerParams: readonly [];
115
+ readonly method: "post";
116
+ readonly operationId: "mailboxCreateFolder";
117
+ readonly path: "/mailbox/folders";
118
+ readonly pathParams: readonly [];
119
+ readonly queryParams: readonly [];
120
+ readonly requestBodyRequired: false;
121
+ readonly requiredKeyKind: "mailbox";
122
+ readonly surface: "mailbox";
123
+ };
124
+ readonly mailboxDeleteFolder: {
125
+ readonly command: "mailbox:delete-folder";
126
+ readonly description: "Delete a mailbox folder";
127
+ readonly headerParams: readonly [{
128
+ readonly name: "If-Match";
129
+ readonly required: false;
130
+ }];
131
+ readonly method: "delete";
132
+ readonly operationId: "mailboxDeleteFolder";
133
+ readonly path: "/mailbox/folders/{folder_id}";
134
+ readonly pathParams: readonly [{
135
+ readonly name: "folder_id";
136
+ readonly required: true;
137
+ }];
138
+ readonly queryParams: readonly [];
139
+ readonly requestBodyRequired: false;
140
+ readonly requiredKeyKind: "mailbox";
141
+ readonly surface: "mailbox";
142
+ };
143
+ readonly mailboxDeleteMessage: {
144
+ readonly command: "mailbox:delete-message";
145
+ readonly description: "Delete a mailbox message";
146
+ readonly headerParams: readonly [{
147
+ readonly name: "If-Match";
148
+ readonly required: false;
149
+ }];
150
+ readonly method: "delete";
151
+ readonly operationId: "mailboxDeleteMessage";
152
+ readonly path: "/mailbox/messages/{message_id}";
153
+ readonly pathParams: readonly [{
154
+ readonly name: "message_id";
155
+ readonly required: true;
156
+ }];
157
+ readonly queryParams: readonly [{
158
+ readonly name: "permanent";
159
+ readonly required: false;
160
+ }];
161
+ readonly requestBodyRequired: false;
162
+ readonly requiredKeyKind: "mailbox";
163
+ readonly surface: "mailbox";
164
+ };
165
+ readonly mailboxGetChanges: {
166
+ readonly command: "mailbox:get-changes";
167
+ readonly description: "Get mailbox changes";
168
+ readonly headerParams: readonly [];
169
+ readonly method: "get";
170
+ readonly operationId: "mailboxGetChanges";
171
+ readonly path: "/mailbox/changes";
172
+ readonly pathParams: readonly [];
173
+ readonly queryParams: readonly [{
174
+ readonly name: "since_state";
175
+ readonly required: false;
176
+ }, {
177
+ readonly name: "types";
178
+ readonly required: false;
179
+ }, {
180
+ readonly name: "messages_since_state";
181
+ readonly required: false;
182
+ }, {
183
+ readonly name: "folders_since_state";
184
+ readonly required: false;
185
+ }, {
186
+ readonly name: "threads_since_state";
187
+ readonly required: false;
188
+ }, {
189
+ readonly name: "submissions_since_state";
190
+ readonly required: false;
191
+ }, {
192
+ readonly name: "identities_since_state";
193
+ readonly required: false;
194
+ }, {
195
+ readonly name: "quotas_since_state";
196
+ readonly required: false;
197
+ }, {
198
+ readonly name: "limit";
199
+ readonly required: false;
200
+ }];
201
+ readonly requestBodyRequired: false;
202
+ readonly requiredKeyKind: "mailbox";
203
+ readonly surface: "mailbox";
204
+ };
205
+ readonly mailboxGetFolder: {
206
+ readonly command: "mailbox:get-folder";
207
+ readonly description: "Get a mailbox folder";
208
+ readonly headerParams: readonly [{
209
+ readonly name: "If-None-Match";
210
+ readonly required: false;
211
+ }];
212
+ readonly method: "get";
213
+ readonly operationId: "mailboxGetFolder";
214
+ readonly path: "/mailbox/folders/{folder_id}";
215
+ readonly pathParams: readonly [{
216
+ readonly name: "folder_id";
217
+ readonly required: true;
218
+ }];
219
+ readonly queryParams: readonly [];
220
+ readonly requestBodyRequired: false;
221
+ readonly requiredKeyKind: "mailbox";
222
+ readonly surface: "mailbox";
223
+ };
224
+ readonly mailboxGetFolderChanges: {
225
+ readonly command: "mailbox:get-folder-changes";
226
+ readonly description: "Get folder changes";
227
+ readonly headerParams: readonly [];
228
+ readonly method: "get";
229
+ readonly operationId: "mailboxGetFolderChanges";
230
+ readonly path: "/mailbox/folders/changes";
231
+ readonly pathParams: readonly [];
232
+ readonly queryParams: readonly [{
233
+ readonly name: "since_state";
234
+ readonly required: false;
235
+ }, {
236
+ readonly name: "limit";
237
+ readonly required: false;
238
+ }];
239
+ readonly requestBodyRequired: false;
240
+ readonly requiredKeyKind: "mailbox";
241
+ readonly surface: "mailbox";
242
+ };
243
+ readonly mailboxGetIdentity: {
244
+ readonly command: "mailbox:get-identity";
245
+ readonly description: "Get mailbox sender identity";
246
+ readonly headerParams: readonly [];
247
+ readonly method: "get";
248
+ readonly operationId: "mailboxGetIdentity";
249
+ readonly path: "/mailbox/identity";
250
+ readonly pathParams: readonly [];
251
+ readonly queryParams: readonly [];
252
+ readonly requestBodyRequired: false;
253
+ readonly requiredKeyKind: "mailbox";
254
+ readonly surface: "mailbox";
255
+ };
256
+ readonly mailboxGetMe: {
257
+ readonly command: "mailbox:me:get";
258
+ readonly description: "Self-introspect the calling mailbox";
259
+ readonly headerParams: readonly [{
260
+ readonly name: "If-None-Match";
261
+ readonly required: false;
262
+ }];
263
+ readonly method: "get";
264
+ readonly operationId: "mailboxGetMe";
265
+ readonly path: "/mailbox/me";
266
+ readonly pathParams: readonly [];
267
+ readonly queryParams: readonly [];
268
+ readonly requestBodyRequired: false;
269
+ readonly requiredKeyKind: "mailbox";
270
+ readonly surface: "mailbox";
271
+ };
272
+ readonly mailboxGetMessage: {
273
+ readonly command: "mailbox:messages:get";
274
+ readonly description: "Get a mailbox message";
275
+ readonly headerParams: readonly [{
276
+ readonly name: "If-None-Match";
277
+ readonly required: false;
278
+ }];
279
+ readonly method: "get";
280
+ readonly operationId: "mailboxGetMessage";
281
+ readonly path: "/mailbox/messages/{message_id}";
282
+ readonly pathParams: readonly [{
283
+ readonly name: "message_id";
284
+ readonly required: true;
285
+ }];
286
+ readonly queryParams: readonly [];
287
+ readonly requestBodyRequired: false;
288
+ readonly requiredKeyKind: "mailbox";
289
+ readonly surface: "mailbox";
290
+ };
291
+ readonly mailboxGetMessageAttachment: {
292
+ readonly command: "mailbox:get-message-attachment";
293
+ readonly description: "Download a message attachment";
294
+ readonly headerParams: readonly [{
295
+ readonly name: "Range";
296
+ readonly required: false;
297
+ }];
298
+ readonly method: "get";
299
+ readonly operationId: "mailboxGetMessageAttachment";
300
+ readonly path: "/mailbox/messages/{message_id}/attachments/{attachment_id}";
301
+ readonly pathParams: readonly [{
302
+ readonly name: "message_id";
303
+ readonly required: true;
304
+ }, {
305
+ readonly name: "attachment_id";
306
+ readonly required: true;
307
+ }];
308
+ readonly queryParams: readonly [];
309
+ readonly requestBodyRequired: false;
310
+ readonly requiredKeyKind: "mailbox";
311
+ readonly surface: "mailbox";
312
+ };
313
+ readonly mailboxGetQuotaChanges: {
314
+ readonly command: "mailbox:get-quota-changes";
315
+ readonly description: "Get quota changes";
316
+ readonly headerParams: readonly [];
317
+ readonly method: "get";
318
+ readonly operationId: "mailboxGetQuotaChanges";
319
+ readonly path: "/mailbox/quotas/changes";
320
+ readonly pathParams: readonly [];
321
+ readonly queryParams: readonly [{
322
+ readonly name: "since_state";
323
+ readonly required: false;
324
+ }, {
325
+ readonly name: "limit";
326
+ readonly required: false;
327
+ }];
328
+ readonly requestBodyRequired: false;
329
+ readonly requiredKeyKind: "mailbox";
330
+ readonly surface: "mailbox";
331
+ };
332
+ readonly mailboxGetSession: {
333
+ readonly command: "mailbox:get-session";
334
+ readonly description: "Get mailbox API session";
335
+ readonly headerParams: readonly [{
336
+ readonly name: "If-None-Match";
337
+ readonly required: false;
338
+ }];
339
+ readonly method: "get";
340
+ readonly operationId: "mailboxGetSession";
341
+ readonly path: "/mailbox/session";
342
+ readonly pathParams: readonly [];
343
+ readonly queryParams: readonly [];
344
+ readonly requestBodyRequired: false;
345
+ readonly requiredKeyKind: "mailbox";
346
+ readonly surface: "mailbox";
347
+ };
348
+ readonly mailboxGetSubmission: {
349
+ readonly command: "mailbox:get-submission";
350
+ readonly description: "Get a mailbox submission";
351
+ readonly headerParams: readonly [{
352
+ readonly name: "If-None-Match";
353
+ readonly required: false;
354
+ }];
355
+ readonly method: "get";
356
+ readonly operationId: "mailboxGetSubmission";
357
+ readonly path: "/mailbox/submissions/{submission_id}";
358
+ readonly pathParams: readonly [{
359
+ readonly name: "submission_id";
360
+ readonly required: true;
361
+ }];
362
+ readonly queryParams: readonly [];
363
+ readonly requestBodyRequired: false;
364
+ readonly requiredKeyKind: "mailbox";
365
+ readonly surface: "mailbox";
366
+ };
367
+ readonly mailboxGetSubmissionChanges: {
368
+ readonly command: "mailbox:get-submission-changes";
369
+ readonly description: "Get submission changes";
370
+ readonly headerParams: readonly [];
371
+ readonly method: "get";
372
+ readonly operationId: "mailboxGetSubmissionChanges";
373
+ readonly path: "/mailbox/submissions/changes";
374
+ readonly pathParams: readonly [];
375
+ readonly queryParams: readonly [{
376
+ readonly name: "since_state";
377
+ readonly required: false;
378
+ }, {
379
+ readonly name: "limit";
380
+ readonly required: false;
381
+ }];
382
+ readonly requestBodyRequired: false;
383
+ readonly requiredKeyKind: "mailbox";
384
+ readonly surface: "mailbox";
385
+ };
386
+ readonly mailboxGetThread: {
387
+ readonly command: "mailbox:get-thread";
388
+ readonly description: "Get a mailbox thread";
389
+ readonly headerParams: readonly [{
390
+ readonly name: "If-None-Match";
391
+ readonly required: false;
392
+ }];
393
+ readonly method: "get";
394
+ readonly operationId: "mailboxGetThread";
395
+ readonly path: "/mailbox/threads/{thread_id}";
396
+ readonly pathParams: readonly [{
397
+ readonly name: "thread_id";
398
+ readonly required: true;
399
+ }];
400
+ readonly queryParams: readonly [];
401
+ readonly requestBodyRequired: false;
402
+ readonly requiredKeyKind: "mailbox";
403
+ readonly surface: "mailbox";
404
+ };
405
+ readonly mailboxGetThreadContent: {
406
+ readonly command: "mailbox:get-thread-content";
407
+ readonly description: "Get clean thread content";
408
+ readonly headerParams: readonly [{
409
+ readonly name: "If-None-Match";
410
+ readonly required: false;
411
+ }];
412
+ readonly method: "get";
413
+ readonly operationId: "mailboxGetThreadContent";
414
+ readonly path: "/mailbox/threads/{thread_id}/content";
415
+ readonly pathParams: readonly [{
416
+ readonly name: "thread_id";
417
+ readonly required: true;
418
+ }];
419
+ readonly queryParams: readonly [{
420
+ readonly name: "part";
421
+ readonly required: false;
422
+ }, {
423
+ readonly name: "max_body_chars";
424
+ readonly required: false;
425
+ }, {
426
+ readonly name: "strip_signature";
427
+ readonly required: false;
428
+ }, {
429
+ readonly name: "strip_quotes";
430
+ readonly required: false;
431
+ }, {
432
+ readonly name: "include_links";
433
+ readonly required: false;
434
+ }, {
435
+ readonly name: "include_html";
436
+ readonly required: false;
437
+ }, {
438
+ readonly name: "include_headers";
439
+ readonly required: false;
440
+ }, {
441
+ readonly name: "include_attachments";
442
+ readonly required: false;
443
+ }, {
444
+ readonly name: "cursor";
445
+ readonly required: false;
446
+ }, {
447
+ readonly name: "limit";
448
+ readonly required: false;
449
+ }, {
450
+ readonly name: "sort";
451
+ readonly required: false;
452
+ }];
453
+ readonly requestBodyRequired: false;
454
+ readonly requiredKeyKind: "mailbox";
455
+ readonly surface: "mailbox";
456
+ };
457
+ readonly mailboxListBody: {
458
+ readonly command: "mailbox:list-body";
459
+ readonly description: "Get raw message body";
460
+ readonly headerParams: readonly [{
461
+ readonly name: "If-None-Match";
462
+ readonly required: false;
463
+ }];
464
+ readonly method: "get";
465
+ readonly operationId: "mailboxListBody";
466
+ readonly path: "/mailbox/messages/{message_id}/body";
467
+ readonly pathParams: readonly [{
468
+ readonly name: "message_id";
469
+ readonly required: true;
470
+ }];
471
+ readonly queryParams: readonly [{
472
+ readonly name: "part";
473
+ readonly required: false;
474
+ }, {
475
+ readonly name: "max_body_chars";
476
+ readonly required: false;
477
+ }];
478
+ readonly requestBodyRequired: false;
479
+ readonly requiredKeyKind: "mailbox";
480
+ readonly surface: "mailbox";
481
+ };
482
+ readonly mailboxListContent: {
483
+ readonly command: "mailbox:list-content";
484
+ readonly description: "Get clean message content";
485
+ readonly headerParams: readonly [{
486
+ readonly name: "If-None-Match";
487
+ readonly required: false;
488
+ }];
489
+ readonly method: "get";
490
+ readonly operationId: "mailboxListContent";
491
+ readonly path: "/mailbox/messages/{message_id}/content";
492
+ readonly pathParams: readonly [{
493
+ readonly name: "message_id";
494
+ readonly required: true;
495
+ }];
496
+ readonly queryParams: readonly [{
497
+ readonly name: "part";
498
+ readonly required: false;
499
+ }, {
500
+ readonly name: "max_body_chars";
501
+ readonly required: false;
502
+ }, {
503
+ readonly name: "strip_signature";
504
+ readonly required: false;
505
+ }, {
506
+ readonly name: "strip_quotes";
507
+ readonly required: false;
508
+ }, {
509
+ readonly name: "include_links";
510
+ readonly required: false;
511
+ }, {
512
+ readonly name: "include_html";
513
+ readonly required: false;
514
+ }, {
515
+ readonly name: "include_headers";
516
+ readonly required: false;
517
+ }, {
518
+ readonly name: "include_attachments";
519
+ readonly required: false;
520
+ }];
521
+ readonly requestBodyRequired: false;
522
+ readonly requiredKeyKind: "mailbox";
523
+ readonly surface: "mailbox";
524
+ };
525
+ readonly mailboxListFolders: {
526
+ readonly command: "mailbox:folders:list";
527
+ readonly description: "List mailbox folders";
528
+ readonly headerParams: readonly [];
529
+ readonly method: "get";
530
+ readonly operationId: "mailboxListFolders";
531
+ readonly path: "/mailbox/folders";
532
+ readonly pathParams: readonly [];
533
+ readonly queryParams: readonly [{
534
+ readonly name: "cursor";
535
+ readonly required: false;
536
+ }, {
537
+ readonly name: "limit";
538
+ readonly required: false;
539
+ }];
540
+ readonly requestBodyRequired: false;
541
+ readonly requiredKeyKind: "mailbox";
542
+ readonly surface: "mailbox";
543
+ };
544
+ readonly mailboxListIdentities: {
545
+ readonly command: "mailbox:list-identities";
546
+ readonly description: "List mailbox sender identities";
547
+ readonly headerParams: readonly [];
548
+ readonly method: "get";
549
+ readonly operationId: "mailboxListIdentities";
550
+ readonly path: "/mailbox/identities";
551
+ readonly pathParams: readonly [];
552
+ readonly queryParams: readonly [{
553
+ readonly name: "cursor";
554
+ readonly required: false;
555
+ }, {
556
+ readonly name: "limit";
557
+ readonly required: false;
558
+ }];
559
+ readonly requestBodyRequired: false;
560
+ readonly requiredKeyKind: "mailbox";
561
+ readonly surface: "mailbox";
562
+ };
563
+ readonly mailboxListMessages: {
564
+ readonly command: "mailbox:messages:list";
565
+ readonly description: "List mailbox messages";
566
+ readonly headerParams: readonly [];
567
+ readonly method: "get";
568
+ readonly operationId: "mailboxListMessages";
569
+ readonly path: "/mailbox/messages";
570
+ readonly pathParams: readonly [];
571
+ readonly queryParams: readonly [{
572
+ readonly name: "cursor";
573
+ readonly required: false;
574
+ }, {
575
+ readonly name: "limit";
576
+ readonly required: false;
577
+ }, {
578
+ readonly name: "folder_id";
579
+ readonly required: false;
580
+ }, {
581
+ readonly name: "thread_id";
582
+ readonly required: false;
583
+ }, {
584
+ readonly name: "q";
585
+ readonly required: false;
586
+ }, {
587
+ readonly name: "from";
588
+ readonly required: false;
589
+ }, {
590
+ readonly name: "to";
591
+ readonly required: false;
592
+ }, {
593
+ readonly name: "cc";
594
+ readonly required: false;
595
+ }, {
596
+ readonly name: "bcc";
597
+ readonly required: false;
598
+ }, {
599
+ readonly name: "subject";
600
+ readonly required: false;
601
+ }, {
602
+ readonly name: "body";
603
+ readonly required: false;
604
+ }, {
605
+ readonly name: "header_name";
606
+ readonly required: false;
607
+ }, {
608
+ readonly name: "header_value";
609
+ readonly required: false;
610
+ }, {
611
+ readonly name: "min_size_bytes";
612
+ readonly required: false;
613
+ }, {
614
+ readonly name: "max_size_bytes";
615
+ readonly required: false;
616
+ }, {
617
+ readonly name: "keyword";
618
+ readonly required: false;
619
+ }, {
620
+ readonly name: "not_keyword";
621
+ readonly required: false;
622
+ }, {
623
+ readonly name: "after";
624
+ readonly required: false;
625
+ }, {
626
+ readonly name: "before";
627
+ readonly required: false;
628
+ }, {
629
+ readonly name: "has_attachment";
630
+ readonly required: false;
631
+ }, {
632
+ readonly name: "is_unread";
633
+ readonly required: false;
634
+ }, {
635
+ readonly name: "sort_by";
636
+ readonly required: false;
637
+ }, {
638
+ readonly name: "sort_direction";
639
+ readonly required: false;
640
+ }];
641
+ readonly requestBodyRequired: false;
642
+ readonly requiredKeyKind: "mailbox";
643
+ readonly surface: "mailbox";
644
+ };
645
+ readonly mailboxListQuotas: {
646
+ readonly command: "mailbox:list-quotas";
647
+ readonly description: "List mailbox quotas";
648
+ readonly headerParams: readonly [];
649
+ readonly method: "get";
650
+ readonly operationId: "mailboxListQuotas";
651
+ readonly path: "/mailbox/quotas";
652
+ readonly pathParams: readonly [];
653
+ readonly queryParams: readonly [{
654
+ readonly name: "cursor";
655
+ readonly required: false;
656
+ }, {
657
+ readonly name: "limit";
658
+ readonly required: false;
659
+ }, {
660
+ readonly name: "name";
661
+ readonly required: false;
662
+ }, {
663
+ readonly name: "scope";
664
+ readonly required: false;
665
+ }, {
666
+ readonly name: "resource_type";
667
+ readonly required: false;
668
+ }, {
669
+ readonly name: "type";
670
+ readonly required: false;
671
+ }, {
672
+ readonly name: "sort_by";
673
+ readonly required: false;
674
+ }, {
675
+ readonly name: "sort_direction";
676
+ readonly required: false;
677
+ }];
678
+ readonly requestBodyRequired: false;
679
+ readonly requiredKeyKind: "mailbox";
680
+ readonly surface: "mailbox";
681
+ };
682
+ readonly mailboxListSubmissions: {
683
+ readonly command: "mailbox:list-submissions";
684
+ readonly description: "List mailbox submissions";
685
+ readonly headerParams: readonly [];
686
+ readonly method: "get";
687
+ readonly operationId: "mailboxListSubmissions";
688
+ readonly path: "/mailbox/submissions";
689
+ readonly pathParams: readonly [];
690
+ readonly queryParams: readonly [{
691
+ readonly name: "cursor";
692
+ readonly required: false;
693
+ }, {
694
+ readonly name: "limit";
695
+ readonly required: false;
696
+ }, {
697
+ readonly name: "identity_ids";
698
+ readonly required: false;
699
+ }, {
700
+ readonly name: "email_ids";
701
+ readonly required: false;
702
+ }, {
703
+ readonly name: "thread_ids";
704
+ readonly required: false;
705
+ }, {
706
+ readonly name: "undo_status";
707
+ readonly required: false;
708
+ }, {
709
+ readonly name: "after";
710
+ readonly required: false;
711
+ }, {
712
+ readonly name: "before";
713
+ readonly required: false;
714
+ }, {
715
+ readonly name: "sort_by";
716
+ readonly required: false;
717
+ }, {
718
+ readonly name: "sort_direction";
719
+ readonly required: false;
720
+ }];
721
+ readonly requestBodyRequired: false;
722
+ readonly requiredKeyKind: "mailbox";
723
+ readonly surface: "mailbox";
724
+ };
725
+ readonly mailboxListThreadMessages: {
726
+ readonly command: "mailbox:list-thread-messages";
727
+ readonly description: "List thread messages";
728
+ readonly headerParams: readonly [];
729
+ readonly method: "get";
730
+ readonly operationId: "mailboxListThreadMessages";
731
+ readonly path: "/mailbox/threads/{thread_id}/messages";
732
+ readonly pathParams: readonly [{
733
+ readonly name: "thread_id";
734
+ readonly required: true;
735
+ }];
736
+ readonly queryParams: readonly [{
737
+ readonly name: "cursor";
738
+ readonly required: false;
739
+ }, {
740
+ readonly name: "limit";
741
+ readonly required: false;
742
+ }, {
743
+ readonly name: "sort";
744
+ readonly required: false;
745
+ }];
746
+ readonly requestBodyRequired: false;
747
+ readonly requiredKeyKind: "mailbox";
748
+ readonly surface: "mailbox";
749
+ };
750
+ readonly mailboxListThreads: {
751
+ readonly command: "mailbox:list-threads";
752
+ readonly description: "List mailbox threads";
753
+ readonly headerParams: readonly [];
754
+ readonly method: "get";
755
+ readonly operationId: "mailboxListThreads";
756
+ readonly path: "/mailbox/threads";
757
+ readonly pathParams: readonly [];
758
+ readonly queryParams: readonly [{
759
+ readonly name: "cursor";
760
+ readonly required: false;
761
+ }, {
762
+ readonly name: "limit";
763
+ readonly required: false;
764
+ }, {
765
+ readonly name: "q";
766
+ readonly required: false;
767
+ }, {
768
+ readonly name: "participant";
769
+ readonly required: false;
770
+ }, {
771
+ readonly name: "folder_id";
772
+ readonly required: false;
773
+ }, {
774
+ readonly name: "after";
775
+ readonly required: false;
776
+ }, {
777
+ readonly name: "before";
778
+ readonly required: false;
779
+ }, {
780
+ readonly name: "has_attachment";
781
+ readonly required: false;
782
+ }, {
783
+ readonly name: "is_unread";
784
+ readonly required: false;
785
+ }, {
786
+ readonly name: "sort_direction";
787
+ readonly required: false;
788
+ }];
789
+ readonly requestBodyRequired: false;
790
+ readonly requiredKeyKind: "mailbox";
791
+ readonly surface: "mailbox";
792
+ };
793
+ readonly mailboxListUsage: {
794
+ readonly command: "mailbox:list-usage";
795
+ readonly description: "Get mailbox usage";
796
+ readonly headerParams: readonly [{
797
+ readonly name: "If-None-Match";
798
+ readonly required: false;
799
+ }];
800
+ readonly method: "get";
801
+ readonly operationId: "mailboxListUsage";
802
+ readonly path: "/mailbox/usage";
803
+ readonly pathParams: readonly [];
804
+ readonly queryParams: readonly [];
805
+ readonly requestBodyRequired: false;
806
+ readonly requiredKeyKind: "mailbox";
807
+ readonly surface: "mailbox";
808
+ };
809
+ readonly mailboxQueryFolderChanges: {
810
+ readonly command: "mailbox:query-folder-changes";
811
+ readonly description: "Get folder query changes";
812
+ readonly headerParams: readonly [];
813
+ readonly method: "get";
814
+ readonly operationId: "mailboxQueryFolderChanges";
815
+ readonly path: "/mailbox/folders/query-changes";
816
+ readonly pathParams: readonly [];
817
+ readonly queryParams: readonly [{
818
+ readonly name: "since_query_state";
819
+ readonly required: false;
820
+ }, {
821
+ readonly name: "limit";
822
+ readonly required: false;
823
+ }];
824
+ readonly requestBodyRequired: false;
825
+ readonly requiredKeyKind: "mailbox";
826
+ readonly surface: "mailbox";
827
+ };
828
+ readonly mailboxQueryMessageChanges: {
829
+ readonly command: "mailbox:query-message-changes";
830
+ readonly description: "Get message query changes";
831
+ readonly headerParams: readonly [];
832
+ readonly method: "get";
833
+ readonly operationId: "mailboxQueryMessageChanges";
834
+ readonly path: "/mailbox/messages/query-changes";
835
+ readonly pathParams: readonly [];
836
+ readonly queryParams: readonly [{
837
+ readonly name: "since_query_state";
838
+ readonly required: false;
839
+ }, {
840
+ readonly name: "limit";
841
+ readonly required: false;
842
+ }, {
843
+ readonly name: "up_to_id";
844
+ readonly required: false;
845
+ }, {
846
+ readonly name: "calculate_total";
847
+ readonly required: false;
848
+ }, {
849
+ readonly name: "folder_id";
850
+ readonly required: false;
851
+ }, {
852
+ readonly name: "q";
853
+ readonly required: false;
854
+ }, {
855
+ readonly name: "from";
856
+ readonly required: false;
857
+ }, {
858
+ readonly name: "to";
859
+ readonly required: false;
860
+ }, {
861
+ readonly name: "cc";
862
+ readonly required: false;
863
+ }, {
864
+ readonly name: "bcc";
865
+ readonly required: false;
866
+ }, {
867
+ readonly name: "subject";
868
+ readonly required: false;
869
+ }, {
870
+ readonly name: "body";
871
+ readonly required: false;
872
+ }, {
873
+ readonly name: "header_name";
874
+ readonly required: false;
875
+ }, {
876
+ readonly name: "header_value";
877
+ readonly required: false;
878
+ }, {
879
+ readonly name: "min_size_bytes";
880
+ readonly required: false;
881
+ }, {
882
+ readonly name: "max_size_bytes";
883
+ readonly required: false;
884
+ }, {
885
+ readonly name: "keyword";
886
+ readonly required: false;
887
+ }, {
888
+ readonly name: "not_keyword";
889
+ readonly required: false;
890
+ }, {
891
+ readonly name: "after";
892
+ readonly required: false;
893
+ }, {
894
+ readonly name: "before";
895
+ readonly required: false;
896
+ }, {
897
+ readonly name: "has_attachment";
898
+ readonly required: false;
899
+ }, {
900
+ readonly name: "is_unread";
901
+ readonly required: false;
902
+ }, {
903
+ readonly name: "sort_by";
904
+ readonly required: false;
905
+ }, {
906
+ readonly name: "sort_direction";
907
+ readonly required: false;
908
+ }];
909
+ readonly requestBodyRequired: false;
910
+ readonly requiredKeyKind: "mailbox";
911
+ readonly surface: "mailbox";
912
+ };
913
+ readonly mailboxSearchMessageSnippets: {
914
+ readonly command: "mailbox:search-message-snippets";
915
+ readonly description: "Get message search snippets";
916
+ readonly headerParams: readonly [];
917
+ readonly method: "get";
918
+ readonly operationId: "mailboxSearchMessageSnippets";
919
+ readonly path: "/mailbox/messages/search-snippets";
920
+ readonly pathParams: readonly [];
921
+ readonly queryParams: readonly [{
922
+ readonly name: "folder_id";
923
+ readonly required: false;
924
+ }, {
925
+ readonly name: "from";
926
+ readonly required: false;
927
+ }, {
928
+ readonly name: "to";
929
+ readonly required: false;
930
+ }, {
931
+ readonly name: "cc";
932
+ readonly required: false;
933
+ }, {
934
+ readonly name: "bcc";
935
+ readonly required: false;
936
+ }, {
937
+ readonly name: "subject";
938
+ readonly required: false;
939
+ }, {
940
+ readonly name: "body";
941
+ readonly required: false;
942
+ }, {
943
+ readonly name: "header_name";
944
+ readonly required: false;
945
+ }, {
946
+ readonly name: "header_value";
947
+ readonly required: false;
948
+ }, {
949
+ readonly name: "min_size_bytes";
950
+ readonly required: false;
951
+ }, {
952
+ readonly name: "max_size_bytes";
953
+ readonly required: false;
954
+ }, {
955
+ readonly name: "keyword";
956
+ readonly required: false;
957
+ }, {
958
+ readonly name: "not_keyword";
959
+ readonly required: false;
960
+ }, {
961
+ readonly name: "after";
962
+ readonly required: false;
963
+ }, {
964
+ readonly name: "before";
965
+ readonly required: false;
966
+ }, {
967
+ readonly name: "has_attachment";
968
+ readonly required: false;
969
+ }, {
970
+ readonly name: "is_unread";
971
+ readonly required: false;
972
+ }, {
973
+ readonly name: "q";
974
+ readonly required: true;
975
+ }, {
976
+ readonly name: "message_ids";
977
+ readonly required: false;
978
+ }, {
979
+ readonly name: "limit";
980
+ readonly required: false;
981
+ }];
982
+ readonly requestBodyRequired: false;
983
+ readonly requiredKeyKind: "mailbox";
984
+ readonly surface: "mailbox";
985
+ };
986
+ readonly mailboxSendMessage: {
987
+ readonly command: "mailbox:send-message";
988
+ readonly description: "Send a mailbox message";
989
+ readonly headerParams: readonly [{
990
+ readonly name: "Idempotency-Key";
991
+ readonly required: false;
992
+ }];
993
+ readonly method: "post";
994
+ readonly operationId: "mailboxSendMessage";
995
+ readonly path: "/mailbox/messages/send";
996
+ readonly pathParams: readonly [];
997
+ readonly queryParams: readonly [];
998
+ readonly requestBodyRequired: false;
999
+ readonly requiredKeyKind: "mailbox";
1000
+ readonly surface: "mailbox";
1001
+ };
1002
+ readonly mailboxStreamEvents: {
1003
+ readonly command: "mailbox:stream-events";
1004
+ readonly description: "Stream mailbox events";
1005
+ readonly headerParams: readonly [{
1006
+ readonly name: "Last-Event-ID";
1007
+ readonly required: false;
1008
+ }];
1009
+ readonly method: "get";
1010
+ readonly operationId: "mailboxStreamEvents";
1011
+ readonly path: "/mailbox/events";
1012
+ readonly pathParams: readonly [];
1013
+ readonly queryParams: readonly [{
1014
+ readonly name: "event_types";
1015
+ readonly required: false;
1016
+ }, {
1017
+ readonly name: "last_event_id";
1018
+ readonly required: false;
1019
+ }, {
1020
+ readonly name: "ping";
1021
+ readonly required: false;
1022
+ }, {
1023
+ readonly name: "close_after";
1024
+ readonly required: false;
1025
+ }];
1026
+ readonly requestBodyRequired: false;
1027
+ readonly requiredKeyKind: "mailbox";
1028
+ readonly surface: "mailbox";
1029
+ };
1030
+ readonly mailboxUpdateFolder: {
1031
+ readonly command: "mailbox:update-folder";
1032
+ readonly description: "Update a mailbox folder";
1033
+ readonly headerParams: readonly [{
1034
+ readonly name: "If-Match";
1035
+ readonly required: false;
1036
+ }];
1037
+ readonly method: "patch";
1038
+ readonly operationId: "mailboxUpdateFolder";
1039
+ readonly path: "/mailbox/folders/{folder_id}";
1040
+ readonly pathParams: readonly [{
1041
+ readonly name: "folder_id";
1042
+ readonly required: true;
1043
+ }];
1044
+ readonly queryParams: readonly [];
1045
+ readonly requestBodyRequired: false;
1046
+ readonly requiredKeyKind: "mailbox";
1047
+ readonly surface: "mailbox";
1048
+ };
1049
+ readonly mailboxUpdateIdentity: {
1050
+ readonly command: "mailbox:update-identity";
1051
+ readonly description: "Update mailbox sender identity";
1052
+ readonly headerParams: readonly [];
1053
+ readonly method: "patch";
1054
+ readonly operationId: "mailboxUpdateIdentity";
1055
+ readonly path: "/mailbox/identity";
1056
+ readonly pathParams: readonly [];
1057
+ readonly queryParams: readonly [];
1058
+ readonly requestBodyRequired: false;
1059
+ readonly requiredKeyKind: "mailbox";
1060
+ readonly surface: "mailbox";
1061
+ };
1062
+ readonly mailboxUpdateMessage: {
1063
+ readonly command: "mailbox:update-message";
1064
+ readonly description: "Update mailbox message flags";
1065
+ readonly headerParams: readonly [{
1066
+ readonly name: "If-Match";
1067
+ readonly required: false;
1068
+ }];
1069
+ readonly method: "patch";
1070
+ readonly operationId: "mailboxUpdateMessage";
1071
+ readonly path: "/mailbox/messages/{message_id}";
1072
+ readonly pathParams: readonly [{
1073
+ readonly name: "message_id";
1074
+ readonly required: true;
1075
+ }];
1076
+ readonly queryParams: readonly [];
1077
+ readonly requestBodyRequired: false;
1078
+ readonly requiredKeyKind: "mailbox";
1079
+ readonly surface: "mailbox";
1080
+ };
1081
+ readonly mailboxUploadAttachment: {
1082
+ readonly command: "mailbox:upload-attachment";
1083
+ readonly description: "Upload a mailbox attachment";
1084
+ readonly headerParams: readonly [];
1085
+ readonly method: "post";
1086
+ readonly operationId: "mailboxUploadAttachment";
1087
+ readonly path: "/mailbox/attachments:upload";
1088
+ readonly pathParams: readonly [];
1089
+ readonly queryParams: readonly [{
1090
+ readonly name: "filename";
1091
+ readonly required: true;
1092
+ }];
1093
+ readonly requestBodyRequired: false;
1094
+ readonly requiredKeyKind: "mailbox";
1095
+ readonly surface: "mailbox";
1096
+ };
1097
+ readonly managementActivateProvider: {
1098
+ readonly command: "management:activate-provider";
1099
+ readonly description: "Activate a sending account";
1100
+ readonly headerParams: readonly [{
1101
+ readonly name: "Idempotency-Key";
1102
+ readonly required: false;
1103
+ }];
1104
+ readonly method: "post";
1105
+ readonly operationId: "managementActivateProvider";
1106
+ readonly path: "/providers/{public_id}/activate";
1107
+ readonly pathParams: readonly [{
1108
+ readonly name: "public_id";
1109
+ readonly required: true;
1110
+ }];
1111
+ readonly queryParams: readonly [];
1112
+ readonly requestBodyRequired: false;
1113
+ readonly requiredKeyKind: "root";
1114
+ readonly surface: "management";
1115
+ };
1116
+ readonly managementCreateDomain: {
1117
+ readonly command: "management:create-domain";
1118
+ readonly description: "Add a mailbox domain";
1119
+ readonly headerParams: readonly [{
1120
+ readonly name: "Idempotency-Key";
1121
+ readonly required: false;
1122
+ }];
1123
+ readonly method: "post";
1124
+ readonly operationId: "managementCreateDomain";
1125
+ readonly path: "/domains";
1126
+ readonly pathParams: readonly [];
1127
+ readonly queryParams: readonly [];
1128
+ readonly requestBodyRequired: false;
1129
+ readonly requiredKeyKind: "root";
1130
+ readonly surface: "management";
1131
+ };
1132
+ readonly managementCreateMailbox: {
1133
+ readonly command: "management:create-mailbox";
1134
+ readonly description: "Create a mailbox";
1135
+ readonly headerParams: readonly [{
1136
+ readonly name: "Idempotency-Key";
1137
+ readonly required: false;
1138
+ }];
1139
+ readonly method: "post";
1140
+ readonly operationId: "managementCreateMailbox";
1141
+ readonly path: "/mailboxes";
1142
+ readonly pathParams: readonly [];
1143
+ readonly queryParams: readonly [];
1144
+ readonly requestBodyRequired: false;
1145
+ readonly requiredKeyKind: "root";
1146
+ readonly surface: "management";
1147
+ };
1148
+ readonly managementCreateMailboxKey: {
1149
+ readonly command: "management:create-mailbox-key";
1150
+ readonly description: "Create a mailbox API key";
1151
+ readonly headerParams: readonly [{
1152
+ readonly name: "Idempotency-Key";
1153
+ readonly required: false;
1154
+ }];
1155
+ readonly method: "post";
1156
+ readonly operationId: "managementCreateMailboxKey";
1157
+ readonly path: "/mailboxes/{public_id}/keys";
1158
+ readonly pathParams: readonly [{
1159
+ readonly name: "public_id";
1160
+ readonly required: true;
1161
+ }];
1162
+ readonly queryParams: readonly [];
1163
+ readonly requestBodyRequired: false;
1164
+ readonly requiredKeyKind: "root";
1165
+ readonly surface: "management";
1166
+ };
1167
+ readonly managementCreateProvider: {
1168
+ readonly command: "management:create-provider";
1169
+ readonly description: "Create an SMTP sending account";
1170
+ readonly headerParams: readonly [{
1171
+ readonly name: "Idempotency-Key";
1172
+ readonly required: false;
1173
+ }];
1174
+ readonly method: "post";
1175
+ readonly operationId: "managementCreateProvider";
1176
+ readonly path: "/providers";
1177
+ readonly pathParams: readonly [];
1178
+ readonly queryParams: readonly [];
1179
+ readonly requestBodyRequired: false;
1180
+ readonly requiredKeyKind: "root";
1181
+ readonly surface: "management";
1182
+ };
1183
+ readonly managementCreateSharedAmazonSesLimitRequest: {
1184
+ readonly command: "management:create-shared-amazon-ses-limit-request";
1185
+ readonly description: "Request a shared Amazon SES daily limit increase";
1186
+ readonly headerParams: readonly [{
1187
+ readonly name: "Idempotency-Key";
1188
+ readonly required: false;
1189
+ }];
1190
+ readonly method: "post";
1191
+ readonly operationId: "managementCreateSharedAmazonSesLimitRequest";
1192
+ readonly path: "/providers/shared-amazon-ses-limit-request";
1193
+ readonly pathParams: readonly [];
1194
+ readonly queryParams: readonly [];
1195
+ readonly requestBodyRequired: false;
1196
+ readonly requiredKeyKind: "root";
1197
+ readonly surface: "management";
1198
+ };
1199
+ readonly managementCreateWebhook: {
1200
+ readonly command: "management:create-webhook";
1201
+ readonly description: "Create a webhook subscription";
1202
+ readonly headerParams: readonly [{
1203
+ readonly name: "Idempotency-Key";
1204
+ readonly required: false;
1205
+ }];
1206
+ readonly method: "post";
1207
+ readonly operationId: "managementCreateWebhook";
1208
+ readonly path: "/webhooks";
1209
+ readonly pathParams: readonly [];
1210
+ readonly queryParams: readonly [];
1211
+ readonly requestBodyRequired: false;
1212
+ readonly requiredKeyKind: "root";
1213
+ readonly surface: "management";
1214
+ };
1215
+ readonly managementDeactivateProvider: {
1216
+ readonly command: "management:deactivate-provider";
1217
+ readonly description: "Deactivate a sending account";
1218
+ readonly headerParams: readonly [{
1219
+ readonly name: "Idempotency-Key";
1220
+ readonly required: false;
1221
+ }];
1222
+ readonly method: "post";
1223
+ readonly operationId: "managementDeactivateProvider";
1224
+ readonly path: "/providers/{public_id}/deactivate";
1225
+ readonly pathParams: readonly [{
1226
+ readonly name: "public_id";
1227
+ readonly required: true;
1228
+ }];
1229
+ readonly queryParams: readonly [];
1230
+ readonly requestBodyRequired: false;
1231
+ readonly requiredKeyKind: "root";
1232
+ readonly surface: "management";
1233
+ };
1234
+ readonly managementDeleteDomain: {
1235
+ readonly command: "management:delete-domain";
1236
+ readonly description: "Delete a mailbox domain";
1237
+ readonly headerParams: readonly [];
1238
+ readonly method: "delete";
1239
+ readonly operationId: "managementDeleteDomain";
1240
+ readonly path: "/domains/{public_id}";
1241
+ readonly pathParams: readonly [{
1242
+ readonly name: "public_id";
1243
+ readonly required: true;
1244
+ }];
1245
+ readonly queryParams: readonly [];
1246
+ readonly requestBodyRequired: false;
1247
+ readonly requiredKeyKind: "root";
1248
+ readonly surface: "management";
1249
+ };
1250
+ readonly managementDeleteMailbox: {
1251
+ readonly command: "management:delete-mailbox";
1252
+ readonly description: "Delete a mailbox";
1253
+ readonly headerParams: readonly [];
1254
+ readonly method: "delete";
1255
+ readonly operationId: "managementDeleteMailbox";
1256
+ readonly path: "/mailboxes/{public_id}";
1257
+ readonly pathParams: readonly [{
1258
+ readonly name: "public_id";
1259
+ readonly required: true;
1260
+ }];
1261
+ readonly queryParams: readonly [];
1262
+ readonly requestBodyRequired: false;
1263
+ readonly requiredKeyKind: "root";
1264
+ readonly surface: "management";
1265
+ };
1266
+ readonly managementDeleteMailboxKey: {
1267
+ readonly command: "management:delete-mailbox-key";
1268
+ readonly description: "Revoke a mailbox API key";
1269
+ readonly headerParams: readonly [];
1270
+ readonly method: "delete";
1271
+ readonly operationId: "managementDeleteMailboxKey";
1272
+ readonly path: "/mailboxes/{public_id}/keys/{key_id}";
1273
+ readonly pathParams: readonly [{
1274
+ readonly name: "public_id";
1275
+ readonly required: true;
1276
+ }, {
1277
+ readonly name: "key_id";
1278
+ readonly required: true;
1279
+ }];
1280
+ readonly queryParams: readonly [];
1281
+ readonly requestBodyRequired: false;
1282
+ readonly requiredKeyKind: "root";
1283
+ readonly surface: "management";
1284
+ };
1285
+ readonly managementDeleteProvider: {
1286
+ readonly command: "management:delete-provider";
1287
+ readonly description: "Delete a sending account";
1288
+ readonly headerParams: readonly [];
1289
+ readonly method: "delete";
1290
+ readonly operationId: "managementDeleteProvider";
1291
+ readonly path: "/providers/{public_id}";
1292
+ readonly pathParams: readonly [{
1293
+ readonly name: "public_id";
1294
+ readonly required: true;
1295
+ }];
1296
+ readonly queryParams: readonly [];
1297
+ readonly requestBodyRequired: false;
1298
+ readonly requiredKeyKind: "root";
1299
+ readonly surface: "management";
1300
+ };
1301
+ readonly managementDeleteWebhook: {
1302
+ readonly command: "management:delete-webhook";
1303
+ readonly description: "Delete a webhook subscription";
1304
+ readonly headerParams: readonly [];
1305
+ readonly method: "delete";
1306
+ readonly operationId: "managementDeleteWebhook";
1307
+ readonly path: "/webhooks/{public_id}";
1308
+ readonly pathParams: readonly [{
1309
+ readonly name: "public_id";
1310
+ readonly required: true;
1311
+ }];
1312
+ readonly queryParams: readonly [];
1313
+ readonly requestBodyRequired: false;
1314
+ readonly requiredKeyKind: "root";
1315
+ readonly surface: "management";
1316
+ };
1317
+ readonly managementGetDeliveryPayload: {
1318
+ readonly command: "management:get-delivery-payload";
1319
+ readonly description: "Get a webhook delivery payload";
1320
+ readonly headerParams: readonly [];
1321
+ readonly method: "get";
1322
+ readonly operationId: "managementGetDeliveryPayload";
1323
+ readonly path: "/webhooks/{public_id}/deliveries/{delivery_id}/payload";
1324
+ readonly pathParams: readonly [{
1325
+ readonly name: "public_id";
1326
+ readonly required: true;
1327
+ }, {
1328
+ readonly name: "delivery_id";
1329
+ readonly required: true;
1330
+ }];
1331
+ readonly queryParams: readonly [];
1332
+ readonly requestBodyRequired: false;
1333
+ readonly requiredKeyKind: "root";
1334
+ readonly surface: "management";
1335
+ };
1336
+ readonly managementGetDomain: {
1337
+ readonly command: "management:domains:get";
1338
+ readonly description: "Get a mailbox domain";
1339
+ readonly headerParams: readonly [{
1340
+ readonly name: "If-None-Match";
1341
+ readonly required: false;
1342
+ }];
1343
+ readonly method: "get";
1344
+ readonly operationId: "managementGetDomain";
1345
+ readonly path: "/domains/{public_id}";
1346
+ readonly pathParams: readonly [{
1347
+ readonly name: "public_id";
1348
+ readonly required: true;
1349
+ }];
1350
+ readonly queryParams: readonly [];
1351
+ readonly requestBodyRequired: false;
1352
+ readonly requiredKeyKind: "root";
1353
+ readonly surface: "management";
1354
+ };
1355
+ readonly managementGetDomainFilters: {
1356
+ readonly command: "management:get-domain-filters";
1357
+ readonly description: "Get domain-wide sender filters";
1358
+ readonly headerParams: readonly [{
1359
+ readonly name: "If-None-Match";
1360
+ readonly required: false;
1361
+ }];
1362
+ readonly method: "get";
1363
+ readonly operationId: "managementGetDomainFilters";
1364
+ readonly path: "/domains/{public_id}/filters";
1365
+ readonly pathParams: readonly [{
1366
+ readonly name: "public_id";
1367
+ readonly required: true;
1368
+ }];
1369
+ readonly queryParams: readonly [];
1370
+ readonly requestBodyRequired: false;
1371
+ readonly requiredKeyKind: "root";
1372
+ readonly surface: "management";
1373
+ };
1374
+ readonly managementGetDomainZoneFile: {
1375
+ readonly command: "management:get-domain-zone-file";
1376
+ readonly description: "Download a domain as a zone file";
1377
+ readonly headerParams: readonly [];
1378
+ readonly method: "get";
1379
+ readonly operationId: "managementGetDomainZoneFile";
1380
+ readonly path: "/domains/{public_id}/zone-file";
1381
+ readonly pathParams: readonly [{
1382
+ readonly name: "public_id";
1383
+ readonly required: true;
1384
+ }];
1385
+ readonly queryParams: readonly [];
1386
+ readonly requestBodyRequired: false;
1387
+ readonly requiredKeyKind: "root";
1388
+ readonly surface: "management";
1389
+ };
1390
+ readonly managementGetEmailLog: {
1391
+ readonly command: "management:get-email-log";
1392
+ readonly description: "Get delivery log";
1393
+ readonly headerParams: readonly [{
1394
+ readonly name: "If-None-Match";
1395
+ readonly required: false;
1396
+ }];
1397
+ readonly method: "get";
1398
+ readonly operationId: "managementGetEmailLog";
1399
+ readonly path: "/emails/logs/{public_id}";
1400
+ readonly pathParams: readonly [{
1401
+ readonly name: "public_id";
1402
+ readonly required: true;
1403
+ }];
1404
+ readonly queryParams: readonly [];
1405
+ readonly requestBodyRequired: false;
1406
+ readonly requiredKeyKind: "root";
1407
+ readonly surface: "management";
1408
+ };
1409
+ readonly managementGetEmailMetrics: {
1410
+ readonly command: "management:get-email-metrics";
1411
+ readonly description: "Get email metrics";
1412
+ readonly headerParams: readonly [];
1413
+ readonly method: "get";
1414
+ readonly operationId: "managementGetEmailMetrics";
1415
+ readonly path: "/emails/metrics";
1416
+ readonly pathParams: readonly [];
1417
+ readonly queryParams: readonly [{
1418
+ readonly name: "window";
1419
+ readonly required: false;
1420
+ }, {
1421
+ readonly name: "from_date";
1422
+ readonly required: false;
1423
+ }, {
1424
+ readonly name: "to_date";
1425
+ readonly required: false;
1426
+ }, {
1427
+ readonly name: "granularity";
1428
+ readonly required: false;
1429
+ }, {
1430
+ readonly name: "provider_id";
1431
+ readonly required: false;
1432
+ }];
1433
+ readonly requestBodyRequired: false;
1434
+ readonly requiredKeyKind: "root";
1435
+ readonly surface: "management";
1436
+ };
1437
+ readonly managementGetInboxLog: {
1438
+ readonly command: "management:get-inbox-log";
1439
+ readonly description: "Get incoming log";
1440
+ readonly headerParams: readonly [];
1441
+ readonly method: "get";
1442
+ readonly operationId: "managementGetInboxLog";
1443
+ readonly path: "/inboxes/logs/{public_id}";
1444
+ readonly pathParams: readonly [{
1445
+ readonly name: "public_id";
1446
+ readonly required: true;
1447
+ }];
1448
+ readonly queryParams: readonly [];
1449
+ readonly requestBodyRequired: false;
1450
+ readonly requiredKeyKind: "root";
1451
+ readonly surface: "management";
1452
+ };
1453
+ readonly managementGetMailbox: {
1454
+ readonly command: "management:get-mailbox";
1455
+ readonly description: "Get a mailbox";
1456
+ readonly headerParams: readonly [{
1457
+ readonly name: "If-None-Match";
1458
+ readonly required: false;
1459
+ }];
1460
+ readonly method: "get";
1461
+ readonly operationId: "managementGetMailbox";
1462
+ readonly path: "/mailboxes/{public_id}";
1463
+ readonly pathParams: readonly [{
1464
+ readonly name: "public_id";
1465
+ readonly required: true;
1466
+ }];
1467
+ readonly queryParams: readonly [];
1468
+ readonly requestBodyRequired: false;
1469
+ readonly requiredKeyKind: "root";
1470
+ readonly surface: "management";
1471
+ };
1472
+ readonly managementGetMailboxFilters: {
1473
+ readonly command: "management:get-mailbox-filters";
1474
+ readonly description: "Get mailbox sender filters";
1475
+ readonly headerParams: readonly [{
1476
+ readonly name: "If-None-Match";
1477
+ readonly required: false;
1478
+ }];
1479
+ readonly method: "get";
1480
+ readonly operationId: "managementGetMailboxFilters";
1481
+ readonly path: "/mailboxes/{public_id}/filters";
1482
+ readonly pathParams: readonly [{
1483
+ readonly name: "public_id";
1484
+ readonly required: true;
1485
+ }];
1486
+ readonly queryParams: readonly [];
1487
+ readonly requestBodyRequired: false;
1488
+ readonly requiredKeyKind: "root";
1489
+ readonly surface: "management";
1490
+ };
1491
+ readonly managementGetProvider: {
1492
+ readonly command: "management:get-provider";
1493
+ readonly description: "Get a sending account";
1494
+ readonly headerParams: readonly [{
1495
+ readonly name: "If-None-Match";
1496
+ readonly required: false;
1497
+ }];
1498
+ readonly method: "get";
1499
+ readonly operationId: "managementGetProvider";
1500
+ readonly path: "/providers/{public_id}";
1501
+ readonly pathParams: readonly [{
1502
+ readonly name: "public_id";
1503
+ readonly required: true;
1504
+ }];
1505
+ readonly queryParams: readonly [];
1506
+ readonly requestBodyRequired: false;
1507
+ readonly requiredKeyKind: "root";
1508
+ readonly surface: "management";
1509
+ };
1510
+ readonly managementGetProviderLimits: {
1511
+ readonly command: "management:get-provider-limits";
1512
+ readonly description: "Get sending account limits";
1513
+ readonly headerParams: readonly [];
1514
+ readonly method: "get";
1515
+ readonly operationId: "managementGetProviderLimits";
1516
+ readonly path: "/providers/limits";
1517
+ readonly pathParams: readonly [];
1518
+ readonly queryParams: readonly [];
1519
+ readonly requestBodyRequired: false;
1520
+ readonly requiredKeyKind: "root";
1521
+ readonly surface: "management";
1522
+ };
1523
+ readonly managementGetProviderStats: {
1524
+ readonly command: "management:get-provider-stats";
1525
+ readonly description: "Get sending account statistics";
1526
+ readonly headerParams: readonly [];
1527
+ readonly method: "get";
1528
+ readonly operationId: "managementGetProviderStats";
1529
+ readonly path: "/providers/stats";
1530
+ readonly pathParams: readonly [];
1531
+ readonly queryParams: readonly [];
1532
+ readonly requestBodyRequired: false;
1533
+ readonly requiredKeyKind: "root";
1534
+ readonly surface: "management";
1535
+ };
1536
+ readonly managementGetProviderUsage: {
1537
+ readonly command: "management:get-provider-usage";
1538
+ readonly description: "Get sending account usage";
1539
+ readonly headerParams: readonly [];
1540
+ readonly method: "get";
1541
+ readonly operationId: "managementGetProviderUsage";
1542
+ readonly path: "/providers/usage";
1543
+ readonly pathParams: readonly [];
1544
+ readonly queryParams: readonly [];
1545
+ readonly requestBodyRequired: false;
1546
+ readonly requiredKeyKind: "root";
1547
+ readonly surface: "management";
1548
+ };
1549
+ readonly managementGetSharedAmazonSesLimitRequest: {
1550
+ readonly command: "management:get-shared-amazon-ses-limit-request";
1551
+ readonly description: "Get shared Amazon SES limit request state";
1552
+ readonly headerParams: readonly [];
1553
+ readonly method: "get";
1554
+ readonly operationId: "managementGetSharedAmazonSesLimitRequest";
1555
+ readonly path: "/providers/shared-amazon-ses-limit-request";
1556
+ readonly pathParams: readonly [];
1557
+ readonly queryParams: readonly [];
1558
+ readonly requestBodyRequired: false;
1559
+ readonly requiredKeyKind: "root";
1560
+ readonly surface: "management";
1561
+ };
1562
+ readonly managementGetSpendSummary: {
1563
+ readonly command: "management:get-spend-summary";
1564
+ readonly description: "Get spend summary";
1565
+ readonly headerParams: readonly [];
1566
+ readonly method: "get";
1567
+ readonly operationId: "managementGetSpendSummary";
1568
+ readonly path: "/billing/summary";
1569
+ readonly pathParams: readonly [];
1570
+ readonly queryParams: readonly [{
1571
+ readonly name: "days";
1572
+ readonly required: false;
1573
+ }];
1574
+ readonly requestBodyRequired: false;
1575
+ readonly requiredKeyKind: "root";
1576
+ readonly surface: "management";
1577
+ };
1578
+ readonly managementGetWebhook: {
1579
+ readonly command: "management:get-webhook";
1580
+ readonly description: "Get a webhook subscription";
1581
+ readonly headerParams: readonly [{
1582
+ readonly name: "If-None-Match";
1583
+ readonly required: false;
1584
+ }];
1585
+ readonly method: "get";
1586
+ readonly operationId: "managementGetWebhook";
1587
+ readonly path: "/webhooks/{public_id}";
1588
+ readonly pathParams: readonly [{
1589
+ readonly name: "public_id";
1590
+ readonly required: true;
1591
+ }];
1592
+ readonly queryParams: readonly [];
1593
+ readonly requestBodyRequired: false;
1594
+ readonly requiredKeyKind: "root";
1595
+ readonly surface: "management";
1596
+ };
1597
+ readonly managementListBalance: {
1598
+ readonly command: "management:list-balance";
1599
+ readonly description: "Get current balance";
1600
+ readonly headerParams: readonly [];
1601
+ readonly method: "get";
1602
+ readonly operationId: "managementListBalance";
1603
+ readonly path: "/billing/balance";
1604
+ readonly pathParams: readonly [];
1605
+ readonly queryParams: readonly [];
1606
+ readonly requestBodyRequired: false;
1607
+ readonly requiredKeyKind: "root";
1608
+ readonly surface: "management";
1609
+ };
1610
+ readonly managementListDelivery: {
1611
+ readonly command: "management:list-delivery";
1612
+ readonly description: "List webhook delivery attempts";
1613
+ readonly headerParams: readonly [];
1614
+ readonly method: "get";
1615
+ readonly operationId: "managementListDelivery";
1616
+ readonly path: "/webhooks/{public_id}/deliveries";
1617
+ readonly pathParams: readonly [{
1618
+ readonly name: "public_id";
1619
+ readonly required: true;
1620
+ }];
1621
+ readonly queryParams: readonly [{
1622
+ readonly name: "cursor";
1623
+ readonly required: false;
1624
+ }, {
1625
+ readonly name: "limit";
1626
+ readonly required: false;
1627
+ }, {
1628
+ readonly name: "event_type";
1629
+ readonly required: false;
1630
+ }, {
1631
+ readonly name: "result";
1632
+ readonly required: false;
1633
+ }];
1634
+ readonly requestBodyRequired: false;
1635
+ readonly requiredKeyKind: "root";
1636
+ readonly surface: "management";
1637
+ };
1638
+ readonly managementListDomains: {
1639
+ readonly command: "management:domains:list";
1640
+ readonly description: "List mailbox domains";
1641
+ readonly headerParams: readonly [];
1642
+ readonly method: "get";
1643
+ readonly operationId: "managementListDomains";
1644
+ readonly path: "/domains";
1645
+ readonly pathParams: readonly [];
1646
+ readonly queryParams: readonly [{
1647
+ readonly name: "cursor";
1648
+ readonly required: false;
1649
+ }, {
1650
+ readonly name: "limit";
1651
+ readonly required: false;
1652
+ }];
1653
+ readonly requestBodyRequired: false;
1654
+ readonly requiredKeyKind: "root";
1655
+ readonly surface: "management";
1656
+ };
1657
+ readonly managementListEmailLogs: {
1658
+ readonly command: "management:list-email-logs";
1659
+ readonly description: "List delivery logs";
1660
+ readonly headerParams: readonly [];
1661
+ readonly method: "get";
1662
+ readonly operationId: "managementListEmailLogs";
1663
+ readonly path: "/emails/logs";
1664
+ readonly pathParams: readonly [];
1665
+ readonly queryParams: readonly [{
1666
+ readonly name: "limit";
1667
+ readonly required: false;
1668
+ }, {
1669
+ readonly name: "cursor";
1670
+ readonly required: false;
1671
+ }, {
1672
+ readonly name: "status";
1673
+ readonly required: false;
1674
+ }, {
1675
+ readonly name: "from_date";
1676
+ readonly required: false;
1677
+ }, {
1678
+ readonly name: "to_date";
1679
+ readonly required: false;
1680
+ }, {
1681
+ readonly name: "provider_id";
1682
+ readonly required: false;
1683
+ }, {
1684
+ readonly name: "search";
1685
+ readonly required: false;
1686
+ }];
1687
+ readonly requestBodyRequired: false;
1688
+ readonly requiredKeyKind: "root";
1689
+ readonly surface: "management";
1690
+ };
1691
+ readonly managementListInboxLogs: {
1692
+ readonly command: "management:list-inbox-logs";
1693
+ readonly description: "List incoming logs";
1694
+ readonly headerParams: readonly [];
1695
+ readonly method: "get";
1696
+ readonly operationId: "managementListInboxLogs";
1697
+ readonly path: "/inboxes/logs";
1698
+ readonly pathParams: readonly [];
1699
+ readonly queryParams: readonly [{
1700
+ readonly name: "limit";
1701
+ readonly required: false;
1702
+ }, {
1703
+ readonly name: "cursor";
1704
+ readonly required: false;
1705
+ }, {
1706
+ readonly name: "mailbox_id";
1707
+ readonly required: false;
1708
+ }, {
1709
+ readonly name: "event_type";
1710
+ readonly required: false;
1711
+ }, {
1712
+ readonly name: "from_date";
1713
+ readonly required: false;
1714
+ }, {
1715
+ readonly name: "to_date";
1716
+ readonly required: false;
1717
+ }, {
1718
+ readonly name: "search";
1719
+ readonly required: false;
1720
+ }];
1721
+ readonly requestBodyRequired: false;
1722
+ readonly requiredKeyKind: "root";
1723
+ readonly surface: "management";
1724
+ };
1725
+ readonly managementListMailboxes: {
1726
+ readonly command: "management:mailboxes:list";
1727
+ readonly description: "List mailboxes";
1728
+ readonly headerParams: readonly [];
1729
+ readonly method: "get";
1730
+ readonly operationId: "managementListMailboxes";
1731
+ readonly path: "/mailboxes";
1732
+ readonly pathParams: readonly [];
1733
+ readonly queryParams: readonly [{
1734
+ readonly name: "cursor";
1735
+ readonly required: false;
1736
+ }, {
1737
+ readonly name: "limit";
1738
+ readonly required: false;
1739
+ }, {
1740
+ readonly name: "include_deleted";
1741
+ readonly required: false;
1742
+ }];
1743
+ readonly requestBodyRequired: false;
1744
+ readonly requiredKeyKind: "root";
1745
+ readonly surface: "management";
1746
+ };
1747
+ readonly managementListProviders: {
1748
+ readonly command: "management:providers:list";
1749
+ readonly description: "List sending accounts";
1750
+ readonly headerParams: readonly [];
1751
+ readonly method: "get";
1752
+ readonly operationId: "managementListProviders";
1753
+ readonly path: "/providers";
1754
+ readonly pathParams: readonly [];
1755
+ readonly queryParams: readonly [{
1756
+ readonly name: "cursor";
1757
+ readonly required: false;
1758
+ }, {
1759
+ readonly name: "status";
1760
+ readonly required: false;
1761
+ }, {
1762
+ readonly name: "type";
1763
+ readonly required: false;
1764
+ }, {
1765
+ readonly name: "limit";
1766
+ readonly required: false;
1767
+ }];
1768
+ readonly requestBodyRequired: false;
1769
+ readonly requiredKeyKind: "root";
1770
+ readonly surface: "management";
1771
+ };
1772
+ readonly managementListTransactions: {
1773
+ readonly command: "management:list-transactions";
1774
+ readonly description: "List transactions";
1775
+ readonly headerParams: readonly [];
1776
+ readonly method: "get";
1777
+ readonly operationId: "managementListTransactions";
1778
+ readonly path: "/billing/transactions";
1779
+ readonly pathParams: readonly [];
1780
+ readonly queryParams: readonly [{
1781
+ readonly name: "cursor";
1782
+ readonly required: false;
1783
+ }, {
1784
+ readonly name: "limit";
1785
+ readonly required: false;
1786
+ }, {
1787
+ readonly name: "type";
1788
+ readonly required: false;
1789
+ }];
1790
+ readonly requestBodyRequired: false;
1791
+ readonly requiredKeyKind: "root";
1792
+ readonly surface: "management";
1793
+ };
1794
+ readonly managementListWebhooks: {
1795
+ readonly command: "management:list-webhooks";
1796
+ readonly description: "List webhook subscriptions";
1797
+ readonly headerParams: readonly [];
1798
+ readonly method: "get";
1799
+ readonly operationId: "managementListWebhooks";
1800
+ readonly path: "/webhooks";
1801
+ readonly pathParams: readonly [];
1802
+ readonly queryParams: readonly [{
1803
+ readonly name: "cursor";
1804
+ readonly required: false;
1805
+ }, {
1806
+ readonly name: "limit";
1807
+ readonly required: false;
1808
+ }];
1809
+ readonly requestBodyRequired: false;
1810
+ readonly requiredKeyKind: "root";
1811
+ readonly surface: "management";
1812
+ };
1813
+ readonly managementRequestSendingAccountLimitIncrease: {
1814
+ readonly command: "management:request-sending-account-limit-increase";
1815
+ readonly description: "Request a sending account limit increase";
1816
+ readonly headerParams: readonly [{
1817
+ readonly name: "Idempotency-Key";
1818
+ readonly required: false;
1819
+ }];
1820
+ readonly method: "post";
1821
+ readonly operationId: "managementRequestSendingAccountLimitIncrease";
1822
+ readonly path: "/providers/limits/sending-accounts/request-increase";
1823
+ readonly pathParams: readonly [];
1824
+ readonly queryParams: readonly [];
1825
+ readonly requestBodyRequired: false;
1826
+ readonly requiredKeyKind: "root";
1827
+ readonly surface: "management";
1828
+ };
1829
+ readonly managementResumeMailbox: {
1830
+ readonly command: "management:resume-mailbox";
1831
+ readonly description: "Resume a mailbox";
1832
+ readonly headerParams: readonly [{
1833
+ readonly name: "Idempotency-Key";
1834
+ readonly required: false;
1835
+ }];
1836
+ readonly method: "post";
1837
+ readonly operationId: "managementResumeMailbox";
1838
+ readonly path: "/mailboxes/{public_id}/resume";
1839
+ readonly pathParams: readonly [{
1840
+ readonly name: "public_id";
1841
+ readonly required: true;
1842
+ }];
1843
+ readonly queryParams: readonly [];
1844
+ readonly requestBodyRequired: false;
1845
+ readonly requiredKeyKind: "root";
1846
+ readonly surface: "management";
1847
+ };
1848
+ readonly managementRotateWebhookSecret: {
1849
+ readonly command: "management:rotate-webhook-secret";
1850
+ readonly description: "Rotate the signing secret";
1851
+ readonly headerParams: readonly [{
1852
+ readonly name: "Idempotency-Key";
1853
+ readonly required: false;
1854
+ }];
1855
+ readonly method: "post";
1856
+ readonly operationId: "managementRotateWebhookSecret";
1857
+ readonly path: "/webhooks/{public_id}/rotate-secret";
1858
+ readonly pathParams: readonly [{
1859
+ readonly name: "public_id";
1860
+ readonly required: true;
1861
+ }];
1862
+ readonly queryParams: readonly [];
1863
+ readonly requestBodyRequired: false;
1864
+ readonly requiredKeyKind: "root";
1865
+ readonly surface: "management";
1866
+ };
1867
+ readonly managementSetDomainFilters: {
1868
+ readonly command: "management:set-domain-filters";
1869
+ readonly description: "Replace domain-wide sender filters";
1870
+ readonly headerParams: readonly [{
1871
+ readonly name: "If-Match";
1872
+ readonly required: false;
1873
+ }];
1874
+ readonly method: "put";
1875
+ readonly operationId: "managementSetDomainFilters";
1876
+ readonly path: "/domains/{public_id}/filters";
1877
+ readonly pathParams: readonly [{
1878
+ readonly name: "public_id";
1879
+ readonly required: true;
1880
+ }];
1881
+ readonly queryParams: readonly [];
1882
+ readonly requestBodyRequired: false;
1883
+ readonly requiredKeyKind: "root";
1884
+ readonly surface: "management";
1885
+ };
1886
+ readonly managementSetMailboxFilters: {
1887
+ readonly command: "management:set-mailbox-filters";
1888
+ readonly description: "Replace mailbox sender filters";
1889
+ readonly headerParams: readonly [{
1890
+ readonly name: "If-Match";
1891
+ readonly required: false;
1892
+ }];
1893
+ readonly method: "put";
1894
+ readonly operationId: "managementSetMailboxFilters";
1895
+ readonly path: "/mailboxes/{public_id}/filters";
1896
+ readonly pathParams: readonly [{
1897
+ readonly name: "public_id";
1898
+ readonly required: true;
1899
+ }];
1900
+ readonly queryParams: readonly [];
1901
+ readonly requestBodyRequired: false;
1902
+ readonly requiredKeyKind: "root";
1903
+ readonly surface: "management";
1904
+ };
1905
+ readonly managementSuspendMailbox: {
1906
+ readonly command: "management:suspend-mailbox";
1907
+ readonly description: "Suspend a mailbox";
1908
+ readonly headerParams: readonly [{
1909
+ readonly name: "Idempotency-Key";
1910
+ readonly required: false;
1911
+ }];
1912
+ readonly method: "post";
1913
+ readonly operationId: "managementSuspendMailbox";
1914
+ readonly path: "/mailboxes/{public_id}/suspend";
1915
+ readonly pathParams: readonly [{
1916
+ readonly name: "public_id";
1917
+ readonly required: true;
1918
+ }];
1919
+ readonly queryParams: readonly [];
1920
+ readonly requestBodyRequired: false;
1921
+ readonly requiredKeyKind: "root";
1922
+ readonly surface: "management";
1923
+ };
1924
+ readonly managementTestProvider: {
1925
+ readonly command: "management:test-provider";
1926
+ readonly description: "Test an SMTP sending account";
1927
+ readonly headerParams: readonly [{
1928
+ readonly name: "Idempotency-Key";
1929
+ readonly required: false;
1930
+ }];
1931
+ readonly method: "post";
1932
+ readonly operationId: "managementTestProvider";
1933
+ readonly path: "/providers/{public_id}/test";
1934
+ readonly pathParams: readonly [{
1935
+ readonly name: "public_id";
1936
+ readonly required: true;
1937
+ }];
1938
+ readonly queryParams: readonly [];
1939
+ readonly requestBodyRequired: false;
1940
+ readonly requiredKeyKind: "root";
1941
+ readonly surface: "management";
1942
+ };
1943
+ readonly managementTestWebhook: {
1944
+ readonly command: "management:test-webhook";
1945
+ readonly description: "Send a synthetic test event";
1946
+ readonly headerParams: readonly [{
1947
+ readonly name: "Idempotency-Key";
1948
+ readonly required: false;
1949
+ }];
1950
+ readonly method: "post";
1951
+ readonly operationId: "managementTestWebhook";
1952
+ readonly path: "/webhooks/{public_id}/test";
1953
+ readonly pathParams: readonly [{
1954
+ readonly name: "public_id";
1955
+ readonly required: true;
1956
+ }];
1957
+ readonly queryParams: readonly [];
1958
+ readonly requestBodyRequired: false;
1959
+ readonly requiredKeyKind: "root";
1960
+ readonly surface: "management";
1961
+ };
1962
+ readonly managementUpdateMailbox: {
1963
+ readonly command: "management:update-mailbox";
1964
+ readonly description: "Update a mailbox";
1965
+ readonly headerParams: readonly [{
1966
+ readonly name: "If-Match";
1967
+ readonly required: false;
1968
+ }];
1969
+ readonly method: "patch";
1970
+ readonly operationId: "managementUpdateMailbox";
1971
+ readonly path: "/mailboxes/{public_id}";
1972
+ readonly pathParams: readonly [{
1973
+ readonly name: "public_id";
1974
+ readonly required: true;
1975
+ }];
1976
+ readonly queryParams: readonly [];
1977
+ readonly requestBodyRequired: false;
1978
+ readonly requiredKeyKind: "root";
1979
+ readonly surface: "management";
1980
+ };
1981
+ readonly managementUpdateProvider: {
1982
+ readonly command: "management:update-provider";
1983
+ readonly description: "Update a sending account";
1984
+ readonly headerParams: readonly [{
1985
+ readonly name: "If-Match";
1986
+ readonly required: false;
1987
+ }];
1988
+ readonly method: "patch";
1989
+ readonly operationId: "managementUpdateProvider";
1990
+ readonly path: "/providers/{public_id}";
1991
+ readonly pathParams: readonly [{
1992
+ readonly name: "public_id";
1993
+ readonly required: true;
1994
+ }];
1995
+ readonly queryParams: readonly [];
1996
+ readonly requestBodyRequired: false;
1997
+ readonly requiredKeyKind: "root";
1998
+ readonly surface: "management";
1999
+ };
2000
+ readonly managementUpdateWebhook: {
2001
+ readonly command: "management:update-webhook";
2002
+ readonly description: "Update a webhook subscription";
2003
+ readonly headerParams: readonly [{
2004
+ readonly name: "If-Match";
2005
+ readonly required: false;
2006
+ }];
2007
+ readonly method: "patch";
2008
+ readonly operationId: "managementUpdateWebhook";
2009
+ readonly path: "/webhooks/{public_id}";
2010
+ readonly pathParams: readonly [{
2011
+ readonly name: "public_id";
2012
+ readonly required: true;
2013
+ }];
2014
+ readonly queryParams: readonly [];
2015
+ readonly requestBodyRequired: false;
2016
+ readonly requiredKeyKind: "root";
2017
+ readonly surface: "management";
2018
+ };
2019
+ readonly managementVerifyDomain: {
2020
+ readonly command: "management:verify-domain";
2021
+ readonly description: "Verify a mailbox domain";
2022
+ readonly headerParams: readonly [];
2023
+ readonly method: "post";
2024
+ readonly operationId: "managementVerifyDomain";
2025
+ readonly path: "/domains/{public_id}/verify";
2026
+ readonly pathParams: readonly [{
2027
+ readonly name: "public_id";
2028
+ readonly required: true;
2029
+ }];
2030
+ readonly queryParams: readonly [];
2031
+ readonly requestBodyRequired: false;
2032
+ readonly requiredKeyKind: "root";
2033
+ readonly surface: "management";
2034
+ };
2035
+ readonly sendingGetOpenApiSpec: {
2036
+ readonly command: "sending:get-open-api-spec";
2037
+ readonly description: "OpenAPI 3.1 specification";
2038
+ readonly headerParams: readonly [{
2039
+ readonly name: "If-None-Match";
2040
+ readonly required: false;
2041
+ }];
2042
+ readonly method: "get";
2043
+ readonly operationId: "sendingGetOpenApiSpec";
2044
+ readonly path: "/openapi.json";
2045
+ readonly pathParams: readonly [];
2046
+ readonly queryParams: readonly [];
2047
+ readonly requestBodyRequired: false;
2048
+ readonly requiredKeyKind: "root";
2049
+ readonly surface: "sending";
2050
+ };
2051
+ readonly sendingSendEmail: {
2052
+ readonly command: "sending:send";
2053
+ readonly description: "Send a single email";
2054
+ readonly headerParams: readonly [{
2055
+ readonly name: "Idempotency-Key";
2056
+ readonly required: false;
2057
+ }];
2058
+ readonly method: "post";
2059
+ readonly operationId: "sendingSendEmail";
2060
+ readonly path: "/emails/send";
2061
+ readonly pathParams: readonly [];
2062
+ readonly queryParams: readonly [];
2063
+ readonly requestBodyRequired: true;
2064
+ readonly requiredKeyKind: "root";
2065
+ readonly surface: "sending";
2066
+ };
2067
+ readonly sendingSendEmailBatch: {
2068
+ readonly command: "sending:send:batch";
2069
+ readonly description: "Send a batch of emails";
2070
+ readonly headerParams: readonly [{
2071
+ readonly name: "Idempotency-Key";
2072
+ readonly required: false;
2073
+ }];
2074
+ readonly method: "post";
2075
+ readonly operationId: "sendingSendEmailBatch";
2076
+ readonly path: "/emails/send/batch";
2077
+ readonly pathParams: readonly [];
2078
+ readonly queryParams: readonly [];
2079
+ readonly requestBodyRequired: true;
2080
+ readonly requiredKeyKind: "root";
2081
+ readonly surface: "sending";
2082
+ };
2083
+ };
2084
+ export declare const curatedOperations: {
2085
+ readonly mailboxGetMe: {
2086
+ readonly command: "mailbox:me:get";
2087
+ readonly description: "Self-introspect the calling mailbox";
2088
+ readonly headerParams: readonly [{
2089
+ readonly name: "If-None-Match";
2090
+ readonly required: false;
2091
+ }];
2092
+ readonly method: "get";
2093
+ readonly operationId: "mailboxGetMe";
2094
+ readonly path: "/mailbox/me";
2095
+ readonly pathParams: readonly [];
2096
+ readonly queryParams: readonly [];
2097
+ readonly requestBodyRequired: false;
2098
+ readonly requiredKeyKind: "mailbox";
2099
+ readonly surface: "mailbox";
2100
+ };
2101
+ readonly mailboxGetMessage: {
2102
+ readonly command: "mailbox:messages:get";
2103
+ readonly description: "Get a mailbox message";
2104
+ readonly headerParams: readonly [{
2105
+ readonly name: "If-None-Match";
2106
+ readonly required: false;
2107
+ }];
2108
+ readonly method: "get";
2109
+ readonly operationId: "mailboxGetMessage";
2110
+ readonly path: "/mailbox/messages/{message_id}";
2111
+ readonly pathParams: readonly [{
2112
+ readonly name: "message_id";
2113
+ readonly required: true;
2114
+ }];
2115
+ readonly queryParams: readonly [];
2116
+ readonly requestBodyRequired: false;
2117
+ readonly requiredKeyKind: "mailbox";
2118
+ readonly surface: "mailbox";
2119
+ };
2120
+ readonly mailboxListFolders: {
2121
+ readonly command: "mailbox:folders:list";
2122
+ readonly description: "List mailbox folders";
2123
+ readonly headerParams: readonly [];
2124
+ readonly method: "get";
2125
+ readonly operationId: "mailboxListFolders";
2126
+ readonly path: "/mailbox/folders";
2127
+ readonly pathParams: readonly [];
2128
+ readonly queryParams: readonly [{
2129
+ readonly name: "cursor";
2130
+ readonly required: false;
2131
+ }, {
2132
+ readonly name: "limit";
2133
+ readonly required: false;
2134
+ }];
2135
+ readonly requestBodyRequired: false;
2136
+ readonly requiredKeyKind: "mailbox";
2137
+ readonly surface: "mailbox";
2138
+ };
2139
+ readonly mailboxListMessages: {
2140
+ readonly command: "mailbox:messages:list";
2141
+ readonly description: "List mailbox messages";
2142
+ readonly headerParams: readonly [];
2143
+ readonly method: "get";
2144
+ readonly operationId: "mailboxListMessages";
2145
+ readonly path: "/mailbox/messages";
2146
+ readonly pathParams: readonly [];
2147
+ readonly queryParams: readonly [{
2148
+ readonly name: "cursor";
2149
+ readonly required: false;
2150
+ }, {
2151
+ readonly name: "limit";
2152
+ readonly required: false;
2153
+ }, {
2154
+ readonly name: "folder_id";
2155
+ readonly required: false;
2156
+ }, {
2157
+ readonly name: "thread_id";
2158
+ readonly required: false;
2159
+ }, {
2160
+ readonly name: "q";
2161
+ readonly required: false;
2162
+ }, {
2163
+ readonly name: "from";
2164
+ readonly required: false;
2165
+ }, {
2166
+ readonly name: "to";
2167
+ readonly required: false;
2168
+ }, {
2169
+ readonly name: "cc";
2170
+ readonly required: false;
2171
+ }, {
2172
+ readonly name: "bcc";
2173
+ readonly required: false;
2174
+ }, {
2175
+ readonly name: "subject";
2176
+ readonly required: false;
2177
+ }, {
2178
+ readonly name: "body";
2179
+ readonly required: false;
2180
+ }, {
2181
+ readonly name: "header_name";
2182
+ readonly required: false;
2183
+ }, {
2184
+ readonly name: "header_value";
2185
+ readonly required: false;
2186
+ }, {
2187
+ readonly name: "min_size_bytes";
2188
+ readonly required: false;
2189
+ }, {
2190
+ readonly name: "max_size_bytes";
2191
+ readonly required: false;
2192
+ }, {
2193
+ readonly name: "keyword";
2194
+ readonly required: false;
2195
+ }, {
2196
+ readonly name: "not_keyword";
2197
+ readonly required: false;
2198
+ }, {
2199
+ readonly name: "after";
2200
+ readonly required: false;
2201
+ }, {
2202
+ readonly name: "before";
2203
+ readonly required: false;
2204
+ }, {
2205
+ readonly name: "has_attachment";
2206
+ readonly required: false;
2207
+ }, {
2208
+ readonly name: "is_unread";
2209
+ readonly required: false;
2210
+ }, {
2211
+ readonly name: "sort_by";
2212
+ readonly required: false;
2213
+ }, {
2214
+ readonly name: "sort_direction";
2215
+ readonly required: false;
2216
+ }];
2217
+ readonly requestBodyRequired: false;
2218
+ readonly requiredKeyKind: "mailbox";
2219
+ readonly surface: "mailbox";
2220
+ };
2221
+ readonly managementGetDomain: {
2222
+ readonly command: "management:domains:get";
2223
+ readonly description: "Get a mailbox domain";
2224
+ readonly headerParams: readonly [{
2225
+ readonly name: "If-None-Match";
2226
+ readonly required: false;
2227
+ }];
2228
+ readonly method: "get";
2229
+ readonly operationId: "managementGetDomain";
2230
+ readonly path: "/domains/{public_id}";
2231
+ readonly pathParams: readonly [{
2232
+ readonly name: "public_id";
2233
+ readonly required: true;
2234
+ }];
2235
+ readonly queryParams: readonly [];
2236
+ readonly requestBodyRequired: false;
2237
+ readonly requiredKeyKind: "root";
2238
+ readonly surface: "management";
2239
+ };
2240
+ readonly managementListDomains: {
2241
+ readonly command: "management:domains:list";
2242
+ readonly description: "List mailbox domains";
2243
+ readonly headerParams: readonly [];
2244
+ readonly method: "get";
2245
+ readonly operationId: "managementListDomains";
2246
+ readonly path: "/domains";
2247
+ readonly pathParams: readonly [];
2248
+ readonly queryParams: readonly [{
2249
+ readonly name: "cursor";
2250
+ readonly required: false;
2251
+ }, {
2252
+ readonly name: "limit";
2253
+ readonly required: false;
2254
+ }];
2255
+ readonly requestBodyRequired: false;
2256
+ readonly requiredKeyKind: "root";
2257
+ readonly surface: "management";
2258
+ };
2259
+ readonly managementListMailboxes: {
2260
+ readonly command: "management:mailboxes:list";
2261
+ readonly description: "List mailboxes";
2262
+ readonly headerParams: readonly [];
2263
+ readonly method: "get";
2264
+ readonly operationId: "managementListMailboxes";
2265
+ readonly path: "/mailboxes";
2266
+ readonly pathParams: readonly [];
2267
+ readonly queryParams: readonly [{
2268
+ readonly name: "cursor";
2269
+ readonly required: false;
2270
+ }, {
2271
+ readonly name: "limit";
2272
+ readonly required: false;
2273
+ }, {
2274
+ readonly name: "include_deleted";
2275
+ readonly required: false;
2276
+ }];
2277
+ readonly requestBodyRequired: false;
2278
+ readonly requiredKeyKind: "root";
2279
+ readonly surface: "management";
2280
+ };
2281
+ readonly managementListProviders: {
2282
+ readonly command: "management:providers:list";
2283
+ readonly description: "List sending accounts";
2284
+ readonly headerParams: readonly [];
2285
+ readonly method: "get";
2286
+ readonly operationId: "managementListProviders";
2287
+ readonly path: "/providers";
2288
+ readonly pathParams: readonly [];
2289
+ readonly queryParams: readonly [{
2290
+ readonly name: "cursor";
2291
+ readonly required: false;
2292
+ }, {
2293
+ readonly name: "status";
2294
+ readonly required: false;
2295
+ }, {
2296
+ readonly name: "type";
2297
+ readonly required: false;
2298
+ }, {
2299
+ readonly name: "limit";
2300
+ readonly required: false;
2301
+ }];
2302
+ readonly requestBodyRequired: false;
2303
+ readonly requiredKeyKind: "root";
2304
+ readonly surface: "management";
2305
+ };
2306
+ readonly sendingSendEmail: {
2307
+ readonly command: "sending:send";
2308
+ readonly description: "Send a single email";
2309
+ readonly headerParams: readonly [{
2310
+ readonly name: "Idempotency-Key";
2311
+ readonly required: false;
2312
+ }];
2313
+ readonly method: "post";
2314
+ readonly operationId: "sendingSendEmail";
2315
+ readonly path: "/emails/send";
2316
+ readonly pathParams: readonly [];
2317
+ readonly queryParams: readonly [];
2318
+ readonly requestBodyRequired: true;
2319
+ readonly requiredKeyKind: "root";
2320
+ readonly surface: "sending";
2321
+ };
2322
+ readonly sendingSendEmailBatch: {
2323
+ readonly command: "sending:send:batch";
2324
+ readonly description: "Send a batch of emails";
2325
+ readonly headerParams: readonly [{
2326
+ readonly name: "Idempotency-Key";
2327
+ readonly required: false;
2328
+ }];
2329
+ readonly method: "post";
2330
+ readonly operationId: "sendingSendEmailBatch";
2331
+ readonly path: "/emails/send/batch";
2332
+ readonly pathParams: readonly [];
2333
+ readonly queryParams: readonly [];
2334
+ readonly requestBodyRequired: true;
2335
+ readonly requiredKeyKind: "root";
2336
+ readonly surface: "sending";
2337
+ };
2338
+ };
2339
+ export type OperationId = keyof typeof operations;
2340
+ //# sourceMappingURL=operations.d.ts.map