@messagebird/n8n-nodes-bird 0.30.1 → 0.32.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.
@@ -11,7 +11,6 @@ exports.birdPickers = {
11
11
  emailInboundRoutesList: { route: "email:inbound_routes_list", fields: ["match_value", "domain"], search: "", pathFrom: [] },
12
12
  inboundAddressList: { route: "inbound_address:list", fields: ["address"], search: "", pathFrom: [] },
13
13
  inboundMessageList: { route: "inbound_message:list", fields: ["subject", "message_id"], search: "", pathFrom: [] },
14
- emailMailboxesList: { route: "email:mailboxes_list", fields: ["address"], search: "q", pathFrom: [] },
15
14
  numbersOrdersList: { route: "numbers:orders_list", fields: ["number"], search: "", pathFrom: [] },
16
15
  preferencesList: { route: "preferences:list", fields: ["handle"], search: "", pathFrom: [] },
17
16
  realtimeAppsList: { route: "realtime:apps_list", fields: ["name"], search: "name", pathFrom: [] },
@@ -592,7 +592,7 @@ exports.birdProperties = [
592
592
  name: "ip_pool_id",
593
593
  type: "string",
594
594
  default: "",
595
- description: "ID of the IP pool to send from (`ipp_` prefix), or `ipp_shared` to route through the shared pool explicitly. Omit to use your organization's default pool. An unknown pool, or a pool with no dedicated IPs available to send from, is rejected with a `422`.",
595
+ description: "ID of the IP pool to send from (`ipp_` prefix), or `ipp_shared` to route through the shared pool explicitly. Omit to use the sending domain's default pool in this workspace, or the organization's default when the domain has none. An unknown pool, or a pool with no dedicated IPs available to send from, is rejected with a `422`.",
596
596
  },
597
597
  {
598
598
  displayName: "Metadata",
@@ -652,6 +652,13 @@ exports.birdProperties = [
652
652
  },
653
653
  ],
654
654
  },
655
+ {
656
+ displayName: "Reference",
657
+ name: "reference",
658
+ type: "string",
659
+ default: "",
660
+ description: "An identifier you want to find this message by, such as an order or ticket number, matched exactly by the message list's `reference` filter. Set it only when you need to search on it, and put any other data in `metadata`. Stored on the message, returned on reads and echoed in webhook payloads. Several messages can share one.",
661
+ },
655
662
  {
656
663
  displayName: "Reply To",
657
664
  name: "reply_to",
@@ -884,6 +891,13 @@ exports.birdProperties = [
884
891
  default: "",
885
892
  description: "Filter by sender address. Exact match against the message `from` field. The address is normalized to lowercase before comparison.",
886
893
  },
894
+ {
895
+ displayName: "Reference",
896
+ name: "reference",
897
+ type: "string",
898
+ default: "",
899
+ description: "Keep only messages whose `reference` is exactly this value. The match is case-sensitive, and several messages can share a reference.",
900
+ },
887
901
  {
888
902
  displayName: "Status",
889
903
  name: "status",
@@ -2778,7 +2792,7 @@ exports.birdProperties = [
2778
2792
  required: true,
2779
2793
  displayOptions: { show: { resource: ["sms"], operation: ["send"] } },
2780
2794
  default: "",
2781
- description: "Recipient phone number in E.164 format (for example `+14155550100`). One recipient per message. The number is stored and returned in canonical E.164; a recipient that cannot be routed returns a `422` `SMSInvalidRecipient`.",
2795
+ description: "Recipient phone number in E.164 format (for example `+14155550100`), or in national format when you also pass `to_country_code`. One recipient per message. The number is stored and returned in canonical E.164; a recipient that cannot be routed returns a `422` `SMSInvalidRecipient`.",
2782
2796
  },
2783
2797
  {
2784
2798
  displayName: "Additional Fields",
@@ -2788,6 +2802,30 @@ exports.birdProperties = [
2788
2802
  default: {},
2789
2803
  displayOptions: { show: { resource: ["sms"], operation: ["send"] } },
2790
2804
  options: [
2805
+ {
2806
+ displayName: "Binary",
2807
+ name: "binary",
2808
+ type: "collection",
2809
+ placeholder: "Add Field",
2810
+ default: {},
2811
+ description: "Send an 8-bit binary payload instead of `text` or `template`. Requires `category` `transactional` and refuses `options.smart_encoding`. It is sent and charged as one segment.",
2812
+ options: [
2813
+ {
2814
+ displayName: "Udh",
2815
+ name: "udh",
2816
+ type: "string",
2817
+ default: "",
2818
+ description: "User data header as hexadecimal, 1-16 octets. Required on a send: a binary send without it returns `422`. Its first octet must count the octets after it, every information element must fit inside it, and concatenation elements (`00`, `08`) are refused because the message is one segment.",
2819
+ },
2820
+ {
2821
+ displayName: "Data",
2822
+ name: "data",
2823
+ type: "string",
2824
+ default: "",
2825
+ description: "The payload after the header, as hexadecimal",
2826
+ },
2827
+ ],
2828
+ },
2791
2829
  {
2792
2830
  displayName: "Category",
2793
2831
  name: "category",
@@ -2800,14 +2838,28 @@ exports.birdProperties = [
2800
2838
  { name: "Transactional", value: "transactional" },
2801
2839
  ],
2802
2840
  default: "",
2803
- description: "Content classification: why you are sending. Required on a free-text send; omit it on a template send, where the category is derived from the template. Where the destination country requires the sender to be registered, a category outside what that registration covers returns a `422` `SenderCategoryNotPermitted`.",
2841
+ description: "Content classification: why you are sending. Required on a free-text send unless the messaging profile in `messaging_profile_id` sets a default category; omit it on a template send, where the category is derived from the template. Where the destination country requires the sender to be registered, a category outside what that registration covers returns a `422` `SenderCategoryNotPermitted`.",
2842
+ },
2843
+ {
2844
+ displayName: "Cost Center",
2845
+ name: "cost_center",
2846
+ type: "string",
2847
+ default: "",
2848
+ description: "Your accounting identifier for this message, such as a department code. Stored on the message and its usage record, returned on reads, and echoed in webhook payloads. Omit it to use the cost center of the messaging profile in `messaging_profile_id`. Accepting it does not change how the message is priced.",
2804
2849
  },
2805
2850
  {
2806
2851
  displayName: "From",
2807
2852
  name: "from",
2808
2853
  type: "string",
2809
2854
  default: "",
2810
- description: "Sender to send from. It must be a sender the workspace holds: a number it owns in E.164, such as `+15557654321`, a short code it holds, such as `24680`, or an alphanumeric sender ID it has claimed, such as `MyBrand`. A sender the workspace does not hold returns a `422` `SMSSenderNotConfigured`, and an alphanumeric sender must also be permitted, and where required registered, for the destination country. Required on a free-text send and when sending a workspace template. Omitting it in either case returns `422`. A built-in template selects its sender automatically and rejects `from`.",
2855
+ description: "Sender to send from. It must be a sender the workspace holds: a number it owns in E.164, such as `+15557654321`, a short code it holds, such as `24680`, or an alphanumeric sender ID it has claimed, such as `MyBrand`. A sender the workspace does not hold returns a `422` `SMSSenderNotConfigured`, and an alphanumeric sender must also be permitted, and where required registered, for the destination country. Required on a free-text send and when sending a workspace template, unless `messaging_profile_id` is set and the profile selects a sender for the destination country or has a default sender. Omitting it otherwise returns `422`. A built-in template selects its sender automatically and rejects `from`.",
2856
+ },
2857
+ {
2858
+ displayName: "Messaging Profile ID",
2859
+ name: "messaging_profile_id",
2860
+ type: "string",
2861
+ default: "",
2862
+ description: "The messaging profile that supplies this message's sender and defaults. When `from` is omitted, Bird sends from the profile's sender for the destination country, or its default sender. An omitted `category` on a free-text send takes the profile's default category, and `smart_encoding`, `cost_center` and `validity_period` take the profile's settings. So do `options.callback_url` and `options.ignore_suppression`, which apply to the message. Values you set on the message take precedence. A built-in template sends from Bird's system sender and ignores the profile's senders. A profile that does not exist in this workspace returns `422` `SMSMessagingProfileNotFound`; a `from` bound to a different profile returns `422` `SMSMessagingProfileSenderBound`.",
2811
2863
  },
2812
2864
  {
2813
2865
  displayName: "Metadata",
@@ -2853,8 +2905,29 @@ exports.birdProperties = [
2853
2905
  default: false,
2854
2906
  description: "Whether to replace characters outside the GSM-7 alphabet with their closest GSM-7 equivalent before sending: typically curly quotes, dashes, ellipses, fullwidth forms, and non-breaking spaces. One such character forces the whole body into `UCS2`, which more than halves the characters that fit in a segment, so replacing them often lowers the segment count and the cost. Disabled by default, because it alters the body you composed. The replacement is all-or-nothing: a body that still holds a character outside the alphabet afterwards, such as an emoji or a non-Latin script, is sent exactly as you supplied it. Read the message back to see what was applied: `text` is the body as sent.",
2855
2907
  },
2908
+ {
2909
+ displayName: "Ignore Suppression",
2910
+ name: "ignore_suppression",
2911
+ type: "boolean",
2912
+ default: false,
2913
+ description: "Whether to send this message even if the recipient is suppressed for the sender, including after replying STOP. Bird skips every suppression reason and records the flag on the message; communication preferences the recipient revoked still apply. Only `authentication` and `transactional` messages can use it; setting it to `true` on a `marketing` or `service` message returns `422`. Bird must enable it for your workspace first; until then, a message that uses it is refused with `422`. Omit it to use the setting of the messaging profile in `messaging_profile_id`.",
2914
+ },
2915
+ {
2916
+ displayName: "Callback URL",
2917
+ name: "callback_url",
2918
+ type: "string",
2919
+ default: "",
2920
+ description: "An HTTPS URL that receives this message's events instead of your webhook endpoints. It must be a public address: a private, loopback or link-local host returns `422`. Bird fixes the URL when it accepts the message, so later profile changes do not reroute it. Each event is a signed POST, retried on failure, and signed with your workspace callback signing secret, which `rotateWebhookCallbackSigningSecret` creates and returns once. While a URL applies, this message's events skip your plain webhook endpoints, and a failed callback never falls back to them. MCP Events subscriptions and connector endpoints still receive them. The `callback_events` of the messaging profile in `messaging_profile_id` choose which events go to the URL. Omit the field to use the callback URL of that profile; send `null` to send this message's events to your webhook subscriptions.",
2921
+ },
2856
2922
  ],
2857
2923
  },
2924
+ {
2925
+ displayName: "Reference",
2926
+ name: "reference",
2927
+ type: "string",
2928
+ default: "",
2929
+ description: "An identifier you want to find this message by, such as an order or ticket number, matched exactly by the message list's `reference` filter. Set it only when you need to search on it, and put any other data in `metadata`. Stored on the message, returned on reads and echoed in webhook payloads. Several messages can share one.",
2930
+ },
2858
2931
  {
2859
2932
  displayName: "Tags",
2860
2933
  name: "tags",
@@ -2960,6 +3033,20 @@ exports.birdProperties = [
2960
3033
  default: "",
2961
3034
  description: "Free-text message body. Required unless `template` is supplied (the two are mutually exclusive). At least 1 character, up to a 12-segment cap (roughly 1836 GSM-7 or 804 UCS-2 characters). Bird does not truncate; a body exceeding 12 segments is rejected with a 422. The cap applies to segments because GSM-7 and UCS-2 encodings differ in characters per segment.",
2962
3035
  },
3036
+ {
3037
+ displayName: "To Country Code",
3038
+ name: "to_country_code",
3039
+ type: "string",
3040
+ default: "",
3041
+ description: "The ISO 3166-1 alpha-2 country whose national numbering plan `to` is written in, such as `NL` for `0612345678`. Bird converts `to` to E.164 before checking the destination, price and sender. An E.164 `to` is still accepted when its country calling code matches this country; a mismatch, or a national number that is not valid in this country, returns a `422` `SMSInvalidRecipient`. Omit it to send `to` in E.164.",
3042
+ },
3043
+ {
3044
+ displayName: "Validity Period",
3045
+ name: "validity_period",
3046
+ type: "number",
3047
+ default: "",
3048
+ description: "How long, in seconds (60-172800), the message may wait for delivery, counted from acceptance. Bird does not submit the message to the carrier after this deadline and passes the remaining time to the carrier where the route supports it. A message that misses the deadline before reaching the carrier ends `rejected` or `failed`, not `expired`; `expired` comes only from a carrier report. Omit it to use the validity period of the messaging profile in `messaging_profile_id`, or the carrier's own validity rules when the profile sets none.",
3049
+ },
2963
3050
  ],
2964
3051
  },
2965
3052
  {
@@ -3033,6 +3120,13 @@ exports.birdProperties = [
3033
3120
  default: "",
3034
3121
  description: "Filter by category",
3035
3122
  },
3123
+ {
3124
+ displayName: "Country",
3125
+ name: "country",
3126
+ type: "string",
3127
+ default: "",
3128
+ description: "Filter by destination country, as an ISO 3166-1 alpha-2 code. An outbound message's country is the recipient's; a received message's is the country of the Bird number it arrived on.",
3129
+ },
3036
3130
  {
3037
3131
  displayName: "Created After",
3038
3132
  name: "created_after",
@@ -3073,6 +3167,13 @@ exports.birdProperties = [
3073
3167
  default: "",
3074
3168
  description: "Filter by sender (E.164, alphanumeric, or short code; exact match)",
3075
3169
  },
3170
+ {
3171
+ displayName: "Reference",
3172
+ name: "reference",
3173
+ type: "string",
3174
+ default: "",
3175
+ description: "Keep only messages whose `reference` is exactly this value. The match is case-sensitive, and several messages can share a reference.",
3176
+ },
3076
3177
  {
3077
3178
  displayName: "Status",
3078
3179
  name: "status",
@@ -3279,14 +3380,14 @@ exports.birdProperties = [
3279
3380
  name: "carrier",
3280
3381
  type: "string",
3281
3382
  default: "",
3282
- description: "Restrict the statistics to a single delivery carrier. Mutually exclusive with the other dimension filters (`originator`, `country`, `category`); only one may be set per request.",
3383
+ description: "Restrict the statistics to a single delivery carrier. Mutually exclusive with the other dimension filters; only one may be set per request.",
3283
3384
  },
3284
3385
  {
3285
3386
  displayName: "Category",
3286
3387
  name: "category",
3287
3388
  type: "string",
3288
3389
  default: "",
3289
- description: "Restrict the statistics to a single category. Mutually exclusive with the other dimension filters (`originator`, `country`, `carrier`); only one may be set per request.",
3390
+ description: "Restrict the statistics to a single category. Mutually exclusive with the other dimension filters; only one may be set per request.",
3290
3391
  },
3291
3392
  {
3292
3393
  displayName: "Compare",
@@ -3304,7 +3405,7 @@ exports.birdProperties = [
3304
3405
  name: "country",
3305
3406
  type: "string",
3306
3407
  default: "",
3307
- description: "Restrict the statistics to a single destination country, as an ISO 3166-1 alpha-2 code. Mutually exclusive with the other dimension filters (`originator`, `category`, `carrier`); only one may be set per request.",
3408
+ description: "Restrict the statistics to a single destination country, as an ISO 3166-1 alpha-2 code. Mutually exclusive with the other dimension filters; only one may be set per request.",
3308
3409
  },
3309
3410
  {
3310
3411
  displayName: "From",
@@ -3318,7 +3419,7 @@ exports.birdProperties = [
3318
3419
  name: "originator",
3319
3420
  type: "string",
3320
3421
  default: "",
3321
- description: "Restrict the statistics to a single originator (the sender address messages were sent from). Mutually exclusive with the other dimension filters (`country`, `category`, `carrier`); only one may be set per request. Matches the message `from`.",
3422
+ description: "Restrict the statistics to a single originator (the sender address messages were sent from). Mutually exclusive with the other dimension filters; only one may be set per request. Matches the message `from`.",
3322
3423
  },
3323
3424
  {
3324
3425
  displayName: "Timezone",
@@ -3349,21 +3450,21 @@ exports.birdProperties = [
3349
3450
  name: "carrier",
3350
3451
  type: "string",
3351
3452
  default: "",
3352
- description: "Restrict the statistics to a single delivery carrier. Mutually exclusive with the other dimension filters (`originator`, `country`, `category`); only one may be set per request.",
3453
+ description: "Restrict the statistics to a single delivery carrier. Mutually exclusive with the other dimension filters; only one may be set per request.",
3353
3454
  },
3354
3455
  {
3355
3456
  displayName: "Category",
3356
3457
  name: "category",
3357
3458
  type: "string",
3358
3459
  default: "",
3359
- description: "Restrict the statistics to a single category. Mutually exclusive with the other dimension filters (`originator`, `country`, `carrier`); only one may be set per request.",
3460
+ description: "Restrict the statistics to a single category. Mutually exclusive with the other dimension filters; only one may be set per request.",
3360
3461
  },
3361
3462
  {
3362
3463
  displayName: "Country",
3363
3464
  name: "country",
3364
3465
  type: "string",
3365
3466
  default: "",
3366
- description: "Restrict the statistics to a single destination country, as an ISO 3166-1 alpha-2 code. Mutually exclusive with the other dimension filters (`originator`, `category`, `carrier`); only one may be set per request.",
3467
+ description: "Restrict the statistics to a single destination country, as an ISO 3166-1 alpha-2 code. Mutually exclusive with the other dimension filters; only one may be set per request.",
3367
3468
  },
3368
3469
  {
3369
3470
  displayName: "From",
@@ -3377,7 +3478,7 @@ exports.birdProperties = [
3377
3478
  name: "originator",
3378
3479
  type: "string",
3379
3480
  default: "",
3380
- description: "Restrict the statistics to a single originator (the sender address messages were sent from). Mutually exclusive with the other dimension filters (`country`, `category`, `carrier`); only one may be set per request. Matches the message `from`.",
3481
+ description: "Restrict the statistics to a single originator (the sender address messages were sent from). Mutually exclusive with the other dimension filters; only one may be set per request. Matches the message `from`.",
3381
3482
  },
3382
3483
  {
3383
3484
  displayName: "Timezone",
@@ -3408,21 +3509,21 @@ exports.birdProperties = [
3408
3509
  name: "carrier",
3409
3510
  type: "string",
3410
3511
  default: "",
3411
- description: "Restrict the statistics to a single delivery carrier. Mutually exclusive with the other dimension filters (`originator`, `country`, `category`); only one may be set per request.",
3512
+ description: "Restrict the statistics to a single delivery carrier. Mutually exclusive with the other dimension filters; only one may be set per request.",
3412
3513
  },
3413
3514
  {
3414
3515
  displayName: "Category",
3415
3516
  name: "category",
3416
3517
  type: "string",
3417
3518
  default: "",
3418
- description: "Restrict the statistics to a single category. Mutually exclusive with the other dimension filters (`originator`, `country`, `carrier`); only one may be set per request.",
3519
+ description: "Restrict the statistics to a single category. Mutually exclusive with the other dimension filters; only one may be set per request.",
3419
3520
  },
3420
3521
  {
3421
3522
  displayName: "Country",
3422
3523
  name: "country",
3423
3524
  type: "string",
3424
3525
  default: "",
3425
- description: "Restrict the statistics to a single destination country, as an ISO 3166-1 alpha-2 code. Mutually exclusive with the other dimension filters (`originator`, `category`, `carrier`); only one may be set per request.",
3526
+ description: "Restrict the statistics to a single destination country, as an ISO 3166-1 alpha-2 code. Mutually exclusive with the other dimension filters; only one may be set per request.",
3426
3527
  },
3427
3528
  {
3428
3529
  displayName: "From",
@@ -3436,7 +3537,7 @@ exports.birdProperties = [
3436
3537
  name: "originator",
3437
3538
  type: "string",
3438
3539
  default: "",
3439
- description: "Restrict the statistics to a single originator (the sender address messages were sent from). Mutually exclusive with the other dimension filters (`country`, `category`, `carrier`); only one may be set per request. Matches the message `from`.",
3540
+ description: "Restrict the statistics to a single originator (the sender address messages were sent from). Mutually exclusive with the other dimension filters; only one may be set per request. Matches the message `from`.",
3440
3541
  },
3441
3542
  {
3442
3543
  displayName: "Timezone",
@@ -4823,6 +4924,13 @@ exports.birdProperties = [
4823
4924
  },
4824
4925
  ],
4825
4926
  },
4927
+ {
4928
+ displayName: "Reference",
4929
+ name: "reference",
4930
+ type: "string",
4931
+ default: "",
4932
+ description: "An identifier you want to find this message by, such as an order or ticket number, matched exactly by the message list's `reference` filter. Set it only when you need to search on it, and put any other data in `metadata`. Stored on the message, returned on reads and echoed in webhook payloads. Several messages can share one.",
4933
+ },
4826
4934
  {
4827
4935
  displayName: "Sticker",
4828
4936
  name: "sticker",
@@ -4880,18 +4988,25 @@ exports.birdProperties = [
4880
4988
  description: "The template to send, the only content deliverable outside the customer service window. A group takes only templates your workspace authored, outside the authentication category.",
4881
4989
  options: [
4882
4990
  {
4883
- displayName: "ID",
4884
- name: "id",
4885
- type: "string",
4991
+ displayName: "Bid Multiplier",
4992
+ name: "bid_multiplier",
4993
+ type: "number",
4886
4994
  default: "",
4887
- description: "The template to send, by its ID",
4995
+ description: "Scales the language's maximum price for this message only. The effective bid is the language's `optimization_spec.bid_amount`, times its country multiplier, times this value. At least 0.01 and at most 100; 1 when omitted. Only a language with an `optimization_spec`, on a template still in the `marketing` category, accepts it.",
4888
4996
  },
4889
4997
  {
4890
- displayName: "Slug",
4891
- name: "slug",
4998
+ displayName: "Components",
4999
+ name: "components",
5000
+ type: "json",
5001
+ default: "",
5002
+ description: "Values for the template's placeholders. Build it from the template language's `components`: each block's `example_parameters`, with real values, becomes that part's `parameters`. A template's `buttons` block becomes one `button` part per button that has `example_parameters`, in order; a `carousel` becomes one `cards` entry per card, built the same way. A `location` header always needs a part with a `location` parameter. Leave out other blocks without any.",
5003
+ },
5004
+ {
5005
+ displayName: "ID",
5006
+ name: "id",
4892
5007
  type: "string",
4893
5008
  default: "",
4894
- description: "The template to send, by its slug handle (for example `bird_otp`)",
5009
+ description: "The template to send, by its ID",
4895
5010
  },
4896
5011
  {
4897
5012
  displayName: "Language",
@@ -4901,11 +5016,11 @@ exports.birdProperties = [
4901
5016
  description: "Which of the template's languages to send, as a BCP-47 tag (for example `en-US`; Meta's `en_US` is accepted too). Omit it for the template's default language, unless the template sets `language_source_required`. A language the template lacks is handled by its `on_missing_language` setting. The message is priced at the language it resolves to, which the accepted message echoes.",
4902
5017
  },
4903
5018
  {
4904
- displayName: "Components",
4905
- name: "components",
4906
- type: "json",
5019
+ displayName: "Slug",
5020
+ name: "slug",
5021
+ type: "string",
4907
5022
  default: "",
4908
- description: "Values for the template's placeholders. Build it from the template language's `components`: each block's `example_parameters`, with real values, becomes that part's `parameters`. A template's `buttons` block becomes one `button` part per button that has `example_parameters`, in order; a `carousel` becomes one `cards` entry per card, built the same way. A `location` header always needs a part with a `location` parameter. Leave out other blocks without any.",
5023
+ description: "The template to send, by its slug handle (for example `bird_otp`)",
4909
5024
  },
4910
5025
  ],
4911
5026
  },
@@ -5074,6 +5189,13 @@ exports.birdProperties = [
5074
5189
  default: "",
5075
5190
  description: "Deprecated: use `to` or `from` instead, which also match a business-scoped user ID. Filters by contact phone number (E.164 exact match), in either direction.",
5076
5191
  },
5192
+ {
5193
+ displayName: "Reference",
5194
+ name: "reference",
5195
+ type: "string",
5196
+ default: "",
5197
+ description: "Keep only messages whose `reference` is exactly this value. The match is case-sensitive, and several messages can share a reference.",
5198
+ },
5077
5199
  {
5078
5200
  displayName: "Status",
5079
5201
  name: "status",
@@ -6168,6 +6290,13 @@ exports.birdProperties = [
6168
6290
  default: {},
6169
6291
  displayOptions: { show: { resource: ["domains"], operation: ["update"] } },
6170
6292
  options: [
6293
+ {
6294
+ displayName: "Default IP Pool ID",
6295
+ name: "default_ip_pool_id",
6296
+ type: "string",
6297
+ default: "",
6298
+ description: "Default IP pool for this domain in this workspace. Used only when a send omits `ip_pool_id`; an explicit send option takes precedence. The pool must belong to the same organization. Set to `null` to use normal organization routing.",
6299
+ },
6171
6300
  {
6172
6301
  displayName: "Dkim",
6173
6302
  name: "dkim",
@@ -6963,6 +7092,23 @@ exports.birdProperties = [
6963
7092
  ],
6964
7093
  description: "ID of the webhook endpoint (`whk_` prefix), as returned when it was created",
6965
7094
  },
7095
+ {
7096
+ displayName: "Return All",
7097
+ name: "returnAll",
7098
+ type: "boolean",
7099
+ displayOptions: { show: { resource: ["webhooks"], operation: ["attempts"] } },
7100
+ default: false,
7101
+ description: "Whether to return all results or only up to a given limit",
7102
+ },
7103
+ {
7104
+ displayName: "Limit",
7105
+ name: "limit",
7106
+ type: "number",
7107
+ typeOptions: { minValue: 1 },
7108
+ displayOptions: { show: { resource: ["webhooks"], operation: ["attempts"] } },
7109
+ default: 50,
7110
+ description: "Max number of results to return",
7111
+ },
6966
7112
  {
6967
7113
  displayName: "Additional Fields",
6968
7114
  name: "additionalFields",
@@ -8626,46 +8772,32 @@ exports.birdProperties = [
8626
8772
  name: "mailbox_id",
8627
8773
  type: "resourceLocator",
8628
8774
  required: true,
8629
- default: { mode: "list", value: "" },
8775
+ default: { mode: "id", value: "" },
8630
8776
  displayOptions: { show: { resource: ["email"], operation: ["mailboxes_get"] } },
8631
8777
  modes: [
8632
- {
8633
- displayName: "From List",
8634
- name: "list",
8635
- type: "list",
8636
- placeholder: "Select a Mailbox...",
8637
- typeOptions: { searchListMethod: "emailMailboxesList", searchable: true },
8638
- },
8639
8778
  {
8640
8779
  displayName: "By ID",
8641
8780
  name: "id",
8642
8781
  type: "string",
8643
8782
  },
8644
8783
  ],
8645
- description: "Mailbox identifier. Starts with `mbx_`.",
8784
+ description: "Mailbox ID or email address in this workspace",
8646
8785
  },
8647
8786
  {
8648
8787
  displayName: "Mailbox",
8649
8788
  name: "mailbox_id",
8650
8789
  type: "resourceLocator",
8651
8790
  required: true,
8652
- default: { mode: "list", value: "" },
8791
+ default: { mode: "id", value: "" },
8653
8792
  displayOptions: { show: { resource: ["email"], operation: ["mailboxes_update"] } },
8654
8793
  modes: [
8655
- {
8656
- displayName: "From List",
8657
- name: "list",
8658
- type: "list",
8659
- placeholder: "Select a Mailbox...",
8660
- typeOptions: { searchListMethod: "emailMailboxesList", searchable: true },
8661
- },
8662
8794
  {
8663
8795
  displayName: "By ID",
8664
8796
  name: "id",
8665
8797
  type: "string",
8666
8798
  },
8667
8799
  ],
8668
- description: "Mailbox identifier. Starts with `mbx_`.",
8800
+ description: "Mailbox ID or email address in this workspace",
8669
8801
  },
8670
8802
  {
8671
8803
  displayName: "Update Fields",
@@ -8759,92 +8891,64 @@ exports.birdProperties = [
8759
8891
  name: "mailbox_id",
8760
8892
  type: "resourceLocator",
8761
8893
  required: true,
8762
- default: { mode: "list", value: "" },
8894
+ default: { mode: "id", value: "" },
8763
8895
  displayOptions: { show: { resource: ["email"], operation: ["mailboxes_delete"] } },
8764
8896
  modes: [
8765
- {
8766
- displayName: "From List",
8767
- name: "list",
8768
- type: "list",
8769
- placeholder: "Select a Mailbox...",
8770
- typeOptions: { searchListMethod: "emailMailboxesList", searchable: true },
8771
- },
8772
8897
  {
8773
8898
  displayName: "By ID",
8774
8899
  name: "id",
8775
8900
  type: "string",
8776
8901
  },
8777
8902
  ],
8778
- description: "Mailbox identifier. Starts with `mbx_`.",
8903
+ description: "Mailbox ID or email address in this workspace",
8779
8904
  },
8780
8905
  {
8781
8906
  displayName: "Mailbox",
8782
8907
  name: "mailbox_id",
8783
8908
  type: "resourceLocator",
8784
8909
  required: true,
8785
- default: { mode: "list", value: "" },
8910
+ default: { mode: "id", value: "" },
8786
8911
  displayOptions: { show: { resource: ["email"], operation: ["mailboxes_restore"] } },
8787
8912
  modes: [
8788
- {
8789
- displayName: "From List",
8790
- name: "list",
8791
- type: "list",
8792
- placeholder: "Select a Mailbox...",
8793
- typeOptions: { searchListMethod: "emailMailboxesList", searchable: true },
8794
- },
8795
8913
  {
8796
8914
  displayName: "By ID",
8797
8915
  name: "id",
8798
8916
  type: "string",
8799
8917
  },
8800
8918
  ],
8801
- description: "Mailbox identifier. Starts with `mbx_`.",
8919
+ description: "Mailbox ID or email address in this workspace",
8802
8920
  },
8803
8921
  {
8804
8922
  displayName: "Mailbox",
8805
8923
  name: "mailbox_id",
8806
8924
  type: "resourceLocator",
8807
8925
  required: true,
8808
- default: { mode: "list", value: "" },
8926
+ default: { mode: "id", value: "" },
8809
8927
  displayOptions: { show: { resource: ["email"], operation: ["mailboxes_resume"] } },
8810
8928
  modes: [
8811
- {
8812
- displayName: "From List",
8813
- name: "list",
8814
- type: "list",
8815
- placeholder: "Select a Mailbox...",
8816
- typeOptions: { searchListMethod: "emailMailboxesList", searchable: true },
8817
- },
8818
8929
  {
8819
8930
  displayName: "By ID",
8820
8931
  name: "id",
8821
8932
  type: "string",
8822
8933
  },
8823
8934
  ],
8824
- description: "Mailbox identifier. Starts with `mbx_`.",
8935
+ description: "Mailbox ID or email address in this workspace",
8825
8936
  },
8826
8937
  {
8827
8938
  displayName: "Mailbox",
8828
8939
  name: "mailbox_id",
8829
8940
  type: "resourceLocator",
8830
8941
  required: true,
8831
- default: { mode: "list", value: "" },
8942
+ default: { mode: "id", value: "" },
8832
8943
  displayOptions: { show: { resource: ["email"], operation: ["mailboxes_stats"] } },
8833
8944
  modes: [
8834
- {
8835
- displayName: "From List",
8836
- name: "list",
8837
- type: "list",
8838
- placeholder: "Select a Mailbox...",
8839
- typeOptions: { searchListMethod: "emailMailboxesList", searchable: true },
8840
- },
8841
8945
  {
8842
8946
  displayName: "By ID",
8843
8947
  name: "id",
8844
8948
  type: "string",
8845
8949
  },
8846
8950
  ],
8847
- description: "Mailbox identifier. Starts with `mbx_`.",
8951
+ description: "Mailbox ID or email address in this workspace",
8848
8952
  },
8849
8953
  {
8850
8954
  displayName: "Additional Fields",
@@ -8894,23 +8998,16 @@ exports.birdProperties = [
8894
8998
  name: "mailbox_id",
8895
8999
  type: "resourceLocator",
8896
9000
  required: true,
8897
- default: { mode: "list", value: "" },
9001
+ default: { mode: "id", value: "" },
8898
9002
  displayOptions: { show: { resource: ["email"], operation: ["mailboxes_messages_create"] } },
8899
9003
  modes: [
8900
- {
8901
- displayName: "From List",
8902
- name: "list",
8903
- type: "list",
8904
- placeholder: "Select a Mailbox...",
8905
- typeOptions: { searchListMethod: "emailMailboxesList", searchable: true },
8906
- },
8907
9004
  {
8908
9005
  displayName: "By ID",
8909
9006
  name: "id",
8910
9007
  type: "string",
8911
9008
  },
8912
9009
  ],
8913
- description: "Mailbox identifier. Starts with `mbx_`.",
9010
+ description: "Mailbox ID or email address in this workspace",
8914
9011
  },
8915
9012
  {
8916
9013
  displayName: "To",
@@ -9131,46 +9228,32 @@ exports.birdProperties = [
9131
9228
  name: "mailbox_id",
9132
9229
  type: "resourceLocator",
9133
9230
  required: true,
9134
- default: { mode: "list", value: "" },
9231
+ default: { mode: "id", value: "" },
9135
9232
  displayOptions: { show: { resource: ["email"], operation: ["mailboxes_labels"] } },
9136
9233
  modes: [
9137
- {
9138
- displayName: "From List",
9139
- name: "list",
9140
- type: "list",
9141
- placeholder: "Select a Mailbox...",
9142
- typeOptions: { searchListMethod: "emailMailboxesList", searchable: true },
9143
- },
9144
9234
  {
9145
9235
  displayName: "By ID",
9146
9236
  name: "id",
9147
9237
  type: "string",
9148
9238
  },
9149
9239
  ],
9150
- description: "Mailbox identifier. Starts with `mbx_`.",
9240
+ description: "Mailbox ID or email address in this workspace",
9151
9241
  },
9152
9242
  {
9153
9243
  displayName: "Mailbox",
9154
9244
  name: "mailbox_id",
9155
9245
  type: "resourceLocator",
9156
9246
  required: true,
9157
- default: { mode: "list", value: "" },
9247
+ default: { mode: "id", value: "" },
9158
9248
  displayOptions: { show: { resource: ["email"], operation: ["mailboxes_receive_rules_list"] } },
9159
9249
  modes: [
9160
- {
9161
- displayName: "From List",
9162
- name: "list",
9163
- type: "list",
9164
- placeholder: "Select a Mailbox...",
9165
- typeOptions: { searchListMethod: "emailMailboxesList", searchable: true },
9166
- },
9167
9250
  {
9168
9251
  displayName: "By ID",
9169
9252
  name: "id",
9170
9253
  type: "string",
9171
9254
  },
9172
9255
  ],
9173
- description: "Mailbox identifier. Starts with `mbx_`.",
9256
+ description: "Mailbox ID or email address in this workspace",
9174
9257
  },
9175
9258
  {
9176
9259
  displayName: "Return All",
@@ -9216,23 +9299,16 @@ exports.birdProperties = [
9216
9299
  name: "mailbox_id",
9217
9300
  type: "resourceLocator",
9218
9301
  required: true,
9219
- default: { mode: "list", value: "" },
9302
+ default: { mode: "id", value: "" },
9220
9303
  displayOptions: { show: { resource: ["email"], operation: ["mailboxes_receive_rules_create"] } },
9221
9304
  modes: [
9222
- {
9223
- displayName: "From List",
9224
- name: "list",
9225
- type: "list",
9226
- placeholder: "Select a Mailbox...",
9227
- typeOptions: { searchListMethod: "emailMailboxesList", searchable: true },
9228
- },
9229
9305
  {
9230
9306
  displayName: "By ID",
9231
9307
  name: "id",
9232
9308
  type: "string",
9233
9309
  },
9234
9310
  ],
9235
- description: "Mailbox identifier. Starts with `mbx_`.",
9311
+ description: "Mailbox ID or email address in this workspace",
9236
9312
  },
9237
9313
  {
9238
9314
  displayName: "Action",
@@ -9279,23 +9355,16 @@ exports.birdProperties = [
9279
9355
  name: "mailbox_id",
9280
9356
  type: "resourceLocator",
9281
9357
  required: true,
9282
- default: { mode: "list", value: "" },
9358
+ default: { mode: "id", value: "" },
9283
9359
  displayOptions: { show: { resource: ["email"], operation: ["mailboxes_receive_rules_delete"] } },
9284
9360
  modes: [
9285
- {
9286
- displayName: "From List",
9287
- name: "list",
9288
- type: "list",
9289
- placeholder: "Select a Mailbox...",
9290
- typeOptions: { searchListMethod: "emailMailboxesList", searchable: true },
9291
- },
9292
9361
  {
9293
9362
  displayName: "By ID",
9294
9363
  name: "id",
9295
9364
  type: "string",
9296
9365
  },
9297
9366
  ],
9298
- description: "Mailbox identifier. Starts with `mbx_`.",
9367
+ description: "Mailbox ID or email address in this workspace",
9299
9368
  },
9300
9369
  {
9301
9370
  displayName: "Rule",
@@ -9385,7 +9454,7 @@ exports.birdProperties = [
9385
9454
  name: "mailbox_id",
9386
9455
  type: "string",
9387
9456
  default: "",
9388
- description: "Filter to conversations in a specific mailbox",
9457
+ description: "Filter to conversations in a mailbox by ID or email address in this workspace. An unknown or ambiguous email address returns 404; a valid mailbox ID with no matching threads returns an empty page.",
9389
9458
  },
9390
9459
  {
9391
9460
  displayName: "Participant",
@@ -10599,23 +10668,16 @@ exports.birdProperties = [
10599
10668
  name: "mailbox_id",
10600
10669
  type: "resourceLocator",
10601
10670
  required: true,
10602
- default: { mode: "list", value: "" },
10671
+ default: { mode: "id", value: "" },
10603
10672
  displayOptions: { show: { resource: ["email"], operation: ["mailboxes_messages_list"] } },
10604
10673
  modes: [
10605
- {
10606
- displayName: "From List",
10607
- name: "list",
10608
- type: "list",
10609
- placeholder: "Select a Mailbox...",
10610
- typeOptions: { searchListMethod: "emailMailboxesList", searchable: true },
10611
- },
10612
10674
  {
10613
10675
  displayName: "By ID",
10614
10676
  name: "id",
10615
10677
  type: "string",
10616
10678
  },
10617
10679
  ],
10618
- description: "Mailbox identifier. Starts with `mbx_`.",
10680
+ description: "Mailbox ID or email address in this workspace",
10619
10681
  },
10620
10682
  {
10621
10683
  displayName: "Return All",
@@ -2,10 +2,10 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.birdRoutes = void 0;
4
4
  exports.birdRoutes = {
5
- "email:send": { method: "POST", path: "/v1/email/messages", pathParams: [], topLevel: ["from", "to"], collections: ["additionalFields"], query: [], body: ["from", "to", "cc", "bcc", "subject", "html", "text", "reply_to", "headers", "tags", "metadata", "parameters", "template", "track_opens", "track_clicks", "ip_pool_id", "category", "attachments", "scheduled_at"], jsonFields: [], structured: { "headers": "map", "tags": "list", "metadata": "map", "parameters": "map", "template": "struct", "attachments": "list" }, preserveEmptyFields: ["parameters"], renames: {}, arrayFields: ["to", "cc", "bcc", "reply_to"], dateTimeFields: ["scheduled_at"], nullableFields: [], binaryFields: ["attachments"], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["emails"] },
5
+ "email:send": { method: "POST", path: "/v1/email/messages", pathParams: [], topLevel: ["from", "to"], collections: ["additionalFields"], query: [], body: ["from", "to", "cc", "bcc", "subject", "html", "text", "reply_to", "headers", "tags", "metadata", "reference", "parameters", "template", "track_opens", "track_clicks", "ip_pool_id", "category", "attachments", "scheduled_at"], jsonFields: [], structured: { "headers": "map", "tags": "list", "metadata": "map", "parameters": "map", "template": "struct", "attachments": "list" }, preserveEmptyFields: ["parameters"], renames: {}, arrayFields: ["to", "cc", "bcc", "reply_to"], dateTimeFields: ["scheduled_at"], nullableFields: [], binaryFields: ["attachments"], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["emails"] },
6
6
  "email:send_batch": { method: "POST", path: "/v1/email/batches", pathParams: [], topLevel: ["messages"], collections: ["additionalFields"], query: [], body: ["messages"], jsonFields: ["messages"], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: true, scopes: ["emails"] },
7
7
  "email:get": { method: "GET", path: "/v1/email/messages/{message_id}", pathParams: ["message_id"], topLevel: ["message_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["emails"] },
8
- "email:list": { method: "GET", path: "/v1/email/messages", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["limit", "starting_after", "ending_before", "created_after", "created_before", "broadcast_id", "status", "tag", "category", "to", "from"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: ["tag"], dateTimeFields: ["created_after", "created_before"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["emails"] },
8
+ "email:list": { method: "GET", path: "/v1/email/messages", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["limit", "starting_after", "ending_before", "created_after", "created_before", "broadcast_id", "status", "tag", "reference", "category", "to", "from"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: ["tag"], dateTimeFields: ["created_after", "created_before"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["emails"] },
9
9
  "email:cancel": { method: "POST", path: "/v1/email/messages/{message_id}/cancel", pathParams: ["message_id"], topLevel: ["message_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["emails"] },
10
10
  "email:stats_summary": { method: "GET", path: "/v1/email/stats/summary", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["from", "to", "timezone", "category", "sending_domain", "tag", "sending_ip", "recipient_domain", "template", "compare"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["emails"] },
11
11
  "email:stats_daily": { method: "GET", path: "/v1/email/stats/daily", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["from", "to", "timezone", "category", "sending_domain", "tag", "sending_ip", "recipient_domain", "template"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["emails"] },
@@ -24,10 +24,10 @@ exports.birdRoutes = {
24
24
  "email:stats_by_complaint_type": { method: "GET", path: "/v1/email/stats/complaint-types", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["starting_after", "ending_before", "from", "to", "timezone", "category", "sort", "limit"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["emails"] },
25
25
  "email:stats_by_broadcast": { method: "GET", path: "/v1/email/stats/broadcasts", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["starting_after", "ending_before", "from", "to", "timezone", "category", "sort", "limit"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["email_marketing"] },
26
26
  "email:templates_list": { method: "GET", path: "/v1/email/templates", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["scope", "category", "source", "theme", "q", "limit", "starting_after", "ending_before"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["email_management"] },
27
- "sms:send": { method: "POST", path: "/v1/sms/messages", pathParams: [], topLevel: ["to"], collections: ["additionalFields"], query: [], body: ["to", "from", "text", "category", "tags", "metadata", "options", "template"], jsonFields: [], structured: { "tags": "list", "metadata": "map", "options": "struct", "template": "struct" }, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["sms"] },
27
+ "sms:send": { method: "POST", path: "/v1/sms/messages", pathParams: [], topLevel: ["to"], collections: ["additionalFields"], query: [], body: ["to", "to_country_code", "from", "text", "binary", "category", "validity_period", "reference", "cost_center", "tags", "metadata", "options", "messaging_profile_id", "template"], jsonFields: [], structured: { "binary": "struct", "tags": "list", "metadata": "map", "options": "struct", "template": "struct" }, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["sms"] },
28
28
  "sms:send_batch": { method: "POST", path: "/v1/sms/batches", pathParams: [], topLevel: ["messages"], collections: ["additionalFields"], query: [], body: ["messages"], jsonFields: ["messages"], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: true, scopes: ["sms"] },
29
29
  "sms:get": { method: "GET", path: "/v1/sms/messages/{message_id}", pathParams: ["message_id"], topLevel: ["message_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["sms"] },
30
- "sms:list": { method: "GET", path: "/v1/sms/messages", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["limit", "starting_after", "ending_before", "created_after", "created_before", "direction", "status", "error_code", "category", "to", "from", "tag"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: ["status", "error_code", "tag"], dateTimeFields: ["created_after", "created_before"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["sms"] },
30
+ "sms:list": { method: "GET", path: "/v1/sms/messages", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["limit", "starting_after", "ending_before", "created_after", "created_before", "direction", "status", "error_code", "category", "to", "from", "country", "tag", "reference"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: ["status", "error_code", "tag"], dateTimeFields: ["created_after", "created_before"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["sms"] },
31
31
  "sms_templates:list": { method: "GET", path: "/v1/sms/templates", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["scope", "category", "status", "language", "q", "sort", "order", "limit", "starting_after", "ending_before"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["sms_management"] },
32
32
  "sms_templates:get": { method: "GET", path: "/v1/sms/templates/{template_ref}", pathParams: ["template_ref"], topLevel: ["template_ref"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["sms_management"] },
33
33
  "sms:list_events": { method: "GET", path: "/v1/sms/messages/{message_id}/events", pathParams: ["message_id"], topLevel: ["message_id"], collections: ["additionalFields"], query: ["type"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["sms"] },
@@ -56,9 +56,9 @@ exports.birdRoutes = {
56
56
  "sms_keyword_rules:create": { method: "POST", path: "/v1/sms/keyword-rules", pathParams: [], topLevel: ["keyword_operation"], collections: ["additionalFields"], query: [], body: ["operation", "country", "language", "number", "keywords", "reply", "confirmed_self_managed"], jsonFields: [], structured: {}, renames: { "keyword_operation": "operation" }, arrayFields: ["keywords"], dateTimeFields: [], nullableFields: ["country", "language", "number", "reply"], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["sms_management"] },
57
57
  "sms_keyword_rules:update": { method: "PATCH", path: "/v1/sms/keyword-rules/{id}", pathParams: ["id"], topLevel: ["id"], collections: ["updateFields"], query: [], body: ["keywords", "reply", "confirmed_self_managed"], jsonFields: [], structured: {}, renames: {}, arrayFields: ["keywords"], dateTimeFields: [], nullableFields: ["reply"], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["sms_management"] },
58
58
  "sms_keyword_rules:delete": { method: "DELETE", path: "/v1/sms/keyword-rules/{id}", pathParams: ["id"], topLevel: ["id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["sms_management"] },
59
- "whatsapp:send": { method: "POST", path: "/v1/whatsapp/messages", pathParams: [], topLevel: ["to"], collections: ["additionalFields"], query: [], body: ["to", "from", "template", "text", "image", "video", "audio", "sticker", "document", "location", "interactive", "contact_cards", "in_reply_to_message_id", "tags", "metadata"], jsonFields: ["template.components", "interactive.header", "interactive.buttons", "interactive.list", "interactive.cta_url", "interactive.cards", "contact_cards"], structured: { "template": "struct", "text": "struct", "image": "struct", "video": "struct", "audio": "struct", "sticker": "struct", "document": "struct", "location": "struct", "interactive": "struct", "tags": "list", "metadata": "map" }, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["whatsapp"] },
59
+ "whatsapp:send": { method: "POST", path: "/v1/whatsapp/messages", pathParams: [], topLevel: ["to"], collections: ["additionalFields"], query: [], body: ["to", "from", "template", "text", "image", "video", "audio", "sticker", "document", "location", "interactive", "contact_cards", "in_reply_to_message_id", "tags", "metadata", "reference"], jsonFields: ["template.components", "interactive.header", "interactive.buttons", "interactive.list", "interactive.cta_url", "interactive.cards", "contact_cards"], structured: { "template": "struct", "text": "struct", "image": "struct", "video": "struct", "audio": "struct", "sticker": "struct", "document": "struct", "location": "struct", "interactive": "struct", "tags": "list", "metadata": "map" }, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["whatsapp"] },
60
60
  "whatsapp:get": { method: "GET", path: "/v1/whatsapp/messages/{message_id}", pathParams: ["message_id"], topLevel: ["message_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["whatsapp"] },
61
- "whatsapp:list": { method: "GET", path: "/v1/whatsapp/messages", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["limit", "starting_after", "ending_before", "created_after", "created_before", "status", "direction", "to", "from", "phone_number", "bsuid", "category", "group_id", "tag"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: ["status", "tag"], dateTimeFields: ["created_after", "created_before"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["whatsapp"] },
61
+ "whatsapp:list": { method: "GET", path: "/v1/whatsapp/messages", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["limit", "starting_after", "ending_before", "created_after", "created_before", "status", "direction", "to", "from", "phone_number", "bsuid", "category", "group_id", "tag", "reference"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: ["status", "tag"], dateTimeFields: ["created_after", "created_before"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["whatsapp"] },
62
62
  "whatsapp:list_events": { method: "GET", path: "/v1/whatsapp/messages/{message_id}/events", pathParams: ["message_id"], topLevel: ["message_id"], collections: ["additionalFields"], query: ["type"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["whatsapp"] },
63
63
  "voice:legs_list": { method: "GET", path: "/v1/voice/legs", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["direction", "status", "call_id", "sip_trunk_id", "from", "to", "number", "tag", "started_after", "started_before", "limit", "starting_after", "ending_before"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: ["status", "tag"], dateTimeFields: ["started_after", "started_before"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["voice"] },
64
64
  "voice:legs_get": { method: "GET", path: "/v1/voice/legs/{leg_id}", pathParams: ["leg_id"], topLevel: ["leg_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["voice"] },
@@ -82,7 +82,7 @@ exports.birdRoutes = {
82
82
  "domains:get": { method: "GET", path: "/v1/email/domains/{domain_id}", pathParams: ["domain_id"], topLevel: ["domain_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["domains"] },
83
83
  "domains:create": { method: "POST", path: "/v1/email/domains", pathParams: [], topLevel: ["domain"], collections: ["additionalFields"], query: [], body: ["domain", "return_path", "tracking", "dkim", "settings"], jsonFields: [], structured: { "return_path": "struct", "tracking": "struct", "dkim": "struct", "settings": "struct" }, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["domains"] },
84
84
  "domains:verify": { method: "POST", path: "/v1/email/domains/{domain_id}/verify", pathParams: ["domain_id"], topLevel: ["domain_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["domains"] },
85
- "domains:update": { method: "PATCH", path: "/v1/email/domains/{domain_id}", pathParams: ["domain_id"], topLevel: ["domain_id"], collections: ["updateFields"], query: [], body: ["settings", "return_path", "tracking", "dkim", "inbound"], jsonFields: [], structured: { "settings": "struct", "return_path": "struct", "tracking": "struct", "dkim": "struct", "inbound": "struct" }, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: ["tracking"], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["domains"] },
85
+ "domains:update": { method: "PATCH", path: "/v1/email/domains/{domain_id}", pathParams: ["domain_id"], topLevel: ["domain_id"], collections: ["updateFields"], query: [], body: ["default_ip_pool_id", "settings", "return_path", "tracking", "dkim", "inbound"], jsonFields: [], structured: { "settings": "struct", "return_path": "struct", "tracking": "struct", "dkim": "struct", "inbound": "struct" }, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: ["default_ip_pool_id", "tracking"], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["domains"] },
86
86
  "domains:delete": { method: "DELETE", path: "/v1/email/domains/{domain_id}", pathParams: ["domain_id"], topLevel: ["domain_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["domains"] },
87
87
  "inbound_address:list": { method: "GET", path: "/v1/email/inbound-addresses", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["limit", "starting_after", "ending_before"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["emails"] },
88
88
  "inbound_address:create": { method: "POST", path: "/v1/email/inbound-addresses", pathParams: [], topLevel: [], collections: ["additionalFields"], query: [], body: ["label"], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["email_management"] },
@@ -102,7 +102,7 @@ exports.birdRoutes = {
102
102
  "webhooks:create": { method: "POST", path: "/v1/webhooks", pathParams: [], topLevel: ["events"], collections: ["additionalFields"], query: [], body: ["url", "filter", "events", "description"], jsonFields: [], structured: { "filter": "struct" }, renames: {}, arrayFields: ["events"], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["webhooks"] },
103
103
  "webhooks:test": { method: "POST", path: "/v1/webhooks/{webhook_id}/test", pathParams: ["webhook_id"], topLevel: ["webhook_id"], collections: ["additionalFields"], query: [], body: ["event_type"], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["webhooks"] },
104
104
  "webhooks:delete": { method: "DELETE", path: "/v1/webhooks/{webhook_id}", pathParams: ["webhook_id"], topLevel: ["webhook_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["webhooks"] },
105
- "webhooks:attempts": { method: "GET", path: "/v1/webhooks/{webhook_id}/attempts", pathParams: ["webhook_id"], topLevel: ["webhook_id"], collections: ["additionalFields"], query: ["limit", "before", "after"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: ["before", "after"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["webhooks"] },
105
+ "webhooks:attempts": { method: "GET", path: "/v1/webhooks/{webhook_id}/attempts", pathParams: ["webhook_id"], topLevel: ["webhook_id"], collections: ["additionalFields"], query: ["limit", "before", "after", "starting_after", "ending_before"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: ["before", "after"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["webhooks"] },
106
106
  "webhooks:replay": { method: "POST", path: "/v1/webhooks/{webhook_id}/replay", pathParams: ["webhook_id"], topLevel: ["webhook_id"], collections: ["additionalFields"], query: [], body: ["since", "until"], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: ["since", "until"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["webhooks"] },
107
107
  "webhooks:rotate_secret": { method: "POST", path: "/v1/webhooks/{webhook_id}/rotate-secret", pathParams: ["webhook_id"], topLevel: ["webhook_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["webhooks"] },
108
108
  "webhooks:update": { method: "PATCH", path: "/v1/webhooks/{webhook_id}", pathParams: ["webhook_id"], topLevel: ["webhook_id"], collections: ["updateFields"], query: [], body: ["url", "description", "filter", "events", "destination", "status"], jsonFields: ["destination.connector"], structured: { "filter": "struct", "destination": "struct" }, renames: {}, arrayFields: ["events"], dateTimeFields: [], nullableFields: ["filter"], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["webhooks"] },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@messagebird/n8n-nodes-bird",
3
- "version": "0.30.1",
3
+ "version": "0.32.0",
4
4
  "description": "The official Bird node for n8n: email, SMS, WhatsApp, and verification, plus a webhook trigger for Bird events.",
5
5
  "license": "MIT",
6
6
  "author": {
@@ -44,9 +44,9 @@
44
44
  ]
45
45
  },
46
46
  "scripts": {
47
- "build": "rimraf dist && tsc6 && cp nodes/Bird/bird.svg nodes/Bird/bird-dark.svg nodes/Bird/Bird.node.json nodes/Bird/BirdTrigger.node.json dist/nodes/Bird/ && cp credentials/bird.svg credentials/bird-dark.svg dist/credentials/",
47
+ "build": "rimraf dist && tsc && cp nodes/Bird/bird.svg nodes/Bird/bird-dark.svg nodes/Bird/Bird.node.json nodes/Bird/BirdTrigger.node.json dist/nodes/Bird/ && cp credentials/bird.svg credentials/bird-dark.svg dist/credentials/",
48
48
  "test": "vitest run",
49
- "typecheck": "tsc6 --noEmit",
49
+ "typecheck": "tsc --noEmit",
50
50
  "lint": "npm run typecheck && node scan.mjs",
51
51
  "prepack": "npm run build"
52
52
  },
@@ -54,11 +54,11 @@
54
54
  "n8n-workflow": "*"
55
55
  },
56
56
  "devDependencies": {
57
- "@n8n/scan-community-package": "0.33.0",
58
- "@types/node": "22.20.2",
57
+ "@n8n/scan-community-package": "0.40.0",
58
+ "@types/node": "22.20.5",
59
59
  "n8n-workflow": "2.16.0",
60
60
  "rimraf": "6.1.3",
61
- "typescript": "npm:@typescript/typescript6@^6.0.2",
62
- "vitest": "5.0.0"
61
+ "typescript": "npm:typescript@7.1.0-beta",
62
+ "vitest": "5.0.5"
63
63
  }
64
64
  }