@pidgeon-ai/sdk 1.48.0 → 1.50.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.
package/dist/index.d.ts CHANGED
@@ -390,6 +390,38 @@ type Sent = {
390
390
  expires_at: string;
391
391
  } | null;
392
392
  };
393
+ type SendCheck = {
394
+ /**
395
+ * Always true: nothing was sent, written or counted.
396
+ */
397
+ dry_run: true;
398
+ /**
399
+ * True when the real send would go now. False when it would wait for a person (`status: "pending_approval"`).
400
+ */
401
+ would_send: boolean;
402
+ /**
403
+ * The `status` the real send would answer.
404
+ */
405
+ status: 'sent' | 'pending_approval';
406
+ from: string;
407
+ to: Array<string>;
408
+ cc: Array<string>;
409
+ bcc: Array<string>;
410
+ /**
411
+ * The conversation it would go in. Null for a new message, which starts one.
412
+ */
413
+ thread_id: string | null;
414
+ /**
415
+ * True when the real send would be a test-mode send.
416
+ */
417
+ test: boolean;
418
+ /**
419
+ * Why it would wait, when `status` is `pending_approval`. Null otherwise.
420
+ */
421
+ approval: {
422
+ reason: 'first_contact' | 'risky_thread';
423
+ } | null;
424
+ };
393
425
  type TestInboundDelivered = {
394
426
  /**
395
427
  * `delivered` in the normal case; `rejected` when a sender rule on the address refuses it, as it would refuse the real thing.
@@ -416,6 +448,167 @@ type AgentVerified = {
416
448
  api_key: string;
417
449
  api_key_id: string;
418
450
  };
451
+ type AgentSetup = {
452
+ /**
453
+ * True when every step is done for the address below. A test key is never ready: its mail stays inside Pidgeon.
454
+ */
455
+ ready_to_send: boolean;
456
+ /**
457
+ * The address `steps` are about: the one you named, or the one nearest to sending. Null when the key reaches none.
458
+ */
459
+ identity_id: string | null;
460
+ address: string | null;
461
+ /**
462
+ * The first step not done. Null when there is nothing left to do.
463
+ */
464
+ next: {
465
+ /**
466
+ * Stable: branch on this, not on `what`. `address` (the key reaches none), `human_code` (a signup waiting for its code), `domain` (DNS), `address_active`, `allowance` (the account may send nothing a day), `key_send` (the key is below `send` here), `live_key` (a test key), `send_policy` (a list with nobody on it), `daily_limit`.
467
+ */
468
+ id: 'address' | 'human_code' | 'domain' | 'address_active' | 'allowance' | 'key_send' | 'live_key' | 'send_policy' | 'daily_limit';
469
+ done: boolean;
470
+ /**
471
+ * Who acts: you, or a person you have to ask.
472
+ */
473
+ owner: 'agent' | 'person';
474
+ /**
475
+ * The step, in a few words.
476
+ */
477
+ what: string;
478
+ /**
479
+ * What to do, or, when it is done, what is true.
480
+ */
481
+ how: string;
482
+ /**
483
+ * On `domain` while it is not verified: the records still to publish. Else null.
484
+ */
485
+ records: Array<{
486
+ type: string;
487
+ record_type: string;
488
+ /**
489
+ * Relative to the domain: `@` is the domain itself. Kept as it was; see `host_relative`.
490
+ */
491
+ name: string;
492
+ /**
493
+ * The registrable domain the record is published in, from the Public Suffix List: `example.com` for `agents.example.com`.
494
+ */
495
+ zone: string;
496
+ /**
497
+ * The full name, no trailing dot: `_dmarc.agents.example.com`.
498
+ */
499
+ fqdn: string;
500
+ /**
501
+ * The name relative to `zone`, which is what most DNS panels ask for: `_dmarc.agents`, or `@` for the zone itself.
502
+ */
503
+ host_relative: string;
504
+ value: string;
505
+ priority: number | null;
506
+ status: 'connected' | 'waiting' | 'incorrect' | 'not_required';
507
+ /**
508
+ * Why `status` is what it is. `published`: correct in public DNS, waiting on the mail provider to confirm (DKIM; usually under an hour), or on its certificate (`signing_host`; usually ten minutes). `wrong_name`: our value is at `found_at` instead, often the zone typed twice. Null before the first check.
509
+ */
510
+ state: 'connected' | 'published' | 'missing' | 'wrong_value' | 'wrong_name' | 'not_required' | null;
511
+ found: string | null;
512
+ /**
513
+ * Where `found` was read, when that was not `fqdn`.
514
+ */
515
+ found_at: string | null;
516
+ /**
517
+ * Not needed for mail: `signing` and `signing_host`, which let receivers check a signed sender from this domain. Its own `status`; never counted towards whether the domain is configured.
518
+ */
519
+ optional: boolean;
520
+ description: string;
521
+ checked_at: string | null;
522
+ }> | null;
523
+ /**
524
+ * On `daily_limit` while it refuses: when sending frees up. Else null.
525
+ */
526
+ resets_at: string | null;
527
+ } | null;
528
+ /**
529
+ * In the order to clear them, done ones included.
530
+ */
531
+ steps: Array<{
532
+ /**
533
+ * Stable: branch on this, not on `what`. `address` (the key reaches none), `human_code` (a signup waiting for its code), `domain` (DNS), `address_active`, `allowance` (the account may send nothing a day), `key_send` (the key is below `send` here), `live_key` (a test key), `send_policy` (a list with nobody on it), `daily_limit`.
534
+ */
535
+ id: 'address' | 'human_code' | 'domain' | 'address_active' | 'allowance' | 'key_send' | 'live_key' | 'send_policy' | 'daily_limit';
536
+ done: boolean;
537
+ /**
538
+ * Who acts: you, or a person you have to ask.
539
+ */
540
+ owner: 'agent' | 'person';
541
+ /**
542
+ * The step, in a few words.
543
+ */
544
+ what: string;
545
+ /**
546
+ * What to do, or, when it is done, what is true.
547
+ */
548
+ how: string;
549
+ /**
550
+ * On `domain` while it is not verified: the records still to publish. Else null.
551
+ */
552
+ records: Array<{
553
+ type: string;
554
+ record_type: string;
555
+ /**
556
+ * Relative to the domain: `@` is the domain itself. Kept as it was; see `host_relative`.
557
+ */
558
+ name: string;
559
+ /**
560
+ * The registrable domain the record is published in, from the Public Suffix List: `example.com` for `agents.example.com`.
561
+ */
562
+ zone: string;
563
+ /**
564
+ * The full name, no trailing dot: `_dmarc.agents.example.com`.
565
+ */
566
+ fqdn: string;
567
+ /**
568
+ * The name relative to `zone`, which is what most DNS panels ask for: `_dmarc.agents`, or `@` for the zone itself.
569
+ */
570
+ host_relative: string;
571
+ value: string;
572
+ priority: number | null;
573
+ status: 'connected' | 'waiting' | 'incorrect' | 'not_required';
574
+ /**
575
+ * Why `status` is what it is. `published`: correct in public DNS, waiting on the mail provider to confirm (DKIM; usually under an hour), or on its certificate (`signing_host`; usually ten minutes). `wrong_name`: our value is at `found_at` instead, often the zone typed twice. Null before the first check.
576
+ */
577
+ state: 'connected' | 'published' | 'missing' | 'wrong_value' | 'wrong_name' | 'not_required' | null;
578
+ found: string | null;
579
+ /**
580
+ * Where `found` was read, when that was not `fqdn`.
581
+ */
582
+ found_at: string | null;
583
+ /**
584
+ * Not needed for mail: `signing` and `signing_host`, which let receivers check a signed sender from this domain. Its own `status`; never counted towards whether the domain is configured.
585
+ */
586
+ optional: boolean;
587
+ description: string;
588
+ checked_at: string | null;
589
+ }> | null;
590
+ /**
591
+ * On `daily_limit` while it refuses: when sending frees up. Else null.
592
+ */
593
+ resets_at: string | null;
594
+ }>;
595
+ /**
596
+ * Every address the key reaches, nearest to sending first, up to 20. Call again with one’s `identity_id` for its steps, or to ask about an address past the first 20.
597
+ */
598
+ addresses: Array<{
599
+ identity_id: string;
600
+ address: string;
601
+ ready_to_send: boolean;
602
+ /**
603
+ * The `id` of its first step not done, or null when it is ready.
604
+ */
605
+ next: 'address' | 'human_code' | 'domain' | 'address_active' | 'allowance' | 'key_send' | 'live_key' | 'send_policy' | 'daily_limit' | null;
606
+ }>;
607
+ /**
608
+ * How many addresses the key reaches.
609
+ */
610
+ addresses_total: number;
611
+ };
419
612
  type Identity = {
420
613
  id: string;
421
614
  email: string;
@@ -463,6 +656,10 @@ type Identity = {
463
656
  * Who may write to it: open, or list (only senders with an inbox rule, on mail that passes DMARC).
464
657
  */
465
658
  receive_policy: string;
659
+ /**
660
+ * Minutes before a send that is not a reply may go to somebody this address just wrote to; sooner is refused `429 recipient_cooldown`. 0 is off. Default 10.
661
+ */
662
+ recipient_cooldown_minutes: number;
466
663
  /**
467
664
  * Whether Pidgeon Firewall holds suspicious mail here for a person: stored, and unreadable with a key until a person releases it from the dashboard. On by default for workspaces made from 27 October 2026.
468
665
  */
@@ -2279,6 +2476,10 @@ type PodCreated = {
2279
2476
  * Who may write to it: open, or list (only senders with an inbox rule, on mail that passes DMARC).
2280
2477
  */
2281
2478
  receive_policy: string;
2479
+ /**
2480
+ * Minutes before a send that is not a reply may go to somebody this address just wrote to; sooner is refused `429 recipient_cooldown`. 0 is off. Default 10.
2481
+ */
2482
+ recipient_cooldown_minutes: number;
2282
2483
  /**
2283
2484
  * Whether Pidgeon Firewall holds suspicious mail here for a person: stored, and unreadable with a key until a person releases it from the dashboard. On by default for workspaces made from 27 October 2026.
2284
2485
  */
@@ -2669,6 +2870,58 @@ type AgentConnectResponses = {
2669
2870
  };
2670
2871
  };
2671
2872
  type AgentConnectResponse = AgentConnectResponses[keyof AgentConnectResponses];
2873
+ type AgentSetupData = {
2874
+ body?: never;
2875
+ path?: never;
2876
+ query?: {
2877
+ identity_id?: string;
2878
+ };
2879
+ url: '/agent/setup';
2880
+ };
2881
+ type AgentSetupErrors = {
2882
+ /**
2883
+ * The request is not valid. `error.field` names the input at fault when there is one.
2884
+ */
2885
+ 400: Error;
2886
+ /**
2887
+ * No API key, or one that is not valid.
2888
+ */
2889
+ 401: Error;
2890
+ /**
2891
+ * Refused. `error.code` says why: `forbidden` when this key may not do this or the account is on hold, `abuse_blocked` when a limit says no.
2892
+ */
2893
+ 403: Error;
2894
+ /**
2895
+ * No such resource, or one this key cannot reach. The two answer the same, so treat a 404 as “not available to you” rather than “does not exist”.
2896
+ */
2897
+ 404: Error;
2898
+ /**
2899
+ * It conflicts with what is there: it already exists, or the `etag` you sent is not the current one.
2900
+ */
2901
+ 409: Error;
2902
+ /**
2903
+ * Rate limited. `X-RateLimit-Reset` says when to retry.
2904
+ */
2905
+ 429: Error;
2906
+ /**
2907
+ * Something went wrong on our side. Retry; if it keeps happening, tell us.
2908
+ */
2909
+ 500: Error;
2910
+ /**
2911
+ * Something this needs is not answering right now. Retry in a moment.
2912
+ */
2913
+ 503: Error;
2914
+ };
2915
+ type AgentSetupError = AgentSetupErrors[keyof AgentSetupErrors];
2916
+ type AgentSetupResponses = {
2917
+ /**
2918
+ * Where this key stands.
2919
+ */
2920
+ 200: {
2921
+ data: AgentSetup;
2922
+ };
2923
+ };
2924
+ type AgentSetupResponse = AgentSetupResponses[keyof AgentSetupResponses];
2672
2925
  type IdentitiesListData = {
2673
2926
  body?: never;
2674
2927
  path?: never;
@@ -2989,6 +3242,10 @@ type IdentitiesUpdateData = {
2989
3242
  * Who may write to it. `list` accepts only senders with an `inbox` receive rule whose mail passes DMARC, and refuses everybody else before anything is stored. A key with admin on the address may tighten it; loosening needs its owner.
2990
3243
  */
2991
3244
  receive_policy?: 'open' | 'list';
3245
+ /**
3246
+ * Minutes before a send that is not a reply may go to somebody this address just wrote to (`429 recipient_cooldown`). 0 turns it off; at most 1440. Default 10. A key with admin on the address may lengthen it; shortening it or turning it off needs its owner.
3247
+ */
3248
+ recipient_cooldown_minutes?: number;
2992
3249
  /**
2993
3250
  * Whether Pidgeon Firewall holds suspicious mail for a person. A key may turn it on; turning it off is a person’s, from the dashboard, because the agent it protects should not be able to.
2994
3251
  */
@@ -4611,7 +4868,7 @@ type MessagesSendErrors = {
4611
4868
  */
4612
4869
  409: Error;
4613
4870
  /**
4614
- * Rate limited. `X-RateLimit-Reset` says when to retry.
4871
+ * Too soon, and nothing was sent. `error.code` says which: `rate_limited` (the plan’s five-minute sending limit) or `recipient_cooldown` (this address wrote to that recipient within its `recipient_cooldown_minutes`, and this is not a reply; the message names them). Wait `Retry-After` seconds, or reply in the conversation instead.
4615
4872
  */
4616
4873
  429: Error;
4617
4874
  /**
@@ -4637,6 +4894,124 @@ type MessagesSendResponses = {
4637
4894
  };
4638
4895
  };
4639
4896
  type MessagesSendResponse = MessagesSendResponses[keyof MessagesSendResponses];
4897
+ type MessagesCheckData = {
4898
+ body: {
4899
+ /**
4900
+ * An address on a domain you own, and one this key may send from.
4901
+ */
4902
+ from: string;
4903
+ /**
4904
+ * One address or several. A string is accepted for the single case.
4905
+ */
4906
+ to: string | Array<string>;
4907
+ /**
4908
+ * Copied, and visible to everybody who receives the message.
4909
+ */
4910
+ cc?: string | Array<string>;
4911
+ /**
4912
+ * Copied, and visible to nobody else.
4913
+ */
4914
+ bcc?: string | Array<string>;
4915
+ /**
4916
+ * Left off a reply, where the thread already has one.
4917
+ */
4918
+ subject?: string;
4919
+ /**
4920
+ * The plain-text body. Send this even when you send `html` — some clients only read it.
4921
+ */
4922
+ text?: string;
4923
+ /**
4924
+ * The rich body. Sanitised on the way in; scripts and remote content are removed.
4925
+ */
4926
+ html?: string;
4927
+ /**
4928
+ * Typed data: structured JSON sent beside the text, for software at the other end to read as fields. Travels as its own part; it is never mixed into the text.
4929
+ */
4930
+ data?: {
4931
+ /**
4932
+ * A URL naming what `body` is, such as `https://schema.org/Invoice`.
4933
+ */
4934
+ schema: string;
4935
+ /**
4936
+ * The JSON itself. Up to 64 KB once serialised.
4937
+ */
4938
+ body: unknown;
4939
+ };
4940
+ /**
4941
+ * Ids from `POST /attachments`, uploaded before the message that carries them. Up to 20.
4942
+ */
4943
+ attachment_ids?: Array<string>;
4944
+ /**
4945
+ * The message being answered. Keeps the conversation together in the recipient’s client too.
4946
+ */
4947
+ in_reply_to?: string | null;
4948
+ /**
4949
+ * The same field as `in_reply_to`, under the name this endpoint has always used. Both names work on both endpoints; reach for `in_reply_to`.
4950
+ */
4951
+ in_reply_to_message_id?: string | null;
4952
+ /**
4953
+ * Check this as a forward of the message in `in_reply_to`, rather than a reply to it. A forward is not a reply, so the per-recipient cooldown applies.
4954
+ */
4955
+ forward?: boolean;
4956
+ };
4957
+ headers?: {
4958
+ /**
4959
+ * Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing — no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.
4960
+ */
4961
+ 'Idempotency-Key'?: string;
4962
+ };
4963
+ path?: never;
4964
+ query?: never;
4965
+ url: '/messages/check';
4966
+ };
4967
+ type MessagesCheckErrors = {
4968
+ /**
4969
+ * The request is not valid. `error.field` names the input at fault when there is one.
4970
+ */
4971
+ 400: Error;
4972
+ /**
4973
+ * No API key, or one that is not valid.
4974
+ */
4975
+ 401: Error;
4976
+ /**
4977
+ * Refused, and nothing was sent to anybody. `error.code` says why: `blocked` (a rule), `not_permitted` (the send policy), `abuse_blocked` (a sending limit), `exfiltration_blocked` (it carries text a key read in another conversation; the message names it), `taken_over` (a person has this conversation: a key does not send in it until they hand it back) or `forbidden` (the address is not one this key can send from, or is not active).
4978
+ */
4979
+ 403: Error;
4980
+ /**
4981
+ * No such resource, or one this key cannot reach. The two answer the same, so treat a 404 as “not available to you” rather than “does not exist”.
4982
+ */
4983
+ 404: Error;
4984
+ /**
4985
+ * Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
4986
+ */
4987
+ 409: Error;
4988
+ /**
4989
+ * Too soon, and nothing was sent. `error.code` says which: `rate_limited` (the plan’s five-minute sending limit) or `recipient_cooldown` (this address wrote to that recipient within its `recipient_cooldown_minutes`, and this is not a reply; the message names them). Wait `Retry-After` seconds, or reply in the conversation instead.
4990
+ */
4991
+ 429: Error;
4992
+ /**
4993
+ * Something went wrong on our side. Retry; if it keeps happening, tell us.
4994
+ */
4995
+ 500: Error;
4996
+ /**
4997
+ * Something this needs is not answering right now. Retry in a moment.
4998
+ */
4999
+ 503: Error;
5000
+ /**
5001
+ * Test mode only: `Pidgeon-Test-Fail: drop` dropped the answer (`test_dropped`). The request was done; retry it with the same `Idempotency-Key` to get the first answer.
5002
+ */
5003
+ 504: Error;
5004
+ };
5005
+ type MessagesCheckError = MessagesCheckErrors[keyof MessagesCheckErrors];
5006
+ type MessagesCheckResponses = {
5007
+ /**
5008
+ * Every check passed. Nothing was sent.
5009
+ */
5010
+ 200: {
5011
+ data: SendCheck;
5012
+ };
5013
+ };
5014
+ type MessagesCheckResponse = MessagesCheckResponses[keyof MessagesCheckResponses];
4640
5015
  type MessagesSearchData = {
4641
5016
  body?: never;
4642
5017
  path?: never;
@@ -5111,7 +5486,7 @@ type MessagesReplyErrors = {
5111
5486
  */
5112
5487
  409: Error;
5113
5488
  /**
5114
- * Rate limited. `X-RateLimit-Reset` says when to retry.
5489
+ * Too soon, and nothing was sent. `error.code` says which: `rate_limited` (the plan’s five-minute sending limit) or `recipient_cooldown` (this address wrote to that recipient within its `recipient_cooldown_minutes`, and this is not a reply; the message names them). Wait `Retry-After` seconds, or reply in the conversation instead.
5115
5490
  */
5116
5491
  429: Error;
5117
5492
  /**
@@ -5211,7 +5586,7 @@ type MessagesReplyAllErrors = {
5211
5586
  */
5212
5587
  409: Error;
5213
5588
  /**
5214
- * Rate limited. `X-RateLimit-Reset` says when to retry.
5589
+ * Too soon, and nothing was sent. `error.code` says which: `rate_limited` (the plan’s five-minute sending limit) or `recipient_cooldown` (this address wrote to that recipient within its `recipient_cooldown_minutes`, and this is not a reply; the message names them). Wait `Retry-After` seconds, or reply in the conversation instead.
5215
5590
  */
5216
5591
  429: Error;
5217
5592
  /**
@@ -5311,7 +5686,7 @@ type MessagesForwardErrors = {
5311
5686
  */
5312
5687
  409: Error;
5313
5688
  /**
5314
- * Rate limited. `X-RateLimit-Reset` says when to retry.
5689
+ * Too soon, and nothing was sent. `error.code` says which: `rate_limited` (the plan’s five-minute sending limit) or `recipient_cooldown` (this address wrote to that recipient within its `recipient_cooldown_minutes`, and this is not a reply; the message names them). Wait `Retry-After` seconds, or reply in the conversation instead.
5315
5690
  */
5316
5691
  429: Error;
5317
5692
  /**
@@ -8282,7 +8657,7 @@ type MessagesRespondToInvitationErrors = {
8282
8657
  */
8283
8658
  409: Error;
8284
8659
  /**
8285
- * Rate limited. `X-RateLimit-Reset` says when to retry.
8660
+ * Too soon, and nothing was sent. `error.code` says which: `rate_limited` (the plan’s five-minute sending limit) or `recipient_cooldown` (this address wrote to that recipient within its `recipient_cooldown_minutes`, and this is not a reply; the message names them). Wait `Retry-After` seconds, or reply in the conversation instead.
8286
8661
  */
8287
8662
  429: Error;
8288
8663
  /**
@@ -8561,7 +8936,7 @@ type CalendarCreateEventErrors = {
8561
8936
  */
8562
8937
  409: Error;
8563
8938
  /**
8564
- * Rate limited. `X-RateLimit-Reset` says when to retry.
8939
+ * Too soon, and nothing was sent. `error.code` says which: `rate_limited` (the plan’s five-minute sending limit) or `recipient_cooldown` (this address wrote to that recipient within its `recipient_cooldown_minutes`, and this is not a reply; the message names them). Wait `Retry-After` seconds, or reply in the conversation instead.
8565
8940
  */
8566
8941
  429: Error;
8567
8942
  /**
@@ -8636,7 +9011,7 @@ type CalendarRespondToEventErrors = {
8636
9011
  */
8637
9012
  410: Error;
8638
9013
  /**
8639
- * Rate limited. `X-RateLimit-Reset` says when to retry.
9014
+ * Too soon, and nothing was sent. `error.code` says which: `rate_limited` (the plan’s five-minute sending limit) or `recipient_cooldown` (this address wrote to that recipient within its `recipient_cooldown_minutes`, and this is not a reply; the message names them). Wait `Retry-After` seconds, or reply in the conversation instead.
8640
9015
  */
8641
9016
  429: Error;
8642
9017
  /**
@@ -8848,7 +9223,7 @@ type CalendarDeleteEventErrors = {
8848
9223
  */
8849
9224
  410: Error;
8850
9225
  /**
8851
- * Rate limited. `X-RateLimit-Reset` says when to retry.
9226
+ * Too soon, and nothing was sent. `error.code` says which: `rate_limited` (the plan’s five-minute sending limit) or `recipient_cooldown` (this address wrote to that recipient within its `recipient_cooldown_minutes`, and this is not a reply; the message names them). Wait `Retry-After` seconds, or reply in the conversation instead.
8852
9227
  */
8853
9228
  429: Error;
8854
9229
  /**
@@ -9006,7 +9381,7 @@ type CalendarUpdateEventErrors = {
9006
9381
  */
9007
9382
  410: Error;
9008
9383
  /**
9009
- * Rate limited. `X-RateLimit-Reset` says when to retry.
9384
+ * Too soon, and nothing was sent. `error.code` says which: `rate_limited` (the plan’s five-minute sending limit) or `recipient_cooldown` (this address wrote to that recipient within its `recipient_cooldown_minutes`, and this is not a reply; the message names them). Wait `Retry-After` seconds, or reply in the conversation instead.
9010
9385
  */
9011
9386
  429: Error;
9012
9387
  /**
@@ -9462,7 +9837,7 @@ type DraftsSendErrors = {
9462
9837
  */
9463
9838
  409: Error;
9464
9839
  /**
9465
- * Rate limited. `X-RateLimit-Reset` says when to retry.
9840
+ * Too soon, and nothing was sent. `error.code` says which: `rate_limited` (the plan’s five-minute sending limit) or `recipient_cooldown` (this address wrote to that recipient within its `recipient_cooldown_minutes`, and this is not a reply; the message names them). Wait `Retry-After` seconds, or reply in the conversation instead.
9466
9841
  */
9467
9842
  429: Error;
9468
9843
  /**
@@ -10120,6 +10495,12 @@ declare const agentVerify: <ThrowOnError extends boolean = false>(options: Optio
10120
10495
  * For an inbox a person already has. They press "Get a setup code" on the dashboard and give the agent the code; this returns an API key with `send` on that one address. No account is created and no code is emailed. A code works once, for 10 minutes; every way one fails gets the same `400`. The key is returned once and never again, shows under the person’s API keys, and is held for approval like any other key.
10121
10496
  */
10122
10497
  declare const agentConnect: <ThrowOnError extends boolean = false>(options: Options<AgentConnectData, ThrowOnError>) => RequestResult<AgentConnectResponses, AgentConnectErrors, ThrowOnError>;
10498
+ /**
10499
+ * What stands between this key and sending
10500
+ *
10501
+ * **Call this first.** It asks every check a send would, without sending, and answers in order: `steps[]`, each with `done`, who acts (`owner`: `agent` or `person`), `what` and `how`, and `next`, the first not done. A person returns the signup code, publishes DNS (the records are listed) or gives you a key that can send; you create an address or wait out a limit (`resets_at`). `ready_to_send` is true when nothing is left. Without `identity_id` it answers for the address nearest to sending and lists the rest. It sees only the addresses this key reaches.
10502
+ */
10503
+ declare const agentSetup: <ThrowOnError extends boolean = false>(options?: Options<AgentSetupData, ThrowOnError>) => RequestResult<AgentSetupResponses, AgentSetupErrors, ThrowOnError>;
10123
10504
  /**
10124
10505
  * List addresses
10125
10506
  *
@@ -10298,6 +10679,12 @@ declare const messagesListInThread: <ThrowOnError extends boolean = false>(optio
10298
10679
  * Idempotent with an `Idempotency-Key` header. Answers `202` with the id, the thread and anything **rejected** — addresses the provider would not accept at hand-off, so read it before assuming every recipient got it. A recipient this address is not allowed to write to is a different thing and refuses the whole send: `403` with `blocked` when a rule says no, `not_permitted` when the send policy does. Nothing is sent to anybody in that case. With a test key, `rejected@` at any domain is always rejected and `bounce@` bounces, and `Pidgeon-Test-Fail` causes a 429, a 503, a slow answer or a lost one: https://pidgeon.ai/docs/test-mode#causing-failures.
10299
10680
  */
10300
10681
  declare const messagesSend: <ThrowOnError extends boolean = false>(options: Options<MessagesSendData, ThrowOnError>) => RequestResult<MessagesSendResponses, MessagesSendErrors, ThrowOnError>;
10682
+ /**
10683
+ * Check a send without sending
10684
+ *
10685
+ * Would this send? The body `POST /messages` takes, plus `forward`, through every check a send makes: the address, the plan’s sending limits, suppression, the send policy and rules, the per-recipient cooldown, the daily cap, canary tokens, hand-over and approval. Answers `200` with `would_send` and the envelope, or the exact refusal the send would give — the same status, `error.code`, message, field and `Retry-After`. Nothing is sent or written, and nothing counts against a limit. A reply is checked with `in_reply_to`; a forward with `in_reply_to` and `forward: true`. The answer is for now: a send a moment later can meet a limit this did not.
10686
+ */
10687
+ declare const messagesCheck: <ThrowOnError extends boolean = false>(options: Options<MessagesCheckData, ThrowOnError>) => RequestResult<MessagesCheckResponses, MessagesCheckErrors, ThrowOnError>;
10301
10688
  /**
10302
10689
  * Search messages
10303
10690
  *
@@ -10928,4 +11315,4 @@ interface StreamOptions {
10928
11315
  */
10929
11316
  declare function streamEvents(options: StreamOptions): AsyncGenerator<StreamedEvent>;
10930
11317
 
10931
- export { type Address, type AgentAttachHumanData, type AgentAttachHumanError, type AgentAttachHumanErrors, type AgentAttachHumanResponse, type AgentAttachHumanResponses, type AgentConnectData, type AgentConnectError, type AgentConnectErrors, type AgentConnectResponse, type AgentConnectResponses, type AgentConnected, type AgentSignUpData, type AgentSignUpError, type AgentSignUpErrors, type AgentSignUpResponse, type AgentSignUpResponses, type AgentSignup, type AgentVerified, type AgentVerifyData, type AgentVerifyError, type AgentVerifyErrors, type AgentVerifyResponse, type AgentVerifyResponses, type ApiKey, type ApiKeyCreated, type AppPassword, type AppPasswordCreated, type AppPasswordsCreateData, type AppPasswordsCreateError, type AppPasswordsCreateErrors, type AppPasswordsCreateResponse, type AppPasswordsCreateResponses, type AppPasswordsListData, type AppPasswordsListError, type AppPasswordsListErrors, type AppPasswordsListResponse, type AppPasswordsListResponses, type AppPasswordsRevokeData, type AppPasswordsRevokeError, type AppPasswordsRevokeErrors, type AppPasswordsRevokeResponse, type AppPasswordsRevokeResponses, type Approval, type Attachment, type AttachmentText, type AttachmentUrl, type AttachmentsCompleteUploadData, type AttachmentsCompleteUploadError, type AttachmentsCompleteUploadErrors, type AttachmentsCompleteUploadResponse, type AttachmentsCompleteUploadResponses, type AttachmentsCreateUploadData, type AttachmentsCreateUploadError, type AttachmentsCreateUploadErrors, type AttachmentsCreateUploadResponse, type AttachmentsCreateUploadResponses, type AttachmentsDownloadUrlData, type AttachmentsDownloadUrlError, type AttachmentsDownloadUrlErrors, type AttachmentsDownloadUrlResponse, type AttachmentsDownloadUrlResponses, type AttachmentsTextData, type AttachmentsTextError, type AttachmentsTextErrors, type AttachmentsTextResponse, type AttachmentsTextResponses, type AttachmentsUploadData, type AttachmentsUploadError, type AttachmentsUploadErrors, type AttachmentsUploadResponse, type AttachmentsUploadResponses, type AwaitedMessage, type Calendar, type CalendarCreateEventData, type CalendarCreateEventError, type CalendarCreateEventErrors, type CalendarCreateEventResponse, type CalendarCreateEventResponses, type CalendarDeleteEventData, type CalendarDeleteEventError, type CalendarDeleteEventErrors, type CalendarDeleteEventResponse, type CalendarDeleteEventResponses, type CalendarEvent, type CalendarGetAgendaData, type CalendarGetAgendaError, type CalendarGetAgendaErrors, type CalendarGetAgendaResponse, type CalendarGetAgendaResponses, type CalendarGetData, type CalendarGetError, type CalendarGetErrors, type CalendarGetEventData, type CalendarGetEventError, type CalendarGetEventErrors, type CalendarGetEventResponse, type CalendarGetEventResponses, type CalendarGetResponse, type CalendarGetResponses, type CalendarListEventInstancesData, type CalendarListEventInstancesError, type CalendarListEventInstancesErrors, type CalendarListEventInstancesResponse, type CalendarListEventInstancesResponses, type CalendarListEventsData, type CalendarListEventsError, type CalendarListEventsErrors, type CalendarListEventsResponse, type CalendarListEventsResponses, type CalendarRespondToEventData, type CalendarRespondToEventError, type CalendarRespondToEventErrors, type CalendarRespondToEventResponse, type CalendarRespondToEventResponses, type CalendarUpdateData, type CalendarUpdateError, type CalendarUpdateErrors, type CalendarUpdateEventData, type CalendarUpdateEventError, type CalendarUpdateEventErrors, type CalendarUpdateEventResponse, type CalendarUpdateEventResponses, type CalendarUpdateResponse, type CalendarUpdateResponses, type ClientOptions, type CreateClientConfig, type CreatedDomain, type Deleted, type Delivery, type DnsRecord, type Domain, type DomainDetail, type DomainsCreateData, type DomainsCreateError, type DomainsCreateErrors, type DomainsCreateResponse, type DomainsCreateResponses, type DomainsDeleteData, type DomainsDeleteError, type DomainsDeleteErrors, type DomainsDeleteResponse, type DomainsDeleteResponses, type DomainsGetData, type DomainsGetError, type DomainsGetErrors, type DomainsGetResponse, type DomainsGetResponses, type DomainsGetSetupLinkData, type DomainsGetSetupLinkError, type DomainsGetSetupLinkErrors, type DomainsGetSetupLinkResponse, type DomainsGetSetupLinkResponses, type DomainsListData, type DomainsListError, type DomainsListErrors, type DomainsListResponse, type DomainsListResponses, type DomainsUpdateData, type DomainsUpdateError, type DomainsUpdateErrors, type DomainsUpdateResponse, type DomainsUpdateResponses, type DomainsVerifyData, type DomainsVerifyError, type DomainsVerifyErrors, type DomainsVerifyResponse, type DomainsVerifyResponses, type DomainsZoneFileData, type DomainsZoneFileError, type DomainsZoneFileErrors, type DomainsZoneFileResponse, type DomainsZoneFileResponses, type Draft, type DraftsApprovalData, type DraftsApprovalError, type DraftsApprovalErrors, type DraftsApprovalResponse, type DraftsApprovalResponses, type DraftsCancelScheduleData, type DraftsCancelScheduleError, type DraftsCancelScheduleErrors, type DraftsCancelScheduleResponse, type DraftsCancelScheduleResponses, type DraftsCreateData, type DraftsCreateError, type DraftsCreateErrors, type DraftsCreateResponse, type DraftsCreateResponses, type DraftsDeleteData, type DraftsDeleteError, type DraftsDeleteErrors, type DraftsDeleteResponse, type DraftsDeleteResponses, type DraftsGetData, type DraftsGetError, type DraftsGetErrors, type DraftsGetResponse, type DraftsGetResponses, type DraftsListData, type DraftsListError, type DraftsListErrors, type DraftsListResponse, type DraftsListResponses, type DraftsRemoveAttachmentData, type DraftsRemoveAttachmentError, type DraftsRemoveAttachmentErrors, type DraftsRemoveAttachmentResponse, type DraftsRemoveAttachmentResponses, type DraftsScheduleData, type DraftsScheduleError, type DraftsScheduleErrors, type DraftsScheduleResponse, type DraftsScheduleResponses, type DraftsSendData, type DraftsSendError, type DraftsSendErrors, type DraftsSendResponse, type DraftsSendResponses, type DraftsUpdateData, type DraftsUpdateError, type DraftsUpdateErrors, type DraftsUpdateResponse, type DraftsUpdateResponses, type Emptied, type Error, type Event, type EventResponse, type EventsGetData, type EventsGetError, type EventsGetErrors, type EventsGetResponse, type EventsGetResponses, type EventsListData, type EventsListError, type EventsListErrors, type EventsListResponse, type EventsListResponses, type EventsSocketData, type EventsSocketError, type EventsSocketErrors, type EventsStreamData, type EventsStreamError, type EventsStreamErrors, type EventsStreamResponse, type EventsStreamResponses, type ExportMailData, type ExportMailError, type ExportMailErrors, type ExportMailResponse, type ExportMailResponses, type IdentitiesAccessCreateData, type IdentitiesAccessCreateError, type IdentitiesAccessCreateErrors, type IdentitiesAccessCreateResponse, type IdentitiesAccessCreateResponses, type IdentitiesAccessDeleteData, type IdentitiesAccessDeleteError, type IdentitiesAccessDeleteErrors, type IdentitiesAccessDeleteResponse, type IdentitiesAccessDeleteResponses, type IdentitiesAccessGetData, type IdentitiesAccessGetError, type IdentitiesAccessGetErrors, type IdentitiesAccessGetResponse, type IdentitiesAccessGetResponses, type IdentitiesCreateData, type IdentitiesCreateError, type IdentitiesCreateErrors, type IdentitiesCreateResponse, type IdentitiesCreateResponses, type IdentitiesDeleteData, type IdentitiesDeleteError, type IdentitiesDeleteErrors, type IdentitiesDeleteResponse, type IdentitiesDeleteResponses, type IdentitiesGetData, type IdentitiesGetError, type IdentitiesGetErrors, type IdentitiesGetResponse, type IdentitiesGetResponses, type IdentitiesListData, type IdentitiesListError, type IdentitiesListErrors, type IdentitiesListResponse, type IdentitiesListResponses, type IdentitiesReceiveRulesCreateData, type IdentitiesReceiveRulesCreateError, type IdentitiesReceiveRulesCreateErrors, type IdentitiesReceiveRulesCreateResponse, type IdentitiesReceiveRulesCreateResponses, type IdentitiesReceiveRulesDeleteData, type IdentitiesReceiveRulesDeleteError, type IdentitiesReceiveRulesDeleteErrors, type IdentitiesReceiveRulesDeleteResponse, type IdentitiesReceiveRulesDeleteResponses, type IdentitiesReceiveRulesGetData, type IdentitiesReceiveRulesGetError, type IdentitiesReceiveRulesGetErrors, type IdentitiesReceiveRulesGetResponse, type IdentitiesReceiveRulesGetResponses, type IdentitiesSendRulesCreateData, type IdentitiesSendRulesCreateError, type IdentitiesSendRulesCreateErrors, type IdentitiesSendRulesCreateResponse, type IdentitiesSendRulesCreateResponses, type IdentitiesSendRulesDeleteData, type IdentitiesSendRulesDeleteError, type IdentitiesSendRulesDeleteErrors, type IdentitiesSendRulesDeleteResponse, type IdentitiesSendRulesDeleteResponses, type IdentitiesSendRulesGetData, type IdentitiesSendRulesGetError, type IdentitiesSendRulesGetErrors, type IdentitiesSendRulesGetResponse, type IdentitiesSendRulesGetResponses, type IdentitiesSuspendTenantData, type IdentitiesSuspendTenantError, type IdentitiesSuspendTenantErrors, type IdentitiesSuspendTenantResponse, type IdentitiesSuspendTenantResponses, type IdentitiesUpdateData, type IdentitiesUpdateError, type IdentitiesUpdateErrors, type IdentitiesUpdateResponse, type IdentitiesUpdateResponses, type Identity, type Invitation, type InvitationResponse, type KeysCreateData, type KeysCreateError, type KeysCreateErrors, type KeysCreateResponse, type KeysCreateResponses, type KeysGetData, type KeysGetError, type KeysGetErrors, type KeysGetResponse, type KeysGetResponses, type KeysListData, type KeysListError, type KeysListErrors, type KeysListResponse, type KeysListResponses, type KeysRevokeData, type KeysRevokeError, type KeysRevokeErrors, type KeysRevokeResponse, type KeysRevokeResponses, type KeysRotateData, type KeysRotateError, type KeysRotateErrors, type KeysRotateResponse, type KeysRotateResponses, type KeysUpdateData, type KeysUpdateError, type KeysUpdateErrors, type KeysUpdateResponse, type KeysUpdateResponses, type Label, type LabelRemoved, type LabelsCreateData, type LabelsCreateError, type LabelsCreateErrors, type LabelsCreateResponse, type LabelsCreateResponses, type LabelsDeleteData, type LabelsDeleteError, type LabelsDeleteErrors, type LabelsDeleteResponse, type LabelsDeleteResponses, type LabelsListData, type LabelsListError, type LabelsListErrors, type LabelsListResponse, type LabelsListResponses, type LabelsUpdateData, type LabelsUpdateError, type LabelsUpdateErrors, type LabelsUpdateResponse, type LabelsUpdateResponses, type Mailbox, type MailboxAccess, type MailboxChange, type MailboxesChangesData, type MailboxesChangesError, type MailboxesChangesErrors, type MailboxesChangesResponse, type MailboxesChangesResponses, type MailboxesEmptyTrashData, type MailboxesEmptyTrashError, type MailboxesEmptyTrashErrors, type MailboxesEmptyTrashResponse, type MailboxesEmptyTrashResponses, type MailboxesListData, type MailboxesListError, type MailboxesListErrors, type MailboxesListFolderData, type MailboxesListFolderError, type MailboxesListFolderErrors, type MailboxesListFolderResponse, type MailboxesListFolderResponses, type MailboxesListResponse, type MailboxesListResponses, type Me, type MeGetData, type MeGetError, type MeGetErrors, type MeGetResponse, type MeGetResponses, type Member, type Message, type MessageListItem, type MessagesActData, type MessagesActError, type MessagesActErrors, type MessagesActResponse, type MessagesActResponses, type MessagesAwaitData, type MessagesAwaitError, type MessagesAwaitErrors, type MessagesAwaitResponse, type MessagesAwaitResponses, type MessagesForwardData, type MessagesForwardError, type MessagesForwardErrors, type MessagesForwardResponse, type MessagesForwardResponses, type MessagesGetData, type MessagesGetError, type MessagesGetErrors, type MessagesGetResponse, type MessagesGetResponses, type MessagesListInThreadData, type MessagesListInThreadError, type MessagesListInThreadErrors, type MessagesListInThreadResponse, type MessagesListInThreadResponses, type MessagesRawData, type MessagesRawError, type MessagesRawErrors, type MessagesRawResponse, type MessagesRawResponses, type MessagesReplyAllData, type MessagesReplyAllError, type MessagesReplyAllErrors, type MessagesReplyAllResponse, type MessagesReplyAllResponses, type MessagesReplyData, type MessagesReplyError, type MessagesReplyErrors, type MessagesReplyResponse, type MessagesReplyResponses, type MessagesRespondToInvitationData, type MessagesRespondToInvitationError, type MessagesRespondToInvitationErrors, type MessagesRespondToInvitationResponse, type MessagesRespondToInvitationResponses, type MessagesSearchData, type MessagesSearchError, type MessagesSearchErrors, type MessagesSearchResponse, type MessagesSearchResponses, type MessagesSendData, type MessagesSendError, type MessagesSendErrors, type MessagesSendResponse, type MessagesSendResponses, type MessagesUndoData, type MessagesUndoError, type MessagesUndoErrors, type MessagesUndoResponse, type MessagesUndoResponses, type MessagesUpdateData, type MessagesUpdateError, type MessagesUpdateErrors, type MessagesUpdateResponse, type MessagesUpdateResponses, type Metrics, type MetricsQueryData, type MetricsQueryError, type MetricsQueryErrors, type MetricsQueryResponse, type MetricsQueryResponses, type Options, type Pod, type PodCreated, type PodDeleted, type PodsCreateData, type PodsCreateError, type PodsCreateErrors, type PodsCreateResponse, type PodsCreateResponses, type PodsDeleteData, type PodsDeleteError, type PodsDeleteErrors, type PodsDeleteResponse, type PodsDeleteResponses, type PodsGetData, type PodsGetError, type PodsGetErrors, type PodsGetResponse, type PodsGetResponses, type PodsListData, type PodsListError, type PodsListErrors, type PodsListResponse, type PodsListResponses, type PodsUpdateData, type PodsUpdateError, type PodsUpdateErrors, type PodsUpdateResponse, type PodsUpdateResponses, type ReceiveRuleRemoved, type ReceiveRules, type Replayed, type Restored, type Revoked, type RoutingCreateData, type RoutingCreateError, type RoutingCreateErrors, type RoutingCreateResponse, type RoutingCreateResponses, type RoutingDeleteData, type RoutingDeleteError, type RoutingDeleteErrors, type RoutingDeleteResponse, type RoutingDeleteResponses, type RoutingListData, type RoutingListError, type RoutingListErrors, type RoutingListResponse, type RoutingListResponses, type RoutingRule, type RoutingUpdateData, type RoutingUpdateError, type RoutingUpdateErrors, type RoutingUpdateResponse, type RoutingUpdateResponses, SIGNATURE_HEADER, type SearchHit, type SendRuleRemoved, type SendRules, type Sent, type SetupLink, type SignedUpload, type StreamOptions, type StreamedEvent, TIMESTAMP_HEADER, type TenantSuspended, type TestInboundData, type TestInboundDelivered, type TestInboundError, type TestInboundErrors, type TestInboundResponse, type TestInboundResponses, type Thread, type ThreadsGetData, type ThreadsGetError, type ThreadsGetErrors, type ThreadsGetResponse, type ThreadsGetResponses, type ThreadsLabelsCreateData, type ThreadsLabelsCreateError, type ThreadsLabelsCreateErrors, type ThreadsLabelsCreateResponse, type ThreadsLabelsCreateResponses, type ThreadsLabelsDeleteData, type ThreadsLabelsDeleteError, type ThreadsLabelsDeleteErrors, type ThreadsLabelsDeleteResponse, type ThreadsLabelsDeleteResponses, type ThreadsLabelsGetData, type ThreadsLabelsGetError, type ThreadsLabelsGetErrors, type ThreadsLabelsGetResponse, type ThreadsLabelsGetResponses, type ThreadsListData, type ThreadsListError, type ThreadsListErrors, type ThreadsListResponse, type ThreadsListResponses, type ThreadsUpdateData, type ThreadsUpdateError, type ThreadsUpdateErrors, type ThreadsUpdateResponse, type ThreadsUpdateResponses, type Undo, type UploadedAttachment, type Verification, type Warning, type Webhook, type WebhookCreated, type WebhookEnvelope, type WebhookHeaders, type WebhooksCreateData, type WebhooksCreateError, type WebhooksCreateErrors, type WebhooksCreateResponse, type WebhooksCreateResponses, type WebhooksDeleteData, type WebhooksDeleteError, type WebhooksDeleteErrors, type WebhooksDeleteResponse, type WebhooksDeleteResponses, type WebhooksDeliveriesData, type WebhooksDeliveriesError, type WebhooksDeliveriesErrors, type WebhooksDeliveriesResponse, type WebhooksDeliveriesResponses, type WebhooksGetData, type WebhooksGetError, type WebhooksGetErrors, type WebhooksGetHeadersData, type WebhooksGetHeadersError, type WebhooksGetHeadersErrors, type WebhooksGetHeadersResponse, type WebhooksGetHeadersResponses, type WebhooksGetResponse, type WebhooksGetResponses, type WebhooksListData, type WebhooksListError, type WebhooksListErrors, type WebhooksListResponse, type WebhooksListResponses, type WebhooksReplayData, type WebhooksReplayError, type WebhooksReplayErrors, type WebhooksReplayResponse, type WebhooksReplayResponses, type WebhooksUpdateData, type WebhooksUpdateError, type WebhooksUpdateErrors, type WebhooksUpdateHeadersData, type WebhooksUpdateHeadersError, type WebhooksUpdateHeadersErrors, type WebhooksUpdateHeadersResponse, type WebhooksUpdateHeadersResponses, type WebhooksUpdateResponse, type WebhooksUpdateResponses, type Workspace, type WorkspaceGetData, type WorkspaceGetError, type WorkspaceGetErrors, type WorkspaceGetResponse, type WorkspaceGetResponses, type WorkspaceMembersData, type WorkspaceMembersError, type WorkspaceMembersErrors, type WorkspaceMembersResponse, type WorkspaceMembersResponses, agentAttachHuman, agentConnect, agentSignUp, agentVerify, appPasswordsCreate, appPasswordsList, appPasswordsRevoke, attachmentsCompleteUpload, attachmentsCreateUpload, attachmentsDownloadUrl, attachmentsText, attachmentsUpload, calendarCreateEvent, calendarDeleteEvent, calendarGet, calendarGetAgenda, calendarGetEvent, calendarListEventInstances, calendarListEvents, calendarRespondToEvent, calendarUpdate, calendarUpdateEvent, client, createClient, createConfig, domainsCreate, domainsDelete, domainsGet, domainsGetSetupLink, domainsList, domainsUpdate, domainsVerify, domainsZoneFile, draftsApproval, draftsCancelSchedule, draftsCreate, draftsDelete, draftsGet, draftsList, draftsRemoveAttachment, draftsSchedule, draftsSend, draftsUpdate, eventsGet, eventsList, eventsSocket, eventsStream, exportMail, identitiesAccessCreate, identitiesAccessDelete, identitiesAccessGet, identitiesCreate, identitiesDelete, identitiesGet, identitiesList, identitiesReceiveRulesCreate, identitiesReceiveRulesDelete, identitiesReceiveRulesGet, identitiesSendRulesCreate, identitiesSendRulesDelete, identitiesSendRulesGet, identitiesSuspendTenant, identitiesUpdate, keysCreate, keysGet, keysList, keysRevoke, keysRotate, keysUpdate, labelsCreate, labelsDelete, labelsList, labelsUpdate, mailboxesChanges, mailboxesEmptyTrash, mailboxesList, mailboxesListFolder, meGet, messagesAct, messagesAwait, messagesForward, messagesGet, messagesListInThread, messagesRaw, messagesReply, messagesReplyAll, messagesRespondToInvitation, messagesSearch, messagesSend, messagesUndo, messagesUpdate, metricsQuery, podsCreate, podsDelete, podsGet, podsList, podsUpdate, routingCreate, routingDelete, routingList, routingUpdate, streamEvents, testInbound, threadsGet, threadsLabelsCreate, threadsLabelsDelete, threadsLabelsGet, threadsList, threadsUpdate, verifyWebhook, webhooksCreate, webhooksDelete, webhooksDeliveries, webhooksGet, webhooksGetHeaders, webhooksList, webhooksReplay, webhooksUpdate, webhooksUpdateHeaders, workspaceGet, workspaceMembers };
11318
+ export { type Address, type AgentAttachHumanData, type AgentAttachHumanError, type AgentAttachHumanErrors, type AgentAttachHumanResponse, type AgentAttachHumanResponses, type AgentConnectData, type AgentConnectError, type AgentConnectErrors, type AgentConnectResponse, type AgentConnectResponses, type AgentConnected, type AgentSetup, type AgentSetupData, type AgentSetupError, type AgentSetupErrors, type AgentSetupResponse, type AgentSetupResponses, type AgentSignUpData, type AgentSignUpError, type AgentSignUpErrors, type AgentSignUpResponse, type AgentSignUpResponses, type AgentSignup, type AgentVerified, type AgentVerifyData, type AgentVerifyError, type AgentVerifyErrors, type AgentVerifyResponse, type AgentVerifyResponses, type ApiKey, type ApiKeyCreated, type AppPassword, type AppPasswordCreated, type AppPasswordsCreateData, type AppPasswordsCreateError, type AppPasswordsCreateErrors, type AppPasswordsCreateResponse, type AppPasswordsCreateResponses, type AppPasswordsListData, type AppPasswordsListError, type AppPasswordsListErrors, type AppPasswordsListResponse, type AppPasswordsListResponses, type AppPasswordsRevokeData, type AppPasswordsRevokeError, type AppPasswordsRevokeErrors, type AppPasswordsRevokeResponse, type AppPasswordsRevokeResponses, type Approval, type Attachment, type AttachmentText, type AttachmentUrl, type AttachmentsCompleteUploadData, type AttachmentsCompleteUploadError, type AttachmentsCompleteUploadErrors, type AttachmentsCompleteUploadResponse, type AttachmentsCompleteUploadResponses, type AttachmentsCreateUploadData, type AttachmentsCreateUploadError, type AttachmentsCreateUploadErrors, type AttachmentsCreateUploadResponse, type AttachmentsCreateUploadResponses, type AttachmentsDownloadUrlData, type AttachmentsDownloadUrlError, type AttachmentsDownloadUrlErrors, type AttachmentsDownloadUrlResponse, type AttachmentsDownloadUrlResponses, type AttachmentsTextData, type AttachmentsTextError, type AttachmentsTextErrors, type AttachmentsTextResponse, type AttachmentsTextResponses, type AttachmentsUploadData, type AttachmentsUploadError, type AttachmentsUploadErrors, type AttachmentsUploadResponse, type AttachmentsUploadResponses, type AwaitedMessage, type Calendar, type CalendarCreateEventData, type CalendarCreateEventError, type CalendarCreateEventErrors, type CalendarCreateEventResponse, type CalendarCreateEventResponses, type CalendarDeleteEventData, type CalendarDeleteEventError, type CalendarDeleteEventErrors, type CalendarDeleteEventResponse, type CalendarDeleteEventResponses, type CalendarEvent, type CalendarGetAgendaData, type CalendarGetAgendaError, type CalendarGetAgendaErrors, type CalendarGetAgendaResponse, type CalendarGetAgendaResponses, type CalendarGetData, type CalendarGetError, type CalendarGetErrors, type CalendarGetEventData, type CalendarGetEventError, type CalendarGetEventErrors, type CalendarGetEventResponse, type CalendarGetEventResponses, type CalendarGetResponse, type CalendarGetResponses, type CalendarListEventInstancesData, type CalendarListEventInstancesError, type CalendarListEventInstancesErrors, type CalendarListEventInstancesResponse, type CalendarListEventInstancesResponses, type CalendarListEventsData, type CalendarListEventsError, type CalendarListEventsErrors, type CalendarListEventsResponse, type CalendarListEventsResponses, type CalendarRespondToEventData, type CalendarRespondToEventError, type CalendarRespondToEventErrors, type CalendarRespondToEventResponse, type CalendarRespondToEventResponses, type CalendarUpdateData, type CalendarUpdateError, type CalendarUpdateErrors, type CalendarUpdateEventData, type CalendarUpdateEventError, type CalendarUpdateEventErrors, type CalendarUpdateEventResponse, type CalendarUpdateEventResponses, type CalendarUpdateResponse, type CalendarUpdateResponses, type ClientOptions, type CreateClientConfig, type CreatedDomain, type Deleted, type Delivery, type DnsRecord, type Domain, type DomainDetail, type DomainsCreateData, type DomainsCreateError, type DomainsCreateErrors, type DomainsCreateResponse, type DomainsCreateResponses, type DomainsDeleteData, type DomainsDeleteError, type DomainsDeleteErrors, type DomainsDeleteResponse, type DomainsDeleteResponses, type DomainsGetData, type DomainsGetError, type DomainsGetErrors, type DomainsGetResponse, type DomainsGetResponses, type DomainsGetSetupLinkData, type DomainsGetSetupLinkError, type DomainsGetSetupLinkErrors, type DomainsGetSetupLinkResponse, type DomainsGetSetupLinkResponses, type DomainsListData, type DomainsListError, type DomainsListErrors, type DomainsListResponse, type DomainsListResponses, type DomainsUpdateData, type DomainsUpdateError, type DomainsUpdateErrors, type DomainsUpdateResponse, type DomainsUpdateResponses, type DomainsVerifyData, type DomainsVerifyError, type DomainsVerifyErrors, type DomainsVerifyResponse, type DomainsVerifyResponses, type DomainsZoneFileData, type DomainsZoneFileError, type DomainsZoneFileErrors, type DomainsZoneFileResponse, type DomainsZoneFileResponses, type Draft, type DraftsApprovalData, type DraftsApprovalError, type DraftsApprovalErrors, type DraftsApprovalResponse, type DraftsApprovalResponses, type DraftsCancelScheduleData, type DraftsCancelScheduleError, type DraftsCancelScheduleErrors, type DraftsCancelScheduleResponse, type DraftsCancelScheduleResponses, type DraftsCreateData, type DraftsCreateError, type DraftsCreateErrors, type DraftsCreateResponse, type DraftsCreateResponses, type DraftsDeleteData, type DraftsDeleteError, type DraftsDeleteErrors, type DraftsDeleteResponse, type DraftsDeleteResponses, type DraftsGetData, type DraftsGetError, type DraftsGetErrors, type DraftsGetResponse, type DraftsGetResponses, type DraftsListData, type DraftsListError, type DraftsListErrors, type DraftsListResponse, type DraftsListResponses, type DraftsRemoveAttachmentData, type DraftsRemoveAttachmentError, type DraftsRemoveAttachmentErrors, type DraftsRemoveAttachmentResponse, type DraftsRemoveAttachmentResponses, type DraftsScheduleData, type DraftsScheduleError, type DraftsScheduleErrors, type DraftsScheduleResponse, type DraftsScheduleResponses, type DraftsSendData, type DraftsSendError, type DraftsSendErrors, type DraftsSendResponse, type DraftsSendResponses, type DraftsUpdateData, type DraftsUpdateError, type DraftsUpdateErrors, type DraftsUpdateResponse, type DraftsUpdateResponses, type Emptied, type Error, type Event, type EventResponse, type EventsGetData, type EventsGetError, type EventsGetErrors, type EventsGetResponse, type EventsGetResponses, type EventsListData, type EventsListError, type EventsListErrors, type EventsListResponse, type EventsListResponses, type EventsSocketData, type EventsSocketError, type EventsSocketErrors, type EventsStreamData, type EventsStreamError, type EventsStreamErrors, type EventsStreamResponse, type EventsStreamResponses, type ExportMailData, type ExportMailError, type ExportMailErrors, type ExportMailResponse, type ExportMailResponses, type IdentitiesAccessCreateData, type IdentitiesAccessCreateError, type IdentitiesAccessCreateErrors, type IdentitiesAccessCreateResponse, type IdentitiesAccessCreateResponses, type IdentitiesAccessDeleteData, type IdentitiesAccessDeleteError, type IdentitiesAccessDeleteErrors, type IdentitiesAccessDeleteResponse, type IdentitiesAccessDeleteResponses, type IdentitiesAccessGetData, type IdentitiesAccessGetError, type IdentitiesAccessGetErrors, type IdentitiesAccessGetResponse, type IdentitiesAccessGetResponses, type IdentitiesCreateData, type IdentitiesCreateError, type IdentitiesCreateErrors, type IdentitiesCreateResponse, type IdentitiesCreateResponses, type IdentitiesDeleteData, type IdentitiesDeleteError, type IdentitiesDeleteErrors, type IdentitiesDeleteResponse, type IdentitiesDeleteResponses, type IdentitiesGetData, type IdentitiesGetError, type IdentitiesGetErrors, type IdentitiesGetResponse, type IdentitiesGetResponses, type IdentitiesListData, type IdentitiesListError, type IdentitiesListErrors, type IdentitiesListResponse, type IdentitiesListResponses, type IdentitiesReceiveRulesCreateData, type IdentitiesReceiveRulesCreateError, type IdentitiesReceiveRulesCreateErrors, type IdentitiesReceiveRulesCreateResponse, type IdentitiesReceiveRulesCreateResponses, type IdentitiesReceiveRulesDeleteData, type IdentitiesReceiveRulesDeleteError, type IdentitiesReceiveRulesDeleteErrors, type IdentitiesReceiveRulesDeleteResponse, type IdentitiesReceiveRulesDeleteResponses, type IdentitiesReceiveRulesGetData, type IdentitiesReceiveRulesGetError, type IdentitiesReceiveRulesGetErrors, type IdentitiesReceiveRulesGetResponse, type IdentitiesReceiveRulesGetResponses, type IdentitiesSendRulesCreateData, type IdentitiesSendRulesCreateError, type IdentitiesSendRulesCreateErrors, type IdentitiesSendRulesCreateResponse, type IdentitiesSendRulesCreateResponses, type IdentitiesSendRulesDeleteData, type IdentitiesSendRulesDeleteError, type IdentitiesSendRulesDeleteErrors, type IdentitiesSendRulesDeleteResponse, type IdentitiesSendRulesDeleteResponses, type IdentitiesSendRulesGetData, type IdentitiesSendRulesGetError, type IdentitiesSendRulesGetErrors, type IdentitiesSendRulesGetResponse, type IdentitiesSendRulesGetResponses, type IdentitiesSuspendTenantData, type IdentitiesSuspendTenantError, type IdentitiesSuspendTenantErrors, type IdentitiesSuspendTenantResponse, type IdentitiesSuspendTenantResponses, type IdentitiesUpdateData, type IdentitiesUpdateError, type IdentitiesUpdateErrors, type IdentitiesUpdateResponse, type IdentitiesUpdateResponses, type Identity, type Invitation, type InvitationResponse, type KeysCreateData, type KeysCreateError, type KeysCreateErrors, type KeysCreateResponse, type KeysCreateResponses, type KeysGetData, type KeysGetError, type KeysGetErrors, type KeysGetResponse, type KeysGetResponses, type KeysListData, type KeysListError, type KeysListErrors, type KeysListResponse, type KeysListResponses, type KeysRevokeData, type KeysRevokeError, type KeysRevokeErrors, type KeysRevokeResponse, type KeysRevokeResponses, type KeysRotateData, type KeysRotateError, type KeysRotateErrors, type KeysRotateResponse, type KeysRotateResponses, type KeysUpdateData, type KeysUpdateError, type KeysUpdateErrors, type KeysUpdateResponse, type KeysUpdateResponses, type Label, type LabelRemoved, type LabelsCreateData, type LabelsCreateError, type LabelsCreateErrors, type LabelsCreateResponse, type LabelsCreateResponses, type LabelsDeleteData, type LabelsDeleteError, type LabelsDeleteErrors, type LabelsDeleteResponse, type LabelsDeleteResponses, type LabelsListData, type LabelsListError, type LabelsListErrors, type LabelsListResponse, type LabelsListResponses, type LabelsUpdateData, type LabelsUpdateError, type LabelsUpdateErrors, type LabelsUpdateResponse, type LabelsUpdateResponses, type Mailbox, type MailboxAccess, type MailboxChange, type MailboxesChangesData, type MailboxesChangesError, type MailboxesChangesErrors, type MailboxesChangesResponse, type MailboxesChangesResponses, type MailboxesEmptyTrashData, type MailboxesEmptyTrashError, type MailboxesEmptyTrashErrors, type MailboxesEmptyTrashResponse, type MailboxesEmptyTrashResponses, type MailboxesListData, type MailboxesListError, type MailboxesListErrors, type MailboxesListFolderData, type MailboxesListFolderError, type MailboxesListFolderErrors, type MailboxesListFolderResponse, type MailboxesListFolderResponses, type MailboxesListResponse, type MailboxesListResponses, type Me, type MeGetData, type MeGetError, type MeGetErrors, type MeGetResponse, type MeGetResponses, type Member, type Message, type MessageListItem, type MessagesActData, type MessagesActError, type MessagesActErrors, type MessagesActResponse, type MessagesActResponses, type MessagesAwaitData, type MessagesAwaitError, type MessagesAwaitErrors, type MessagesAwaitResponse, type MessagesAwaitResponses, type MessagesCheckData, type MessagesCheckError, type MessagesCheckErrors, type MessagesCheckResponse, type MessagesCheckResponses, type MessagesForwardData, type MessagesForwardError, type MessagesForwardErrors, type MessagesForwardResponse, type MessagesForwardResponses, type MessagesGetData, type MessagesGetError, type MessagesGetErrors, type MessagesGetResponse, type MessagesGetResponses, type MessagesListInThreadData, type MessagesListInThreadError, type MessagesListInThreadErrors, type MessagesListInThreadResponse, type MessagesListInThreadResponses, type MessagesRawData, type MessagesRawError, type MessagesRawErrors, type MessagesRawResponse, type MessagesRawResponses, type MessagesReplyAllData, type MessagesReplyAllError, type MessagesReplyAllErrors, type MessagesReplyAllResponse, type MessagesReplyAllResponses, type MessagesReplyData, type MessagesReplyError, type MessagesReplyErrors, type MessagesReplyResponse, type MessagesReplyResponses, type MessagesRespondToInvitationData, type MessagesRespondToInvitationError, type MessagesRespondToInvitationErrors, type MessagesRespondToInvitationResponse, type MessagesRespondToInvitationResponses, type MessagesSearchData, type MessagesSearchError, type MessagesSearchErrors, type MessagesSearchResponse, type MessagesSearchResponses, type MessagesSendData, type MessagesSendError, type MessagesSendErrors, type MessagesSendResponse, type MessagesSendResponses, type MessagesUndoData, type MessagesUndoError, type MessagesUndoErrors, type MessagesUndoResponse, type MessagesUndoResponses, type MessagesUpdateData, type MessagesUpdateError, type MessagesUpdateErrors, type MessagesUpdateResponse, type MessagesUpdateResponses, type Metrics, type MetricsQueryData, type MetricsQueryError, type MetricsQueryErrors, type MetricsQueryResponse, type MetricsQueryResponses, type Options, type Pod, type PodCreated, type PodDeleted, type PodsCreateData, type PodsCreateError, type PodsCreateErrors, type PodsCreateResponse, type PodsCreateResponses, type PodsDeleteData, type PodsDeleteError, type PodsDeleteErrors, type PodsDeleteResponse, type PodsDeleteResponses, type PodsGetData, type PodsGetError, type PodsGetErrors, type PodsGetResponse, type PodsGetResponses, type PodsListData, type PodsListError, type PodsListErrors, type PodsListResponse, type PodsListResponses, type PodsUpdateData, type PodsUpdateError, type PodsUpdateErrors, type PodsUpdateResponse, type PodsUpdateResponses, type ReceiveRuleRemoved, type ReceiveRules, type Replayed, type Restored, type Revoked, type RoutingCreateData, type RoutingCreateError, type RoutingCreateErrors, type RoutingCreateResponse, type RoutingCreateResponses, type RoutingDeleteData, type RoutingDeleteError, type RoutingDeleteErrors, type RoutingDeleteResponse, type RoutingDeleteResponses, type RoutingListData, type RoutingListError, type RoutingListErrors, type RoutingListResponse, type RoutingListResponses, type RoutingRule, type RoutingUpdateData, type RoutingUpdateError, type RoutingUpdateErrors, type RoutingUpdateResponse, type RoutingUpdateResponses, SIGNATURE_HEADER, type SearchHit, type SendCheck, type SendRuleRemoved, type SendRules, type Sent, type SetupLink, type SignedUpload, type StreamOptions, type StreamedEvent, TIMESTAMP_HEADER, type TenantSuspended, type TestInboundData, type TestInboundDelivered, type TestInboundError, type TestInboundErrors, type TestInboundResponse, type TestInboundResponses, type Thread, type ThreadsGetData, type ThreadsGetError, type ThreadsGetErrors, type ThreadsGetResponse, type ThreadsGetResponses, type ThreadsLabelsCreateData, type ThreadsLabelsCreateError, type ThreadsLabelsCreateErrors, type ThreadsLabelsCreateResponse, type ThreadsLabelsCreateResponses, type ThreadsLabelsDeleteData, type ThreadsLabelsDeleteError, type ThreadsLabelsDeleteErrors, type ThreadsLabelsDeleteResponse, type ThreadsLabelsDeleteResponses, type ThreadsLabelsGetData, type ThreadsLabelsGetError, type ThreadsLabelsGetErrors, type ThreadsLabelsGetResponse, type ThreadsLabelsGetResponses, type ThreadsListData, type ThreadsListError, type ThreadsListErrors, type ThreadsListResponse, type ThreadsListResponses, type ThreadsUpdateData, type ThreadsUpdateError, type ThreadsUpdateErrors, type ThreadsUpdateResponse, type ThreadsUpdateResponses, type Undo, type UploadedAttachment, type Verification, type Warning, type Webhook, type WebhookCreated, type WebhookEnvelope, type WebhookHeaders, type WebhooksCreateData, type WebhooksCreateError, type WebhooksCreateErrors, type WebhooksCreateResponse, type WebhooksCreateResponses, type WebhooksDeleteData, type WebhooksDeleteError, type WebhooksDeleteErrors, type WebhooksDeleteResponse, type WebhooksDeleteResponses, type WebhooksDeliveriesData, type WebhooksDeliveriesError, type WebhooksDeliveriesErrors, type WebhooksDeliveriesResponse, type WebhooksDeliveriesResponses, type WebhooksGetData, type WebhooksGetError, type WebhooksGetErrors, type WebhooksGetHeadersData, type WebhooksGetHeadersError, type WebhooksGetHeadersErrors, type WebhooksGetHeadersResponse, type WebhooksGetHeadersResponses, type WebhooksGetResponse, type WebhooksGetResponses, type WebhooksListData, type WebhooksListError, type WebhooksListErrors, type WebhooksListResponse, type WebhooksListResponses, type WebhooksReplayData, type WebhooksReplayError, type WebhooksReplayErrors, type WebhooksReplayResponse, type WebhooksReplayResponses, type WebhooksUpdateData, type WebhooksUpdateError, type WebhooksUpdateErrors, type WebhooksUpdateHeadersData, type WebhooksUpdateHeadersError, type WebhooksUpdateHeadersErrors, type WebhooksUpdateHeadersResponse, type WebhooksUpdateHeadersResponses, type WebhooksUpdateResponse, type WebhooksUpdateResponses, type Workspace, type WorkspaceGetData, type WorkspaceGetError, type WorkspaceGetErrors, type WorkspaceGetResponse, type WorkspaceGetResponses, type WorkspaceMembersData, type WorkspaceMembersError, type WorkspaceMembersErrors, type WorkspaceMembersResponse, type WorkspaceMembersResponses, agentAttachHuman, agentConnect, agentSetup, agentSignUp, agentVerify, appPasswordsCreate, appPasswordsList, appPasswordsRevoke, attachmentsCompleteUpload, attachmentsCreateUpload, attachmentsDownloadUrl, attachmentsText, attachmentsUpload, calendarCreateEvent, calendarDeleteEvent, calendarGet, calendarGetAgenda, calendarGetEvent, calendarListEventInstances, calendarListEvents, calendarRespondToEvent, calendarUpdate, calendarUpdateEvent, client, createClient, createConfig, domainsCreate, domainsDelete, domainsGet, domainsGetSetupLink, domainsList, domainsUpdate, domainsVerify, domainsZoneFile, draftsApproval, draftsCancelSchedule, draftsCreate, draftsDelete, draftsGet, draftsList, draftsRemoveAttachment, draftsSchedule, draftsSend, draftsUpdate, eventsGet, eventsList, eventsSocket, eventsStream, exportMail, identitiesAccessCreate, identitiesAccessDelete, identitiesAccessGet, identitiesCreate, identitiesDelete, identitiesGet, identitiesList, identitiesReceiveRulesCreate, identitiesReceiveRulesDelete, identitiesReceiveRulesGet, identitiesSendRulesCreate, identitiesSendRulesDelete, identitiesSendRulesGet, identitiesSuspendTenant, identitiesUpdate, keysCreate, keysGet, keysList, keysRevoke, keysRotate, keysUpdate, labelsCreate, labelsDelete, labelsList, labelsUpdate, mailboxesChanges, mailboxesEmptyTrash, mailboxesList, mailboxesListFolder, meGet, messagesAct, messagesAwait, messagesCheck, messagesForward, messagesGet, messagesListInThread, messagesRaw, messagesReply, messagesReplyAll, messagesRespondToInvitation, messagesSearch, messagesSend, messagesUndo, messagesUpdate, metricsQuery, podsCreate, podsDelete, podsGet, podsList, podsUpdate, routingCreate, routingDelete, routingList, routingUpdate, streamEvents, testInbound, threadsGet, threadsLabelsCreate, threadsLabelsDelete, threadsLabelsGet, threadsList, threadsUpdate, verifyWebhook, webhooksCreate, webhooksDelete, webhooksDeliveries, webhooksGet, webhooksGetHeaders, webhooksList, webhooksReplay, webhooksUpdate, webhooksUpdateHeaders, workspaceGet, workspaceMembers };