@messagebird/sdk 0.30.0 → 0.31.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.mts CHANGED
@@ -2885,6 +2885,10 @@ type SmsInboundStatsByNumberResponse = {
2885
2885
  */
2886
2886
  readonly total: number;
2887
2887
  };
2888
+ /**
2889
+ * Identifier of a number allocated to your workspace, as returned in the id field of `GET /v1/numbers`.
2890
+ */
2891
+ type AllocatedNumberId = string;
2888
2892
  /**
2889
2893
  * An intelligence property you can add to a base phone number lookup.
2890
2894
  *
@@ -2976,8 +2980,9 @@ type LookupLineType = "mobile" | "fixed_line" | "voip" | "toll_free" | "premium_
2976
2980
  * from the base lookup. The property is not billed.
2977
2981
  * - `inconclusive`: an answer arrived but does not resolve the
2978
2982
  * property, either because the number is outside the coverage of the data
2979
- * behind it or because the answer is one we cannot yet place. It is a real
2980
- * answer rather than a missing one, and it is not billed either.
2983
+ * behind it or because the source returned a value this property does not
2984
+ * report. It is a real answer rather than a missing one, and it is not
2985
+ * billed either.
2981
2986
  *
2982
2987
  * Open enum: further statuses may be added over time, so treat an unrecognized
2983
2988
  * value as a future one rather than an error. Only `ok` carries a value and only
@@ -3307,16 +3312,6 @@ type VerificationChannel$1 = "email" | "sms" | "whatsapp" | "telegram" | (string
3307
3312
  type VerificationChannelEntry = {
3308
3313
  channel: VerificationChannel$1;
3309
3314
  };
3310
- type Money = {
3311
- /**
3312
- * Decimal amount as a string, in major currency units.
3313
- */
3314
- amount: string;
3315
- /**
3316
- * ISO 4217 currency code.
3317
- */
3318
- currency_code: CurrencyCode;
3319
- };
3320
3315
  /**
3321
3316
  * Why a passcode send did not deliver:
3322
3317
  *
@@ -3733,11 +3728,12 @@ type WhatsAppUnsupported = {
3733
3728
  * - `service_window_expired`: The 24-hour service window closed; send a template.
3734
3729
  * - `rate_limited`: The send was throttled.
3735
3730
  * - `recipient_suppressed`: The recipient is on the workspace suppression list.
3731
+ * - `media_rejected`: WhatsApp could not fetch the media URL, or refused the file it found there; `description` carries its reason.
3736
3732
  *
3737
3733
  * This is an open enum. Accept unrecognized values.
3738
3734
  *
3739
3735
  */
3740
- type WhatsAppErrorCode$1 = "insufficient_balance" | "price_not_found" | "internal_error" | "undeliverable" | "service_window_expired" | "rate_limited" | "recipient_suppressed" | (string & {});
3736
+ type WhatsAppErrorCode$1 = "insufficient_balance" | "price_not_found" | "internal_error" | "undeliverable" | "service_window_expired" | "rate_limited" | "recipient_suppressed" | "media_rejected" | (string & {});
3741
3737
  /**
3742
3738
  * Failure detail for a message that could not be delivered or was rejected.
3743
3739
  */
@@ -3972,7 +3968,7 @@ type WhatsAppMessageSendRequest = {
3972
3968
  */
3973
3969
  to: string;
3974
3970
  /**
3975
- * The business phone number to send from, in E.164 format. Omit it for a Bird-managed template, which selects its own number from its category: setting it there returns a `422` `WhatsAppSenderNotAllowed`. Every other send, whether free-form content of any kind or a template your workspace authored, requires it, and the number must be one this workspace owns. Omitting it returns a `422` `WhatsAppSenderRequired`, and naming a number this workspace cannot send from returns a `422` `WhatsAppSenderNotFound`. Naming a number this workspace owns but that sits on a different WhatsApp Business Account than an authored template returns a `422` `WhatsAppSenderWABAMismatch`.
3971
+ * The business phone number to send from, in E.164 format. Omit it for a Bird-managed template, which selects its own number from its category: setting it there returns a `422` `WhatsAppSenderNotAllowed`. Every other send, whether free-form content of any kind or a template your workspace authored, requires it, and the number must be one this workspace owns. Omitting it returns a `422` `WhatsAppSenderRequired`, and naming a number this workspace cannot send from returns a `422` `WhatsAppSenderNotFound`. Naming a number this workspace owns but that sits on a different WhatsApp Business Account than an authored template returns a `422` `WhatsAppSenderWABAMismatch`. A number this workspace holds but has not finished connecting returns a `422` `WhatsAppSenderNotConnected`.
3976
3972
  *
3977
3973
  */
3978
3974
  from?: string;
@@ -4728,7 +4724,7 @@ type EmailStatsByCategoryResponse = {
4728
4724
  readonly total: number;
4729
4725
  };
4730
4726
  /**
4731
- * Metric to rank rows by, applied descending. Shared by the breakdowns whose attribution begins at delivery (mailbox providers, mailbox provider regions): `processed`, `rejected`, and `oob_bounces` are not part of those rows, so they are not sortable. Any count or rate on the row can be used; rows whose rate is undefined (zero denominator) sort last. Bounce sub-types use their nested location in each row, for example `bounces.hard` and `bounces.hard_rate`.
4727
+ * Metric to rank rows by, applied descending. Shared by every breakdown whose attribution begins at delivery, so `processed`, `rejected`, and `oob_bounces` are not part of those rows and are not sortable. Any count or rate on the row can be used; rows whose rate is undefined (zero denominator) sort last. Bounce sub-types use their nested location in each row, for example `bounces.hard` and `bounces.hard_rate`.
4732
4728
  *
4733
4729
  */
4734
4730
  type EmailMailboxProviderSortMetric = "delivered" | "bounced" | "complained" | "deferred" | "bounces.hard" | "bounces.soft" | "bounces.admin" | "bounces.block" | "bounces.undetermined" | "opens" | "opens_non_prefetched" | "unique_opens" | "unique_opens_non_prefetched" | "clicks" | "unique_clicks" | "unsubscribes" | "delivery_rate" | "bounce_rate" | "complaint_rate" | "open_rate" | "click_rate" | "unsubscribe_rate" | "bounces.hard_rate" | "bounces.soft_rate" | "bounces.admin_rate" | "bounces.block_rate" | "bounces.undetermined_rate";
@@ -5303,7 +5299,10 @@ type DnsRecord = {
5303
5299
  * - `inbound_mx`: identifies the MX record routing mail to us for receiving.
5304
5300
  * Always present wherever inbound is available, as a regional reference,
5305
5301
  * regardless of whether receiving is enabled; publishing it does not
5306
- * enable receiving on its own: see `DomainUpdate.inbound`.
5302
+ * enable receiving on its own: see `DomainUpdate.inbound`. It is
5303
+ * `optional` until receiving is enabled, and publishing it before then
5304
+ * is destructive: on a domain at the zone apex it replaces the MX
5305
+ * records that carry the domain's existing mail.
5307
5306
  * - `dmarc`: identifies the advisory DMARC policy record.
5308
5307
  *
5309
5308
  */
@@ -5321,7 +5320,7 @@ type DnsRecord = {
5321
5320
  */
5322
5321
  readonly state: "active" | "pending" | "deprecated";
5323
5322
  /**
5324
- * Whether this record can be skipped. Optional records enable extra functionality (for example, tracking) but are not required for sending.
5323
+ * Whether this record can be skipped. An optional record enables extra functionality (branded tracking, or receiving) rather than sending, so publish one only when you want what it enables. The `inbound_mx` records are optional until you enable receiving on the domain, and publishing one before then changes where mail to the domain is delivered.
5325
5324
  *
5326
5325
  */
5327
5326
  readonly optional: boolean;
@@ -7583,13 +7582,25 @@ type EventVoiceCallAnswered = {
7583
7582
  /**
7584
7583
  * Call status.
7585
7584
  *
7586
- * A call that has ended carries `answered`, `no_answer`, `failed`, `rejected`, or
7587
- * `unknown`. An active call carries `ringing` before it is picked up and
7588
- * `in_progress` afterward. The call list's `status` filter uses both values to
7589
- * select calls happening now.
7585
+ * A call that has ended carries one of:
7586
+ *
7587
+ * - `answered` means it connected and the far end picked up.
7588
+ * - `no_answer` means nobody picked up before the call timed out.
7589
+ * - `rejected` means it was refused rather than attempted. Either we turned it
7590
+ * away before dialing a carrier, in which case `rejection_reason` names the
7591
+ * check it failed where there was one, or the far end declined it.
7592
+ * - `failed` means it was attempted and did not work, and `sip_response_code`
7593
+ * is what came back.
7594
+ * - `unknown` means the outcome could not be determined. Contact support with
7595
+ * the call `id` if you see one.
7596
+ *
7597
+ * An active call carries `ringing` before it is picked up and `in_progress`
7598
+ * afterward. The call list's `status` filter takes any mix of the two sets.
7590
7599
  *
7591
- * `busy` and `canceled` are reserved and are not currently emitted. Both
7592
- * outcomes are currently reported as `failed`.
7600
+ * `busy` and `canceled` are reserved for incoming calls delivered to your own
7601
+ * numbers: `busy` for a called party that rejected the call as busy, `canceled`
7602
+ * for a caller who hung up before it was picked up. Neither is emitted yet and
7603
+ * both outcomes are reported as `failed` today.
7593
7604
  *
7594
7605
  */
7595
7606
  type VoiceCallStatus = "answered" | "no_answer" | "busy" | "canceled" | "failed" | "rejected" | "unknown" | "ringing" | "in_progress";
@@ -7854,19 +7865,168 @@ type EventWhatsAppSent = {
7854
7865
  };
7855
7866
  type AuditLogActor = {
7856
7867
  /**
7857
- * ID of the user, API key, or system process that performed the action.
7868
+ * ID of the user, API key, integration, or system process that performed the action.
7858
7869
  */
7859
7870
  id: string;
7860
7871
  /**
7861
- * Type of actor, such as `user`, `api_key`, or `system`.
7872
+ * Type of actor, such as `user`, `api_key`, `service_account`, or `system`.
7862
7873
  */
7863
7874
  type: string;
7864
7875
  /**
7865
- * Display name of the actor. This is the user's email address for a `user` actor or the API key name for an `api_key` actor. Absent when it could not be resolved.
7876
+ * Display name of the actor. This is the user's email address for a `user` actor, or the name of the API key or integration that acted. Absent when it could not be resolved.
7866
7877
  *
7867
7878
  */
7868
7879
  readonly display_name?: string | null;
7869
7880
  };
7881
+ /**
7882
+ * Physical type of a phone number. New number types may be added over time, so treat unrecognized values as supported types rather than errors.
7883
+ */
7884
+ type NumberType$1 = "mobile" | "local" | "national" | "short_code" | "short_code_fteu" | "toll_free" | (string & {});
7885
+ /**
7886
+ * Channel capability supported by a phone number. New capabilities may be added over time, so treat unrecognized values as supported capabilities rather than errors.
7887
+ */
7888
+ type NumberCapability$1 = "sms" | "mms" | "voice" | (string & {});
7889
+ /**
7890
+ * Where this number stands with the ownership paperwork its country requires before it may carry traffic. Present only for a number whose country requires any, so its absence means no paperwork was ever asked for and this number is unconditionally usable. Absent as well when the requirement cannot be established right now, since reporting either answer would state something about your paperwork that has not been checked.
7891
+ *
7892
+ */
7893
+ type NumberOwnership = {
7894
+ /**
7895
+ * Whether the paperwork is accepted. Read `next` for what advances it while this is false. Whether sending is currently refused is reported by `blocked_at` instead: a number bought before its country asked for anything is unsatisfied and still usable until a review says otherwise.
7896
+ *
7897
+ */
7898
+ readonly satisfied: boolean;
7899
+ /**
7900
+ * When the number stopped being able to carry traffic, and null while it can. Always null when `satisfied` is true, but null does not imply it: a number whose country began asking after you bought it is usable with its paperwork still outstanding. A number can also arrive blocked, and one that was usable can be blocked again if its approval is withdrawn.
7901
+ *
7902
+ */
7903
+ readonly blocked_at?: string | null;
7904
+ /**
7905
+ * What you do about it, in the order to do it. Empty only when `satisfied` is true, so while anything is outstanding there is always at least one step. When what you already sent is being reviewed and nothing is needed from you, that step has kind `wait` and says so. Re-read it after each call rather than caching the first list you saw.
7906
+ *
7907
+ */
7908
+ readonly next: Array<NextAction$1>;
7909
+ };
7910
+ type Number = {
7911
+ /**
7912
+ * Identifier of this allocated number. Pass it as `number_id` to read this number, or to release it when kind is dedicated.
7913
+ */
7914
+ readonly id: AllocatedNumberId;
7915
+ /**
7916
+ * How this number is allocated. `dedicated` is allocated to this workspace alone and billed as a subscription. `shared` is a shortcode allocated to several workspaces at once and managed by us.
7917
+ */
7918
+ readonly kind: "dedicated" | "shared";
7919
+ /**
7920
+ * Phone number in E.164 format.
7921
+ */
7922
+ readonly number: string;
7923
+ readonly country_code: CountryCode;
7924
+ /**
7925
+ * Physical type of this phone number.
7926
+ */
7927
+ readonly number_type: NumberType$1;
7928
+ /**
7929
+ * Channel capabilities supported by this number.
7930
+ */
7931
+ readonly capabilities: Array<NumberCapability$1>;
7932
+ /**
7933
+ * Whether this number can carry traffic.
7934
+ *
7935
+ * - `active` means this number is allocated to your workspace and usable.
7936
+ * - `pending_compliance` means this number is allocated to your workspace and billed,
7937
+ * but it cannot carry traffic until the ownership paperwork its country requires is
7938
+ * accepted. Read `ownership.next` for what advances it, and re-read later if
7939
+ * `ownership` is momentarily `null`.
7940
+ * - `released` means this number is no longer allocated to your workspace.
7941
+ *
7942
+ * An allocated number is not always enough to send from it: some destination
7943
+ * countries also require an approved registration for the sender.
7944
+ *
7945
+ */
7946
+ readonly status: "active" | "pending_compliance" | "released";
7947
+ /**
7948
+ * When this number was allocated to your workspace.
7949
+ */
7950
+ readonly allocated_at: string;
7951
+ /**
7952
+ * When this number was released. `null` while it is still allocated to your workspace.
7953
+ */
7954
+ readonly released_at?: string | null;
7955
+ /**
7956
+ * Where this number stands with the ownership paperwork its country requires. `null` when the country requires none, which is the usual case: a number with no `ownership` object is usable as soon as it is allocated. Also `null` when that standing cannot be established right now; `status` still reads `pending_compliance` while the number is blocked, so re-read this field rather than caching its absence. We manage the paperwork for shared short codes, so this field is always `null` for them.
7957
+ *
7958
+ */
7959
+ readonly ownership?: NumberOwnership | null;
7960
+ };
7961
+ type AvailableNumber = {
7962
+ /**
7963
+ * Phone number in E.164 format.
7964
+ */
7965
+ number: string;
7966
+ country_code: CountryCode;
7967
+ /**
7968
+ * Physical type of this phone number.
7969
+ */
7970
+ number_type: NumberType$1;
7971
+ /**
7972
+ * Channel capabilities supported by this number.
7973
+ */
7974
+ capabilities: Array<NumberCapability$1>;
7975
+ };
7976
+ /**
7977
+ * Lifecycle state of a number purchase order:
7978
+ *
7979
+ * - `charging`: Securing funds.
7980
+ * - `ordering`: Placing the order with the carrier.
7981
+ * - `pending`: The carrier accepted the order and is provisioning the number.
7982
+ * - `completed`: Your workspace owns the number.
7983
+ * - `failed`: The purchase did not complete.
7984
+ *
7985
+ * A setup fee already charged is non-refundable. Contact support about a failed
7986
+ * order.
7987
+ */
7988
+ type NumbersOrderStatus$1 = "charging" | "ordering" | "pending" | "completed" | "failed" | (string & {});
7989
+ type NumbersOrderId = string;
7990
+ type NumbersDedicatedAllocationId = string;
7991
+ type NumbersOrder = {
7992
+ /**
7993
+ * Identifier of this purchase order.
7994
+ */
7995
+ readonly id: NumbersOrderId;
7996
+ /**
7997
+ * The number being acquired, in E.164 format.
7998
+ */
7999
+ readonly number: string;
8000
+ readonly country_code: CountryCode;
8001
+ /**
8002
+ * Physical type of the number being acquired.
8003
+ */
8004
+ readonly number_type: NumberType$1;
8005
+ readonly status: NumbersOrderStatus$1;
8006
+ /**
8007
+ * Identifier of the number this order produced, set when `status` is `completed`. Pass it as `number_id` to `GET /v1/numbers/{number_id}` or `DELETE /v1/numbers/{number_id}`. `null` until the order completes.
8008
+ *
8009
+ */
8010
+ readonly number_id?: NumbersDedicatedAllocationId | null;
8011
+ /**
8012
+ * Human-readable reason the purchase failed. `null` unless status is failed. An order can fail some time after it was created, so `updated_at` tells you when the failure was recorded rather than when the order was placed.
8013
+ *
8014
+ */
8015
+ readonly failure_reason?: string | null;
8016
+ /**
8017
+ * When the purchase completed and the number became owned (status completed). `null` for orders still in progress or failed.
8018
+ *
8019
+ */
8020
+ readonly completed_at?: string | null;
8021
+ readonly created_at: string;
8022
+ readonly updated_at: string;
8023
+ };
8024
+ type NumbersOrderCreate = {
8025
+ /**
8026
+ * The number to acquire, in E.164 format, as returned by `GET /v1/numbers/available`.
8027
+ */
8028
+ number: string;
8029
+ };
7870
8030
  type SipTrunkId = string;
7871
8031
  /**
7872
8032
  * Why we refused the call before dialing a carrier. Every refusal is signalled
@@ -7922,6 +8082,36 @@ type VoiceMediaQuality = {
7922
8082
  */
7923
8083
  readonly round_trip_time_ms: number;
7924
8084
  };
8085
+ /**
8086
+ * What was charged for a call, split into the components that make it up.
8087
+ *
8088
+ */
8089
+ type VoiceCallCost = {
8090
+ /**
8091
+ * Total charged, as a decimal string: the sum of the components below. Net of tax, which applies to your wallet balance rather than to an individual charge.
8092
+ *
8093
+ */
8094
+ readonly amount: string;
8095
+ /**
8096
+ * ISO 4217 currency code. Every component is denominated in this currency.
8097
+ */
8098
+ readonly currency_code: CurrencyCode;
8099
+ /**
8100
+ * What we charged to carry the call to the destination network, as a decimal string. `null` until this component is priced.
8101
+ *
8102
+ */
8103
+ readonly outbound_amount: string | null;
8104
+ /**
8105
+ * What we charged to receive the call from the originating network, as a decimal string. Only a call that arrived at your number can carry it. `null` until this component is priced.
8106
+ *
8107
+ */
8108
+ readonly inbound_amount: string | null;
8109
+ /**
8110
+ * What we charged for handling the call itself, as a decimal string. A call is charged for handling once, however many legs it has, so only one leg's record carries it. `null` until this component is priced.
8111
+ *
8112
+ */
8113
+ readonly call_handling_amount: string | null;
8114
+ };
7925
8115
  type VoiceCall = {
7926
8116
  /**
7927
8117
  * Unique identifier for this call record.
@@ -7942,7 +8132,7 @@ type VoiceCall = {
7942
8132
  */
7943
8133
  readonly to: string;
7944
8134
  /**
7945
- * Who placed the call: either the API key whose credentials it used or the user who placed it from a browser or the CLI. Absent when the call was admitted only by its source IP address, or when no actor was recorded.
8135
+ * Who placed the call: the API key whose credentials it used, the integration acting for the workspace, or the user who placed it from a browser or the CLI. Absent when the call was admitted only by its source IP address, or when no actor was recorded.
7946
8136
  */
7947
8137
  readonly actor?: AuditLogActor;
7948
8138
  /**
@@ -7988,9 +8178,9 @@ type VoiceCall = {
7988
8178
  */
7989
8179
  media_quality?: VoiceMediaQuality;
7990
8180
  /**
7991
- * Amount billed for this call, net of tax, at full precision. Absent until the call has been rated; unanswered or unpriced calls have no cost.
8181
+ * What the call cost, net of tax, at full precision, split into the components that make it up. Absent until the call has been rated; unanswered or unpriced calls have no cost.
7992
8182
  */
7993
- cost?: Money;
8183
+ cost?: VoiceCallCost;
7994
8184
  };
7995
8185
  type PublishRealtimeAppEventData = {
7996
8186
  body: RealtimePublish;
@@ -10590,6 +10780,147 @@ type ReplyEmailThreadMessageData = {
10590
10780
  query?: never;
10591
10781
  url: "/v1/email/threads/{thread_id}/messages/{message_id}/reply";
10592
10782
  };
10783
+ type ListWorkspaceNumbersData = {
10784
+ body?: never;
10785
+ headers?: {
10786
+ /**
10787
+ * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
10788
+ */
10789
+ "X-Workspace-Id"?: string;
10790
+ };
10791
+ path?: never;
10792
+ query?: {
10793
+ /**
10794
+ * Return only the number matching these digits. Give a full number with its country code, however your own records spell it: `+12025550188`, `12025550188`, `0012025550188`, and `+1 202 555 0188` all resolve to the same number. Spacing and punctuation are fine once a leading `+` or `00` marks the country code, or when `country_code` names the country; a grouped spelling without either is refused rather than guessed at, and a national spelling (bare digits without the country code) matches only when `country_code` names the country. A short code is matched on its bare digits instead, and since the same short code can be allocated in more than one country, pass `country_code` alongside it to name which one. This filter narrows the list like the others rather than replacing them, so a country or capability filter still applies. To match a range of numbers rather than one, use `prefix`.
10795
+ */
10796
+ number?: string;
10797
+ /**
10798
+ * Filter by the country a number belongs to, as an ISO 3166-1 alpha-2 code.
10799
+ */
10800
+ country_code?: string;
10801
+ /**
10802
+ * Return only allocated numbers of this physical type after applying the country and prefix filters.
10803
+ */
10804
+ number_type?: NumberType$1;
10805
+ /**
10806
+ * Return only numbers that start with these digits, matched right after the country dial code: with `country_code=US`, `prefix=212` returns the +1 212 area-code numbers allocated to you. Digits only, and `country_code` is required alongside it, since the digits are national ones. Leave out the country dial code and any national dialing prefix such as a leading 0. Short codes never match a prefix search.
10807
+ */
10808
+ prefix?: string;
10809
+ /**
10810
+ * Filter by channel capability. Repeat the parameter to require several at once: `capabilities=sms&capabilities=voice` returns only numbers that support both.
10811
+ */
10812
+ capabilities?: Array<string>;
10813
+ /**
10814
+ * Maximum number of items to return per page.
10815
+ */
10816
+ limit?: number;
10817
+ /**
10818
+ * Cursor from the `next_cursor` field of a previous list response. Returns items immediately after the cursor position in the current sort order.
10819
+ */
10820
+ starting_after?: string;
10821
+ /**
10822
+ * Cursor from the `prev_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order.
10823
+ */
10824
+ ending_before?: string;
10825
+ };
10826
+ url: "/v1/numbers";
10827
+ };
10828
+ type ListAvailableNumbersData = {
10829
+ body?: never;
10830
+ headers?: {
10831
+ /**
10832
+ * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
10833
+ */
10834
+ "X-Workspace-Id"?: string;
10835
+ };
10836
+ path?: never;
10837
+ query: {
10838
+ /**
10839
+ * ISO 3166-1 alpha-2 country code to search in.
10840
+ */
10841
+ country_code: string;
10842
+ /**
10843
+ * Return only numbers of this physical type after applying the country and prefix filters.
10844
+ */
10845
+ number_type?: NumberType$1;
10846
+ /**
10847
+ * Return only numbers that start with these digits, matched right after the country dial code: with `country_code=US`, `prefix=212` matches +1 212 area-code numbers and `prefix=833` matches 833 toll-free numbers. Digits only. Leave out the country dial code and any national dialing prefix such as a leading 0. Short codes never match a prefix search.
10848
+ */
10849
+ prefix?: string;
10850
+ /**
10851
+ * Filter by channel capability. Repeat the parameter to require several at once: `capabilities=sms&capabilities=voice` returns only numbers that support both.
10852
+ */
10853
+ capabilities?: Array<string>;
10854
+ /**
10855
+ * Maximum number of items to return per page.
10856
+ */
10857
+ limit?: number;
10858
+ /**
10859
+ * Cursor from the `next_cursor` field of a previous list response. Returns items immediately after the cursor position in the current sort order.
10860
+ */
10861
+ starting_after?: string;
10862
+ /**
10863
+ * Cursor from the `prev_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order.
10864
+ */
10865
+ ending_before?: string;
10866
+ };
10867
+ url: "/v1/numbers/available";
10868
+ };
10869
+ type ListNumbersOrdersData = {
10870
+ body?: never;
10871
+ headers?: {
10872
+ /**
10873
+ * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
10874
+ */
10875
+ "X-Workspace-Id"?: string;
10876
+ };
10877
+ path?: never;
10878
+ query?: {
10879
+ /**
10880
+ * Return only orders with status `charging`, `ordering`, `pending`, `completed`, or `failed`.
10881
+ */
10882
+ status?: NumbersOrderStatus$1;
10883
+ /**
10884
+ * Maximum number of items to return per page.
10885
+ */
10886
+ limit?: number;
10887
+ /**
10888
+ * Cursor from the `next_cursor` field of a previous list response. Returns items immediately after the cursor position in the current sort order.
10889
+ */
10890
+ starting_after?: string;
10891
+ /**
10892
+ * Cursor from the `prev_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order.
10893
+ */
10894
+ ending_before?: string;
10895
+ };
10896
+ url: "/v1/numbers/orders";
10897
+ };
10898
+ type CreateNumbersOrderData = {
10899
+ body: NumbersOrderCreate;
10900
+ headers?: {
10901
+ /**
10902
+ * Workspace context for the request. Required for dashboard authentication; API-key requests derive the workspace from the key.
10903
+ */
10904
+ "X-Workspace-Id"?: string;
10905
+ /**
10906
+ * Client-supplied deduplication key. When present, the original response is replayed for any duplicate request with the same key, within the idempotency window (3 hours by default).
10907
+ *
10908
+ * Two distinct 409 errors signal misuse:
10909
+ *
10910
+ * - `request_in_progress` (E01004): The same key is currently being
10911
+ * processed by a concurrent request. Wait briefly and retry. The lock expires within 30 seconds.
10912
+ * - `idempotency_key_reuse` (E01005): The same key has already completed
10913
+ * against a different request body or method. Generate a new key.
10914
+ *
10915
+ * Recommended key format is `<event-type>/<entity-id>` (for example `welcome-user/usr_abc123`).
10916
+ *
10917
+ */
10918
+ "Idempotency-Key"?: string;
10919
+ };
10920
+ path?: never;
10921
+ query?: never;
10922
+ url: "/v1/numbers/orders";
10923
+ };
10593
10924
  type ListVoiceCallsData = {
10594
10925
  body?: never;
10595
10926
  path?: never;
@@ -11733,7 +12064,7 @@ declare class DomainsResource extends Resource {
11733
12064
  */
11734
12065
  verify(domainId: string, options?: RequestOptions): APIPromise<Domain>;
11735
12066
  /**
11736
- * Update a sending domain's tracking and inbound configuration. Tracking: click_tracking and open_tracking apply immediately to new sends, and the tracking domain can be set, changed, or removed (the name part only, and the sending domain is appended for you). Enabling either toggle with no tracking domain configured returns 409, and removing the tracking domain while either toggle is still on also returns 409. Tracking-domain changes on a verified domain are staged behind DNS verification, so the current config keeps serving until the new records verify. Inbound receiving: inbound.enabled starts or stops receiving mail for the domain. Enabling requires the domain's DKIM to be verified first (a fresh enable on an unverified domain returns 422), and a domain already receiving inbound for another organization returns 422. The MX records to publish are always listed in dns_records regardless, so receiving starts only once inbound.enabled is set, even when those records are already published.
12067
+ * Update a sending domain's tracking and inbound configuration. Tracking: click_tracking and open_tracking apply immediately to new sends, and the tracking domain can be set, changed, or removed (the name part only, and the sending domain is appended for you). Enabling either toggle with no tracking domain configured returns 409, and removing the tracking domain while either toggle is still on also returns 409. Tracking-domain changes on a verified domain are staged behind DNS verification, so the current config keeps serving until the new records verify. Inbound receiving: inbound.enabled starts or stops receiving mail for the domain. Enabling requires the domain's DKIM to be verified first (a fresh enable on an unverified domain returns 422), and a domain already receiving inbound for another organization returns 422. The MX records to publish are always listed in dns_records regardless, marked optional until inbound.enabled is set, so receiving starts only once you set it even when those records are already published. Publishing them earlier is not free: on a domain at the zone apex they replace the MX records carrying its existing mail, changing where that mail is delivered.
11737
12068
  *
11738
12069
  * @example Enable tracking on a domain
11739
12070
  * await bird.domains.update("dom_01krdgeqcxet5s7t44vh8rt9mg", {
@@ -12613,6 +12944,116 @@ declare class LookupResource extends Resource {
12613
12944
  email(params: LookupEmailParams, options?: RequestOptions): APIPromise<EmailLookup>;
12614
12945
  }
12615
12946
  //#endregion
12947
+ //#region src/resources/numbers.gen.d.ts
12948
+ type NumbersListQuery = NonNullable<ListWorkspaceNumbersData["query"]>;
12949
+ declare class NumbersResourceBase extends Resource {
12950
+ /**
12951
+ * Pages the numbers allocated to the workspace, dedicated and shared alike. Narrows on country, type, prefix and capability, so one number is reached without walking every page.
12952
+ *
12953
+ * @example List the numbers allocated to you
12954
+ * for await (const allocated of bird.numbers.list({ country_code: "GB" })) {
12955
+ * // kind tells a number you bought from one Bird manages for several workspaces.
12956
+ * console.log(allocated.number, allocated.kind, allocated.status);
12957
+ * }
12958
+ */
12959
+ list(query?: NumbersListQuery, options?: RequestOptions): PaginatedPromise<Number>;
12960
+ /**
12961
+ * Reads one allocated number by the id `numbers.list` returns. Carries its status and, where a country demands ownership paperwork, what is still outstanding on it.
12962
+ *
12963
+ * @example Read one number allocated to you
12964
+ * const allocated = await bird.numbers.get("nda_01krdgeqcxet5s7t44vh8rt9mg");
12965
+ * // A country that asks for ownership paperwork answers here; most answer null.
12966
+ * console.log(allocated.status, allocated.ownership ?? "no paperwork required");
12967
+ */
12968
+ get(numberId: string, options?: RequestOptions): APIPromise<Number>;
12969
+ /**
12970
+ * Gives a dedicated number back and stops its monthly charge. Irreversible: the number leaves the workspace and the channels built on it stop sending. A shared number cannot be released.
12971
+ *
12972
+ * @example Give a dedicated number back
12973
+ * // Releasing stops the monthly charge and the number stops working for you.
12974
+ * // Only a dedicated number can be released; a shared one answers E14002.
12975
+ * await bird.numbers.release("nda_01krdgeqcxet5s7t44vh8rt9mg");
12976
+ */
12977
+ release(numberId: string, options?: RequestOptions): APIPromise<void>;
12978
+ }
12979
+ //#endregion
12980
+ //#region src/resources/numbersAvailable.gen.d.ts
12981
+ type NumbersAvailableListQuery = NonNullable<ListAvailableNumbersData["query"]>;
12982
+ declare class NumbersAvailableResource extends Resource {
12983
+ /**
12984
+ * Searches one country's numbers on sale. Our own inventory answers first and pages; the last page can carry a live carrier snapshot, so a number seen here may be gone by the time it is ordered.
12985
+ *
12986
+ * @example Find a number to buy in one country
12987
+ * // The search is always country-scoped, so country_code is required.
12988
+ * const page = await bird.numbers.available.list({
12989
+ * country_code: "GB",
12990
+ * capabilities: ["sms", "voice"],
12991
+ * });
12992
+ * for (const candidate of page.data) {
12993
+ * console.log(candidate.number, candidate.number_type);
12994
+ * }
12995
+ */
12996
+ list(query: NumbersAvailableListQuery, options?: RequestOptions): PaginatedPromise<AvailableNumber>;
12997
+ /**
12998
+ * Re-checks one number from `numbers.available.list` against the carrier, so a stale search result is caught before it is ordered.
12999
+ *
13000
+ * @example Check one number is still for sale
13001
+ * // A number a carrier supplies is only on sale while the carrier still has it,
13002
+ * // so a 404 here means someone else took it.
13003
+ * const candidate = await bird.numbers.available.get("+447700900201");
13004
+ * console.log(candidate.country_code, candidate.capabilities);
13005
+ */
13006
+ get(number: string, options?: RequestOptions): APIPromise<AvailableNumber>;
13007
+ }
13008
+ //#endregion
13009
+ //#region src/resources/numbersOrders.gen.d.ts
13010
+ type NumbersOrdersCreateParams = NonNullable<CreateNumbersOrderData["body"]>;
13011
+ type NumbersOrdersListQuery = NonNullable<ListNumbersOrdersData["query"]>;
13012
+ declare class NumbersOrdersResource extends Resource {
13013
+ /**
13014
+ * Buys a number and starts its monthly charge. Most orders settle inline; one waiting on a carrier comes back pending and is followed with `numbers.orders.get`. A setup fee already taken is not refunded if the order then fails.
13015
+ *
13016
+ * @example Buy a number
13017
+ * const order = await bird.numbers.orders.create({ number: "+447700900201" });
13018
+ * // Most orders finish inside the request. One that has to wait on a carrier
13019
+ * // comes back without a number_id. Poll it until it is completed or failed.
13020
+ * if (order.status === "completed") {
13021
+ * console.log("allocated as", order.number_id);
13022
+ * } else {
13023
+ * console.log("still", order.status, "; poll", order.id);
13024
+ * }
13025
+ */
13026
+ create(params: NumbersOrdersCreateParams, options?: RequestOptions): APIPromise<NumbersOrder>;
13027
+ /**
13028
+ * Pages the workspace's purchase attempts, newest first, filtered by status. An order outlives its attempt, so a failure stays readable with the reason it carried.
13029
+ *
13030
+ * @example Find the purchases that did not complete
13031
+ * const page = await bird.numbers.orders.list({ status: "failed" });
13032
+ * for (const order of page.data) {
13033
+ * console.log(order.number, order.failure_reason ?? "");
13034
+ * }
13035
+ */
13036
+ list(query?: NumbersOrdersListQuery, options?: RequestOptions): PaginatedPromise<NumbersOrder>;
13037
+ /**
13038
+ * Reads one order's current state, and the number it produced once completed. This is the poll for an order that came back pending.
13039
+ *
13040
+ * @example Poll an order that did not finish inline
13041
+ * const order = await bird.numbers.orders.get("nor_01krdgeqcxet5s7t44vh8rt9mg");
13042
+ * // failure_reason says what went wrong, and only ever on a failed order.
13043
+ * console.log(order.status, order.failure_reason ?? "");
13044
+ */
13045
+ get(orderId: string, options?: RequestOptions): APIPromise<NumbersOrder>;
13046
+ }
13047
+ //#endregion
13048
+ //#region src/resources/numbers.d.ts
13049
+ declare class NumbersResource extends NumbersResourceBase {
13050
+ /** Numbers on sale — `bird.numbers.available.list(...)`, `.get(...)`. */
13051
+ readonly available: NumbersAvailableResource;
13052
+ /** Purchases — `bird.numbers.orders.create(...)`, `.list(...)`, `.get(...)`. */
13053
+ readonly orders: NumbersOrdersResource;
13054
+ constructor(core: ConstructorParameters<typeof Resource>[0], client: ConstructorParameters<typeof Resource>[1]);
13055
+ }
13056
+ //#endregion
12616
13057
  //#region src/client.d.ts
12617
13058
  interface BirdClientOptions {
12618
13059
  apiKey: string;
@@ -12717,6 +13158,8 @@ declare class BirdClient<const O extends BirdClientOptions = BirdClientOptions>
12717
13158
  readonly domains: DomainsResource;
12718
13159
  /** Recipient intelligence: `bird.lookup.email(...)`, `.phoneNumber(...)`. Every answer is billed. */
12719
13160
  readonly lookup: LookupResource;
13161
+ /** Numbers: `bird.numbers.available.list(...)`, `.orders.create(...)`, `.list(...)`, `.release(...)`. */
13162
+ readonly numbers: NumbersResource;
12720
13163
  /** Webhooks: `bird.webhooks.unwrap(payload, headers)` verifies an inbound delivery. */
12721
13164
  readonly webhooks: WebhooksResource;
12722
13165
  /** Realtime: `bird.realtime.publish(...)`, `.channels.list(...)`, `.members.disconnect(...)`, … */
@@ -12885,6 +13328,47 @@ declare const LookupPropertyStatus: {
12885
13328
  };
12886
13329
  /** A known LookupPropertyStatus value. */
12887
13330
  type LookupPropertyStatusValue = (typeof LookupPropertyStatus)[keyof typeof LookupPropertyStatus];
13331
+ /**
13332
+ * Values of NumberCapability known at this SDK version. The wire value is an open
13333
+ * string: a value added by a newer server deserializes unchanged, so switch on
13334
+ * these with a `default` branch rather than treating the set as closed.
13335
+ */
13336
+ declare const NumberCapability: {
13337
+ readonly Mms: "mms";
13338
+ readonly Sms: "sms";
13339
+ readonly Voice: "voice";
13340
+ };
13341
+ /** A known NumberCapability value. */
13342
+ type NumberCapabilityValue = (typeof NumberCapability)[keyof typeof NumberCapability];
13343
+ /**
13344
+ * Values of NumberType known at this SDK version. The wire value is an open
13345
+ * string: a value added by a newer server deserializes unchanged, so switch on
13346
+ * these with a `default` branch rather than treating the set as closed.
13347
+ */
13348
+ declare const NumberType: {
13349
+ readonly Local: "local";
13350
+ readonly Mobile: "mobile";
13351
+ readonly National: "national";
13352
+ readonly ShortCode: "short_code";
13353
+ readonly ShortCodeFteu: "short_code_fteu";
13354
+ readonly TollFree: "toll_free";
13355
+ };
13356
+ /** A known NumberType value. */
13357
+ type NumberTypeValue = (typeof NumberType)[keyof typeof NumberType];
13358
+ /**
13359
+ * Values of NumbersOrderStatus known at this SDK version. The wire value is an open
13360
+ * string: a value added by a newer server deserializes unchanged, so switch on
13361
+ * these with a `default` branch rather than treating the set as closed.
13362
+ */
13363
+ declare const NumbersOrderStatus: {
13364
+ readonly Charging: "charging";
13365
+ readonly Completed: "completed";
13366
+ readonly Failed: "failed";
13367
+ readonly Ordering: "ordering";
13368
+ readonly Pending: "pending";
13369
+ };
13370
+ /** A known NumbersOrderStatus value. */
13371
+ type NumbersOrderStatusValue = (typeof NumbersOrderStatus)[keyof typeof NumbersOrderStatus];
12888
13372
  /**
12889
13373
  * Values of SMSErrorCode known at this SDK version. The wire value is an open
12890
13374
  * string: a value added by a newer server deserializes unchanged, so switch on
@@ -13041,6 +13525,7 @@ type VerificationTerminalReasonValue = (typeof VerificationTerminalReason)[keyof
13041
13525
  declare const WhatsAppErrorCode: {
13042
13526
  readonly InsufficientBalance: "insufficient_balance";
13043
13527
  readonly InternalError: "internal_error";
13528
+ readonly MediaRejected: "media_rejected";
13044
13529
  readonly PriceNotFound: "price_not_found";
13045
13530
  readonly RateLimited: "rate_limited";
13046
13531
  readonly RecipientSuppressed: "recipient_suppressed";
@@ -13093,5 +13578,5 @@ declare const WhatsAppTemplateParameterType: {
13093
13578
  /** A known WhatsAppTemplateParameterType value. */
13094
13579
  type WhatsAppTemplateParameterTypeValue = (typeof WhatsAppTemplateParameterType)[keyof typeof WhatsAppTemplateParameterType];
13095
13580
  //#endregion
13096
- export { type APIPromise, type Audience, type AudienceAddContactsParams, type AudienceCreateParams, type AudienceListContactsQuery, type AudienceListQuery, type AudienceMember, type AudienceRemoveContactsParams, type AudienceUpdateParams, BirdAPIError, BirdAuthError, BirdBadRequestError, BirdBillingError, BirdClient, type BirdClientOptions, BirdConflictError, BirdConnectionError, BirdError, BirdInternalError, BirdMisdirectedError, BirdNotFoundError, BirdNotImplementedError, BirdPayloadTooLargeError, BirdPermissionError, BirdPreconditionError, BirdRateLimitError, type BirdRequest, type BirdResponse, BirdServiceUnavailableError, BirdTimeoutError, BirdValidationError, type BirdWebhookEvent, BirdWebhookVerificationError, type ChannelAuthorization, type Contact, type ContactBatchParams, type ContactCreateParams, type ContactListQuery, type ContactProperty, type ContactPropertyCreateParams, type ContactPropertyListQuery, type ContactPropertyUpdateParams, type ContactUpdateParams, type ContactUpsertResult, type CursorPage, type DnsRecord, type Domain, type DomainCapabilities, type DomainCreateParams, type DomainDkim, type DomainListQuery, type DomainUpdateParams, type EmailChannelDefaults, EmailEventType, type EmailEventTypeValue, type EmailListQuery, type EmailLookup, EmailLookupFlag, type EmailLookupFlagValue, EmailLookupReason, type EmailLookupReasonValue, EmailLookupResult, type EmailLookupResultValue, type EmailMailboxLabelList, type EmailMailboxesCreateParams, type EmailMailboxesListQuery, type EmailMailboxesMessagesCreateParams, type EmailMailboxesReceiveRulesCreateParams, type EmailMailboxesReceiveRulesListQuery, type EmailMailboxesStatsQuery, type EmailMailboxesUpdateParams, type EmailMailboxesUpdateQuery, type EmailMessage, type EmailSendBatchParams, type EmailSendBatchResult, type EmailSendParams, type EmailStatsByBounceCodeQuery, type EmailStatsByBounceCodeResponse, type EmailStatsByBroadcastQuery, type EmailStatsByBroadcastResponse, type EmailStatsByCategoryQuery, type EmailStatsByCategoryResponse, type EmailStatsByClientQuery, type EmailStatsByClientResponse, type EmailStatsByComplaintTypeQuery, type EmailStatsByComplaintTypeResponse, type EmailStatsByLocationQuery, type EmailStatsByLocationResponse, type EmailStatsByMailboxProviderQuery, type EmailStatsByMailboxProviderRegionQuery, type EmailStatsByMailboxProviderRegionResponse, type EmailStatsByMailboxProviderResponse, type EmailStatsByRecipientDomainQuery, type EmailStatsByRecipientDomainResponse, type EmailStatsBySendingDomainQuery, type EmailStatsBySendingDomainResponse, type EmailStatsBySendingIpQuery, type EmailStatsBySendingIpResponse, type EmailStatsByTagQuery, type EmailStatsByTemplateQuery, type EmailStatsByTemplateResponse, type EmailStatsDailyQuery, type EmailStatsHourlyQuery, type EmailStatsResponse, type EmailStatsSummary, type EmailStatsSummaryQuery, type EmailStatsTagsResponse, type EmailThread, type EmailThreadMessage, type EmailThreadMessageAttachmentList, type EmailThreadMessageBody, type EmailThreadsDeleteQuery, type EmailThreadsListQuery, type EmailThreadsMessagesListQuery, type EmailThreadsMessagesReplyParams, type EmailThreadsUpdateParams, type ErrorDetail, type LookupEmailParams, LookupFlag, type LookupFlagValue, type LookupPhoneNumberParams, LookupPropertyStatus, type LookupPropertyStatusValue, type Mailbox, type MailboxStatsResponse, type NextAction, type PaginatedPromise, type PhoneNumberLookup, type RealtimeBatchPublishResult, type RealtimeChannelGetQuery, type RealtimeChannelInclude, type RealtimeChannelInfo, type RealtimeChannelListItem, type RealtimeChannelListQuery, type RealtimeChannelMember, type RealtimeChannelMembers, type RealtimeChannelsList, type RealtimeOptions, type RealtimePublishBatchParams, type RealtimePublishParams, type RealtimePublishResult, type ReceiveRule, type RequestOptions, SMSErrorCode, type SMSErrorCodeValue, SMSKeywordOperation, type SMSKeywordOperationValue, SMSSuppressionCoverage, type SMSSuppressionCoverageValue, SMSSuppressionEndReason, type SMSSuppressionEndReasonValue, SMSSuppressionOrigin, type SMSSuppressionOriginValue, SMSSuppressionReason, type SMSSuppressionReasonValue, type SafeResult, type SmsEventList, type SmsInboundStatsByCountryResponse, type SmsInboundStatsByNumberResponse, type SmsInboundStatsByOperatorResponse, type SmsInboundStatsResponse, type SmsInboundStatsSummaryResponse, type SmsKeywordRule, type SmsKeywordRuleList, type SmsKeywordRulesCreateParams, type SmsKeywordRulesListQuery, type SmsKeywordRulesUpdateParams, type SmsListEventsQuery, type SmsListQuery, type SmsMessage, type SmsSendBatchParams, type SmsSendBatchResult, type SmsSendParams, type SmsStatsByCarrierQuery, type SmsStatsByCarrierResponse, type SmsStatsByCategoryQuery, type SmsStatsByCategoryResponse, type SmsStatsByCountryQuery, type SmsStatsByCountryResponse, type SmsStatsByErrorCodeQuery, type SmsStatsByErrorCodeResponse, type SmsStatsByOriginatorQuery, type SmsStatsByOriginatorResponse, type SmsStatsByStatusQuery, type SmsStatsByStatusResponse, type SmsStatsDailyQuery, type SmsStatsHourlyQuery, type SmsStatsInboundByCountryQuery, type SmsStatsInboundByNumberQuery, type SmsStatsInboundByOperatorQuery, type SmsStatsInboundDailyQuery, type SmsStatsInboundHourlyQuery, type SmsStatsInboundSummaryQuery, type SmsStatsResponse, type SmsStatsSummary, type SmsStatsSummaryQuery, type SmsSuppression, type SmsSuppressionsAddParams, type SmsSuppressionsListQuery, type SmsTemplate, type SmsTemplateList, type SmsTemplateListQuery, TemplateLanguageStatus, type TemplateLanguageStatusValue, TemplateStatus, type TemplateStatusValue, type Verification, VerificationAttemptFailureReason, type VerificationAttemptFailureReasonValue, VerificationChannel, type VerificationChannelValue, type VerificationCheckResult, VerificationTerminalReason, type VerificationTerminalReasonValue, type VerifyVerificationsCheckParams, type VerifyVerificationsCreateParams, type VerifyVerificationsNextChannelParams, WebhookEventType, type WebhookEventTypeValue, type WebhookHeaders, type WebhookOptions, WhatsAppErrorCode, type WhatsAppErrorCodeValue, type WhatsAppEventList, WhatsAppEventType, type WhatsAppEventTypeValue, type WhatsAppMessage, WhatsAppTemplateCategory, type WhatsAppTemplateCategoryValue, WhatsAppTemplateParameterType, type WhatsAppTemplateParameterTypeValue, type WhatsappListEventsQuery, type WhatsappListQuery, type WhatsappSendParams, baseUrlForRegion, regionFromApiKey };
13581
+ export { type APIPromise, type Audience, type AudienceAddContactsParams, type AudienceCreateParams, type AudienceListContactsQuery, type AudienceListQuery, type AudienceMember, type AudienceRemoveContactsParams, type AudienceUpdateParams, BirdAPIError, BirdAuthError, BirdBadRequestError, BirdBillingError, BirdClient, type BirdClientOptions, BirdConflictError, BirdConnectionError, BirdError, BirdInternalError, BirdMisdirectedError, BirdNotFoundError, BirdNotImplementedError, BirdPayloadTooLargeError, BirdPermissionError, BirdPreconditionError, BirdRateLimitError, type BirdRequest, type BirdResponse, BirdServiceUnavailableError, BirdTimeoutError, BirdValidationError, type BirdWebhookEvent, BirdWebhookVerificationError, type ChannelAuthorization, type Contact, type ContactBatchParams, type ContactCreateParams, type ContactListQuery, type ContactProperty, type ContactPropertyCreateParams, type ContactPropertyListQuery, type ContactPropertyUpdateParams, type ContactUpdateParams, type ContactUpsertResult, type CursorPage, type DnsRecord, type Domain, type DomainCapabilities, type DomainCreateParams, type DomainDkim, type DomainListQuery, type DomainUpdateParams, type EmailChannelDefaults, EmailEventType, type EmailEventTypeValue, type EmailListQuery, type EmailLookup, EmailLookupFlag, type EmailLookupFlagValue, EmailLookupReason, type EmailLookupReasonValue, EmailLookupResult, type EmailLookupResultValue, type EmailMailboxLabelList, type EmailMailboxesCreateParams, type EmailMailboxesListQuery, type EmailMailboxesMessagesCreateParams, type EmailMailboxesReceiveRulesCreateParams, type EmailMailboxesReceiveRulesListQuery, type EmailMailboxesStatsQuery, type EmailMailboxesUpdateParams, type EmailMailboxesUpdateQuery, type EmailMessage, type EmailSendBatchParams, type EmailSendBatchResult, type EmailSendParams, type EmailStatsByBounceCodeQuery, type EmailStatsByBounceCodeResponse, type EmailStatsByBroadcastQuery, type EmailStatsByBroadcastResponse, type EmailStatsByCategoryQuery, type EmailStatsByCategoryResponse, type EmailStatsByClientQuery, type EmailStatsByClientResponse, type EmailStatsByComplaintTypeQuery, type EmailStatsByComplaintTypeResponse, type EmailStatsByLocationQuery, type EmailStatsByLocationResponse, type EmailStatsByMailboxProviderQuery, type EmailStatsByMailboxProviderRegionQuery, type EmailStatsByMailboxProviderRegionResponse, type EmailStatsByMailboxProviderResponse, type EmailStatsByRecipientDomainQuery, type EmailStatsByRecipientDomainResponse, type EmailStatsBySendingDomainQuery, type EmailStatsBySendingDomainResponse, type EmailStatsBySendingIpQuery, type EmailStatsBySendingIpResponse, type EmailStatsByTagQuery, type EmailStatsByTemplateQuery, type EmailStatsByTemplateResponse, type EmailStatsDailyQuery, type EmailStatsHourlyQuery, type EmailStatsResponse, type EmailStatsSummary, type EmailStatsSummaryQuery, type EmailStatsTagsResponse, type EmailThread, type EmailThreadMessage, type EmailThreadMessageAttachmentList, type EmailThreadMessageBody, type EmailThreadsDeleteQuery, type EmailThreadsListQuery, type EmailThreadsMessagesListQuery, type EmailThreadsMessagesReplyParams, type EmailThreadsUpdateParams, type ErrorDetail, type LookupEmailParams, LookupFlag, type LookupFlagValue, type LookupPhoneNumberParams, LookupPropertyStatus, type LookupPropertyStatusValue, type Mailbox, type MailboxStatsResponse, type NextAction, NumberCapability, type NumberCapabilityValue, NumberType, type NumberTypeValue, NumbersOrderStatus, type NumbersOrderStatusValue, type PaginatedPromise, type PhoneNumberLookup, type RealtimeBatchPublishResult, type RealtimeChannelGetQuery, type RealtimeChannelInclude, type RealtimeChannelInfo, type RealtimeChannelListItem, type RealtimeChannelListQuery, type RealtimeChannelMember, type RealtimeChannelMembers, type RealtimeChannelsList, type RealtimeOptions, type RealtimePublishBatchParams, type RealtimePublishParams, type RealtimePublishResult, type ReceiveRule, type RequestOptions, SMSErrorCode, type SMSErrorCodeValue, SMSKeywordOperation, type SMSKeywordOperationValue, SMSSuppressionCoverage, type SMSSuppressionCoverageValue, SMSSuppressionEndReason, type SMSSuppressionEndReasonValue, SMSSuppressionOrigin, type SMSSuppressionOriginValue, SMSSuppressionReason, type SMSSuppressionReasonValue, type SafeResult, type SmsEventList, type SmsInboundStatsByCountryResponse, type SmsInboundStatsByNumberResponse, type SmsInboundStatsByOperatorResponse, type SmsInboundStatsResponse, type SmsInboundStatsSummaryResponse, type SmsKeywordRule, type SmsKeywordRuleList, type SmsKeywordRulesCreateParams, type SmsKeywordRulesListQuery, type SmsKeywordRulesUpdateParams, type SmsListEventsQuery, type SmsListQuery, type SmsMessage, type SmsSendBatchParams, type SmsSendBatchResult, type SmsSendParams, type SmsStatsByCarrierQuery, type SmsStatsByCarrierResponse, type SmsStatsByCategoryQuery, type SmsStatsByCategoryResponse, type SmsStatsByCountryQuery, type SmsStatsByCountryResponse, type SmsStatsByErrorCodeQuery, type SmsStatsByErrorCodeResponse, type SmsStatsByOriginatorQuery, type SmsStatsByOriginatorResponse, type SmsStatsByStatusQuery, type SmsStatsByStatusResponse, type SmsStatsDailyQuery, type SmsStatsHourlyQuery, type SmsStatsInboundByCountryQuery, type SmsStatsInboundByNumberQuery, type SmsStatsInboundByOperatorQuery, type SmsStatsInboundDailyQuery, type SmsStatsInboundHourlyQuery, type SmsStatsInboundSummaryQuery, type SmsStatsResponse, type SmsStatsSummary, type SmsStatsSummaryQuery, type SmsSuppression, type SmsSuppressionsAddParams, type SmsSuppressionsListQuery, type SmsTemplate, type SmsTemplateList, type SmsTemplateListQuery, TemplateLanguageStatus, type TemplateLanguageStatusValue, TemplateStatus, type TemplateStatusValue, type Verification, VerificationAttemptFailureReason, type VerificationAttemptFailureReasonValue, VerificationChannel, type VerificationChannelValue, type VerificationCheckResult, VerificationTerminalReason, type VerificationTerminalReasonValue, type VerifyVerificationsCheckParams, type VerifyVerificationsCreateParams, type VerifyVerificationsNextChannelParams, WebhookEventType, type WebhookEventTypeValue, type WebhookHeaders, type WebhookOptions, WhatsAppErrorCode, type WhatsAppErrorCodeValue, type WhatsAppEventList, WhatsAppEventType, type WhatsAppEventTypeValue, type WhatsAppMessage, WhatsAppTemplateCategory, type WhatsAppTemplateCategoryValue, WhatsAppTemplateParameterType, type WhatsAppTemplateParameterTypeValue, type WhatsappListEventsQuery, type WhatsappListQuery, type WhatsappSendParams, baseUrlForRegion, regionFromApiKey };
13097
13582
  //# sourceMappingURL=index.d.mts.map