@messagebird/n8n-nodes-bird 0.33.0 → 0.34.1

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/README.md CHANGED
@@ -21,7 +21,7 @@ On a self-hosted instance that has not enabled community nodes in the panel, use
21
21
  The **Bird** node covers the public Bird API: email and SMS sends, delivery status and event timelines, WhatsApp, verification, templates, sending domains, suppressions, inbound routes, webhooks, statistics, lookup, and more. Resources and operations mirror the API reference at https://bird.com/docs/api. Four areas are deliberately out: publishing and subscribing on Realtime, which needs an app key and secret this credential cannot hold (managing Realtime apps and keys is included); the attachment and media downloads, which return bytes rather than the JSON a workflow item carries; redirect-based media fetches; and authoring reusable email templates (sending an existing email template, and listing the ones a workspace has, are covered).
22
22
 
23
23
  <details>
24
- <summary><strong>181 operations across 22 resources</strong></summary>
24
+ <summary><strong>182 operations across 22 resources</strong></summary>
25
25
 
26
26
  - **Audience** (9) — Add Contacts, Create, Delete, Get, List, List Contacts, Remove Contact, Remove Contacts, Update
27
27
  - **Contact** (7) — Batch, Create, Delete, Get, List, List Preferences, Update
@@ -35,7 +35,7 @@ The **Bird** node covers the public Bird API: email and SMS sends, delivery stat
35
35
  - **Number** (10) — Cancel, Create Order, Get, Get Available Number, Get Order, List, List Available Numbers, List Orders, Release, Update
36
36
  - **Preference** (4) — Create, Delete, Get, List
37
37
  - **Realtime** (9) — Create App, Create App Key, Delete App, Get App, List App Keys, List Apps, List Regions, Revoke App Key, Update App
38
- - **SMS** (21) — Get, List, List Events, Send, Send Batch, Stats By Carrier, Stats By Category, Stats By Country, Stats By Error Code, Stats By Originator, Stats By Status, Stats By Tag, Stats Daily, Stats Hourly, Stats Inbound By Country, Stats Inbound By Number, Stats Inbound By Operator, Stats Inbound Daily, Stats Inbound Hourly, Stats Inbound Summary, Stats Summary
38
+ - **SMS** (22) — Get, List, List Events, Send, Send Batch, Stats By Carrier, Stats By Category, Stats By Cost Center, Stats By Country, Stats By Error Code, Stats By Originator, Stats By Status, Stats By Tag, Stats Daily, Stats Hourly, Stats Inbound By Country, Stats Inbound By Number, Stats Inbound By Operator, Stats Inbound Daily, Stats Inbound Hourly, Stats Inbound Summary, Stats Summary
39
39
  - **SMS Keyword Rule** (5) — Create, Delete, Get, List, Update
40
40
  - **SMS Suppression** (4) — Add, Get, List, Remove
41
41
  - **SMS Template** (2) — Get, List
@@ -115,6 +115,7 @@ exports.birdProperties = [
115
115
  { name: "Send Batch", value: "send_batch", action: "Create a batch of SMS messages", description: "Create a batch of SMS messages" },
116
116
  { name: "Stats By Carrier", value: "stats_by_carrier", action: "Get outbound SMS statistics by carrier", description: "Get outbound SMS statistics by carrier" },
117
117
  { name: "Stats By Category", value: "stats_by_category", action: "Get outbound SMS statistics by category", description: "Get outbound SMS statistics by category" },
118
+ { name: "Stats By Cost Center", value: "stats_by_cost_center", action: "Get outbound SMS statistics by cost center", description: "Get outbound SMS statistics by cost center" },
118
119
  { name: "Stats By Country", value: "stats_by_country", action: "Get outbound SMS statistics by country", description: "Get outbound SMS statistics by country" },
119
120
  { name: "Stats By Error Code", value: "stats_by_error_code", action: "Get outbound SMS statistics by error code", description: "Get outbound SMS statistics by error code" },
120
121
  { name: "Stats By Originator", value: "stats_by_originator", action: "Get outbound SMS statistics by originator", description: "Get outbound SMS statistics by originator" },
@@ -3400,6 +3401,13 @@ exports.birdProperties = [
3400
3401
  default: "",
3401
3402
  description: "Set to `previous_period` to also include the same statistics for the immediately preceding window of equal length, plus the change between the two, so you can show \"+X% vs last period\" without a second request",
3402
3403
  },
3404
+ {
3405
+ displayName: "Cost Center",
3406
+ name: "cost_center",
3407
+ type: "string",
3408
+ default: "",
3409
+ description: "Restrict the statistics to messages sent with this cost center. The match is exact. Mutually exclusive with the other dimension filters; only one may be set per request.",
3410
+ },
3403
3411
  {
3404
3412
  displayName: "Country",
3405
3413
  name: "country",
@@ -3459,6 +3467,13 @@ exports.birdProperties = [
3459
3467
  default: "",
3460
3468
  description: "Restrict the statistics to a single category. Mutually exclusive with the other dimension filters; only one may be set per request.",
3461
3469
  },
3470
+ {
3471
+ displayName: "Cost Center",
3472
+ name: "cost_center",
3473
+ type: "string",
3474
+ default: "",
3475
+ description: "Restrict the statistics to messages sent with this cost center. The match is exact. Mutually exclusive with the other dimension filters; only one may be set per request.",
3476
+ },
3462
3477
  {
3463
3478
  displayName: "Country",
3464
3479
  name: "country",
@@ -3518,6 +3533,13 @@ exports.birdProperties = [
3518
3533
  default: "",
3519
3534
  description: "Restrict the statistics to a single category. Mutually exclusive with the other dimension filters; only one may be set per request.",
3520
3535
  },
3536
+ {
3537
+ displayName: "Cost Center",
3538
+ name: "cost_center",
3539
+ type: "string",
3540
+ default: "",
3541
+ description: "Restrict the statistics to messages sent with this cost center. The match is exact. Mutually exclusive with the other dimension filters; only one may be set per request.",
3542
+ },
3521
3543
  {
3522
3544
  displayName: "Country",
3523
3545
  name: "country",
@@ -4100,6 +4122,92 @@ exports.birdProperties = [
4100
4122
  },
4101
4123
  ],
4102
4124
  },
4125
+ {
4126
+ displayName: "Additional Fields",
4127
+ name: "additionalFields",
4128
+ type: "collection",
4129
+ placeholder: "Add Field",
4130
+ default: {},
4131
+ displayOptions: { show: { resource: ["sms"], operation: ["stats_by_cost_center"] } },
4132
+ options: [
4133
+ {
4134
+ displayName: "From",
4135
+ name: "from",
4136
+ type: "string",
4137
+ default: "",
4138
+ description: "Start date (inclusive) in YYYY-MM-DD, interpreted as a calendar day in `timezone` (a UTC day when `timezone` is omitted). Defaults to 30 days before `to` when omitted; with `include_trend=true` and `trend_grain=hourly` the default tightens to keep the window within the 720-hour trend cap.",
4139
+ },
4140
+ {
4141
+ displayName: "Include Trend",
4142
+ name: "include_trend",
4143
+ type: "boolean",
4144
+ default: false,
4145
+ description: "Whether each row also carries a `trend` array: a short per-bucket lifecycle-count series for that row over the window. Returned only when `limit` is 50 or fewer and the window is at most 90 days (trend_grain=daily) or 720 hours (trend_grain=hourly); a larger request returns 422.",
4146
+ },
4147
+ {
4148
+ displayName: "Max Results",
4149
+ name: "max_results",
4150
+ type: "number",
4151
+ default: "",
4152
+ description: "Maximum number of cost center rows to return, ranked by the `sort` field descending",
4153
+ },
4154
+ {
4155
+ displayName: "Timezone",
4156
+ name: "timezone",
4157
+ type: "string",
4158
+ default: "",
4159
+ description: "IANA timezone identifier used to group statistics, for example `Asia/Kathmandu`. The default is UTC. Day and hour boundaries, including the default window when `from` and `to` are omitted, follow this timezone. When this parameter is set, pass `from` and `to` as calendar days or `Z` instants instead of timestamps with explicit UTC offsets.",
4160
+ },
4161
+ {
4162
+ displayName: "To",
4163
+ name: "to",
4164
+ type: "string",
4165
+ default: "",
4166
+ description: "End date (inclusive) in YYYY-MM-DD, interpreted as a calendar day in `timezone` (a UTC day when `timezone` is omitted). Defaults to today in that timezone when omitted. Window may not exceed 365 days.",
4167
+ },
4168
+ {
4169
+ displayName: "Trend Grain",
4170
+ name: "trend_grain",
4171
+ type: "options",
4172
+ options: [
4173
+ { name: "Not Set", value: "" },
4174
+ { name: "Daily", value: "daily" },
4175
+ { name: "Hourly", value: "hourly" },
4176
+ ],
4177
+ default: "",
4178
+ description: "Bucket grain for the `trend` series. Has no effect unless `include_trend=true`.",
4179
+ },
4180
+ ],
4181
+ },
4182
+ {
4183
+ displayName: "Sort",
4184
+ name: "sort",
4185
+ type: "collection",
4186
+ placeholder: "Add Sort Option",
4187
+ default: {},
4188
+ displayOptions: { show: { resource: ["sms"], operation: ["stats_by_cost_center"] } },
4189
+ options: [
4190
+ {
4191
+ displayName: "Sort By",
4192
+ name: "sort",
4193
+ type: "options",
4194
+ options: [
4195
+ { name: "Accepted", value: "accepted" },
4196
+ { name: "Delivered", value: "delivered" },
4197
+ { name: "Delivery Rate", value: "delivery_rate" },
4198
+ { name: "Expired", value: "expired" },
4199
+ { name: "Failed", value: "failed" },
4200
+ { name: "Failure Rate", value: "failure_rate" },
4201
+ { name: "Not Set", value: "" },
4202
+ { name: "Rejected", value: "rejected" },
4203
+ { name: "Sent", value: "sent" },
4204
+ { name: "Undelivered", value: "undelivered" },
4205
+ ],
4206
+ default: "",
4207
+ description: "Metric to rank rows by, applied descending. Any lifecycle count or derived rate in the response may be used; rows whose rate is undefined (zero denominator) sort last. Defaults to `accepted`.",
4208
+ },
4209
+ ],
4210
+ },
4103
4211
  {
4104
4212
  displayName: "Additional Fields",
4105
4213
  name: "additionalFields",
@@ -4672,7 +4780,7 @@ exports.birdProperties = [
4672
4780
  required: true,
4673
4781
  displayOptions: { show: { resource: ["whatsapp"], operation: ["send"] } },
4674
4782
  default: "",
4675
- description: "The recipient: a phone number in E.164 format (for example `+14155550100`), a business-scoped user ID (for example `US.13491208655302741918`) for a WhatsApp user whose number you do not have, or a WhatsApp group ID (for example `wag_01krdgeqcxet5s7t44vh8rt9mg`). One-time-passcode templates need a phone number. Bird tracks the customer service window per identity and business number, so reply to the identity a contact's message came from, from the number it reached.",
4783
+ description: "Recipient E.164 number, business-scoped user ID (BSUID, such as `US.13491208655302741918`), or group ID (such as `wag_01krdgeqcxet5s7t44vh8rt9mg`). OTP templates require a phone number. For replies, use the inbound sender identity and receiving business number.",
4676
4784
  },
4677
4785
  {
4678
4786
  displayName: "Additional Fields",
@@ -4688,21 +4796,21 @@ exports.birdProperties = [
4688
4796
  type: "collection",
4689
4797
  placeholder: "Add Field",
4690
4798
  default: {},
4691
- description: "Free-form audio. Deliverable only inside an open customer service window.",
4799
+ description: "Free-form audio; requires an open customer service window",
4692
4800
  options: [
4693
4801
  {
4694
4802
  displayName: "URL",
4695
4803
  name: "url",
4696
4804
  type: "string",
4697
4805
  default: "",
4698
- description: "Public `https` URL of the audio file. WhatsApp fetches it at send time, so it must still be reachable then. AAC, AMR, MP3, M4A or OGG (OPUS codec, mono), up to 16 MB.",
4806
+ description: "Public HTTPS URL fetched at send time. AAC, AMR, MP3, M4A, or OGG (OPUS, mono), up to 16 MB.",
4699
4807
  },
4700
4808
  {
4701
4809
  displayName: "Voice",
4702
4810
  name: "voice",
4703
4811
  type: "boolean",
4704
4812
  default: false,
4705
- description: "Whether to send this as a voice note rather than an audio file. A voice note needs an `.ogg` file encoded with the OPUS codec.",
4813
+ description: "Whether to send as a voice note; requires an `.ogg` file with the OPUS codec",
4706
4814
  },
4707
4815
  ],
4708
4816
  },
@@ -4711,7 +4819,7 @@ exports.birdProperties = [
4711
4819
  name: "contact_cards",
4712
4820
  type: "json",
4713
4821
  default: "",
4714
- description: "Up to five contact cards, each `name` carrying `formatted_name` plus at least one other part. Deliverable only inside an open customer service window.",
4822
+ description: "Up to five cards. Each name needs `formatted_name` and another name part. Requires an open customer service window.",
4715
4823
  },
4716
4824
  {
4717
4825
  displayName: "Document",
@@ -4719,14 +4827,14 @@ exports.birdProperties = [
4719
4827
  type: "collection",
4720
4828
  placeholder: "Add Field",
4721
4829
  default: {},
4722
- description: "A free-form document. Deliverable only inside an open customer service window.",
4830
+ description: "Free-form document; requires an open customer service window",
4723
4831
  options: [
4724
4832
  {
4725
4833
  displayName: "URL",
4726
4834
  name: "url",
4727
4835
  type: "string",
4728
4836
  default: "",
4729
- description: "Public `https` URL of the document. WhatsApp fetches it at send time, so it must still be reachable then. Up to 100 MB; PDF, Word, Excel, PowerPoint and plain text render reliably in the WhatsApp client.",
4837
+ description: "Public HTTPS URL fetched at send time, up to 100 MB. PDF, Word, Excel, PowerPoint, and plain text render reliably.",
4730
4838
  },
4731
4839
  {
4732
4840
  displayName: "Caption",
@@ -4740,7 +4848,7 @@ exports.birdProperties = [
4740
4848
  name: "filename",
4741
4849
  type: "string",
4742
4850
  default: "",
4743
- description: "Name the recipient sees, including the extension. WhatsApp derives one from the URL when you omit it.",
4851
+ description: "Recipient-visible filename with extension",
4744
4852
  },
4745
4853
  ],
4746
4854
  },
@@ -4749,7 +4857,7 @@ exports.birdProperties = [
4749
4857
  name: "from",
4750
4858
  type: "string",
4751
4859
  default: "",
4752
- description: "The business phone number to send from, in E.164 format: a connected number this workspace owns, on the same WhatsApp Business Account as an authored template. Omit it for a Bird-managed template or a group send, which use their own number; every other send requires it.",
4860
+ description: "Connected E.164 number owned by this workspace; for authored templates, use the same WhatsApp Business Account. Omit for Bird-managed templates and groups; required otherwise.",
4753
4861
  },
4754
4862
  {
4755
4863
  displayName: "Image",
@@ -4757,14 +4865,14 @@ exports.birdProperties = [
4757
4865
  type: "collection",
4758
4866
  placeholder: "Add Field",
4759
4867
  default: {},
4760
- description: "A free-form image. Deliverable only inside an open customer service window.",
4868
+ description: "Free-form image; requires an open customer service window",
4761
4869
  options: [
4762
4870
  {
4763
4871
  displayName: "URL",
4764
4872
  name: "url",
4765
4873
  type: "string",
4766
4874
  default: "",
4767
- description: "Public `https` URL of the image. WhatsApp fetches it at send time, so it must still be reachable then. JPEG or PNG, up to 5 MB.",
4875
+ description: "Public HTTPS URL fetched at send time. JPEG/PNG, up to 5 MB.",
4768
4876
  },
4769
4877
  {
4770
4878
  displayName: "Caption",
@@ -4780,7 +4888,7 @@ exports.birdProperties = [
4780
4888
  name: "in_reply_to_message_id",
4781
4889
  type: "string",
4782
4890
  default: "",
4783
- description: "An earlier message to quote above this one: one from the same conversation, between this `to` and `from`, in the last 15 days",
4891
+ description: "Message to quote, from this conversation (`to` and `from`) within the last 15 days",
4784
4892
  },
4785
4893
  {
4786
4894
  displayName: "Interactive",
@@ -4788,56 +4896,56 @@ exports.birdProperties = [
4788
4896
  type: "collection",
4789
4897
  placeholder: "Add Field",
4790
4898
  default: {},
4791
- description: "Free-form interactive content: reply buttons, a list menu, a link button, media cards, or a request for the recipient's location or contact details. Deliverable only inside an open customer service window, and never to a group.",
4899
+ description: "Reply buttons, a list, a link button, media cards, or a location/contact request. Requires an open customer service window; unsupported for groups.",
4792
4900
  options: [
4793
4901
  {
4794
4902
  displayName: "Body Text",
4795
4903
  name: "body_text",
4796
4904
  type: "string",
4797
4905
  default: "",
4798
- description: "The message's main text, required on every kind. Up to 1024 characters, except on a `list`.",
4906
+ description: "Required main text. Maximum 1024 characters, or 4096 for `list`.",
4799
4907
  },
4800
4908
  {
4801
4909
  displayName: "Buttons",
4802
4910
  name: "buttons",
4803
4911
  type: "json",
4804
4912
  default: "",
4805
- description: "The `quick_reply` buttons of a `button` message, in order. Labels must be unique within the message.",
4913
+ description: "Ordered `quick_reply` buttons for `button` messages. Labels must be unique within the message.",
4806
4914
  },
4807
4915
  {
4808
4916
  displayName: "Cards",
4809
4917
  name: "cards",
4810
4918
  type: "json",
4811
4919
  default: "",
4812
- description: "The cards of a `carousel` message, 2 to 10, left to right. A carousel takes no header or footer of its own.",
4920
+ description: "2–10 carousel cards, in display order. No message-level header or footer.",
4813
4921
  },
4814
4922
  {
4815
4923
  displayName: "Cta URL",
4816
4924
  name: "cta_url",
4817
4925
  type: "json",
4818
4926
  default: "",
4819
- description: "The link button to show. Send this on a `cta_url` message.",
4927
+ description: "Link button for a `cta_url` message",
4820
4928
  },
4821
4929
  {
4822
4930
  displayName: "Footer Text",
4823
4931
  name: "footer_text",
4824
4932
  type: "string",
4825
4933
  default: "",
4826
- description: "Optional small print below the body and above the buttons. A `carousel` and both request kinds take no footer.",
4934
+ description: "Small print below the body. Unsupported for carousel and request kinds.",
4827
4935
  },
4828
4936
  {
4829
4937
  displayName: "Header",
4830
4938
  name: "header",
4831
4939
  type: "json",
4832
4940
  default: "",
4833
- description: "Optional content above the body: text on a `list`; text, image, video or document on `button` and `cta_url`. A `carousel` and the two request kinds take none.",
4941
+ description: "For `list`: text only. For `button` and `cta_url`: text, image, video, or document. Unsupported for carousel and request kinds.",
4834
4942
  },
4835
4943
  {
4836
4944
  displayName: "List",
4837
4945
  name: "list",
4838
4946
  type: "json",
4839
4947
  default: "",
4840
- description: "The menu to show. Send this on a `list` message.",
4948
+ description: "Menu for a `list` message",
4841
4949
  },
4842
4950
  {
4843
4951
  displayName: "Type",
@@ -4853,7 +4961,7 @@ exports.birdProperties = [
4853
4961
  { name: "Request Contact Info", value: "request_contact_info" },
4854
4962
  ],
4855
4963
  default: "",
4856
- description: "Which kind of interactive message this is, and which field carries it",
4964
+ description: "Message kind; determines which content field to supply",
4857
4965
  },
4858
4966
  ],
4859
4967
  },
@@ -4863,7 +4971,7 @@ exports.birdProperties = [
4863
4971
  type: "collection",
4864
4972
  placeholder: "Add Field",
4865
4973
  default: {},
4866
- description: "A free-form location. Deliverable only inside an open customer service window.",
4974
+ description: "Free-form location; requires an open customer service window",
4867
4975
  options: [
4868
4976
  {
4869
4977
  displayName: "Latitude",
@@ -4884,14 +4992,14 @@ exports.birdProperties = [
4884
4992
  name: "name",
4885
4993
  type: "string",
4886
4994
  default: "",
4887
- description: "Name of the place, shown above the address",
4995
+ description: "Place name, shown above the address",
4888
4996
  },
4889
4997
  {
4890
4998
  displayName: "Address",
4891
4999
  name: "address",
4892
5000
  type: "string",
4893
5001
  default: "",
4894
- description: "Street address of the place. Shown only when `name` is also set.",
5002
+ description: "Street address; shown only with `name`",
4895
5003
  },
4896
5004
  ],
4897
5005
  },
@@ -4902,7 +5010,7 @@ exports.birdProperties = [
4902
5010
  typeOptions: { multipleValues: true },
4903
5011
  placeholder: "Add Pair",
4904
5012
  default: {},
4905
- description: "Arbitrary JSON object stored on the message and returned on API reads. Maximum 2 KB serialized. Use metadata for per-send context like internal IDs and foreign keys. For low-cardinality filterable labels, use `tags` instead.",
5013
+ description: "Per-message JSON context, such as internal IDs, returned on reads. Maximum 2 KB serialized. Use `tags` for filterable labels.",
4906
5014
  options: [
4907
5015
  {
4908
5016
  displayName: "Pair",
@@ -4929,7 +5037,7 @@ exports.birdProperties = [
4929
5037
  name: "reference",
4930
5038
  type: "string",
4931
5039
  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.",
5040
+ description: "Identifier matched exactly by the message list's `reference` filter; returned on reads and webhooks. May be shared by multiple messages. Put non-searchable context in `metadata`.",
4933
5041
  },
4934
5042
  {
4935
5043
  displayName: "Sticker",
@@ -4937,14 +5045,14 @@ exports.birdProperties = [
4937
5045
  type: "collection",
4938
5046
  placeholder: "Add Field",
4939
5047
  default: {},
4940
- description: "A free-form sticker. Deliverable only inside an open customer service window.",
5048
+ description: "Free-form sticker; requires an open customer service window",
4941
5049
  options: [
4942
5050
  {
4943
5051
  displayName: "URL",
4944
5052
  name: "url",
4945
5053
  type: "string",
4946
5054
  default: "",
4947
- description: "Public `https` URL of the sticker. WhatsApp fetches it at send time, so it must still be reachable then. WebP only, up to 100 KB static or 500 KB animated.",
5055
+ description: "Public HTTPS URL fetched at send time. WebP, up to 100 KB static or 500 KB animated.",
4948
5056
  },
4949
5057
  ],
4950
5058
  },
@@ -4955,7 +5063,7 @@ exports.birdProperties = [
4955
5063
  typeOptions: { multipleValues: true },
4956
5064
  placeholder: "Add Tag",
4957
5065
  default: {},
4958
- description: "Structured `{name, value}` labels for filtering. Tags become first-class query dimensions: filter the list endpoint by tag name. Maximum 20 tags per send. Use tags for low-cardinality dimensions (`category`, `experiment_variant`). For arbitrary structured context you do not need as a filter dimension, use `metadata` instead.",
5066
+ description: "Up to 20 `{name, value}` labels, filterable by name. Use for low-cardinality dimensions such as category; put other context in `metadata`.",
4959
5067
  options: [
4960
5068
  {
4961
5069
  displayName: "Tag",
@@ -4985,21 +5093,21 @@ exports.birdProperties = [
4985
5093
  type: "collection",
4986
5094
  placeholder: "Add Field",
4987
5095
  default: {},
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.",
5096
+ description: "Required outside the customer service window. Groups accept workspace-authored, non-authentication templates only.",
4989
5097
  options: [
4990
5098
  {
4991
5099
  displayName: "Bid Multiplier",
4992
5100
  name: "bid_multiplier",
4993
5101
  type: "number",
4994
5102
  default: "",
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.",
5103
+ description: "Multiplies `optimization_spec.bid_amount` × country multiplier for this message. Range 0.01–100; default 1. Requires `optimization_spec` on a marketing template language.",
4996
5104
  },
4997
5105
  {
4998
5106
  displayName: "Components",
4999
5107
  name: "components",
5000
5108
  type: "json",
5001
5109
  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.",
5110
+ description: "Copy each language component's `example_parameters` into that part's `parameters`, replacing examples with real values. Map `buttons` to one `button` part per button with examples, in order; map `carousel` to `cards`, built likewise. A location header requires a `location` parameter. Omit other blocks without examples.",
5003
5111
  },
5004
5112
  {
5005
5113
  displayName: "ID",
@@ -5013,14 +5121,14 @@ exports.birdProperties = [
5013
5121
  name: "language",
5014
5122
  type: "string",
5015
5123
  default: "",
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.",
5124
+ description: "BCP-47 tag (`en-US`; `en_US` also accepted). Defaults to the template's default language unless `language_source_required` is set. Missing variants follow `on_missing_language`. The resolved language determines pricing and is echoed in the accepted message.",
5017
5125
  },
5018
5126
  {
5019
5127
  displayName: "Slug",
5020
5128
  name: "slug",
5021
5129
  type: "string",
5022
5130
  default: "",
5023
- description: "The template to send, by its slug handle (for example `bird_otp`)",
5131
+ description: "Template slug, such as `bird_otp`",
5024
5132
  },
5025
5133
  ],
5026
5134
  },
@@ -5030,21 +5138,21 @@ exports.birdProperties = [
5030
5138
  type: "collection",
5031
5139
  placeholder: "Add Field",
5032
5140
  default: {},
5033
- description: "Free-form text. Deliverable only inside an open customer service window.",
5141
+ description: "Free-form text; requires an open customer service window",
5034
5142
  options: [
5035
5143
  {
5036
5144
  displayName: "Body",
5037
5145
  name: "body",
5038
5146
  type: "string",
5039
5147
  default: "",
5040
- description: "The message text. The WhatsApp client turns any URL it contains into a clickable link.",
5148
+ description: "Message text; URLs become clickable links",
5041
5149
  },
5042
5150
  {
5043
5151
  displayName: "Preview URL",
5044
5152
  name: "preview_url",
5045
5153
  type: "boolean",
5046
5154
  default: false,
5047
- description: "Whether the WhatsApp client previews the first link in `body`. Not returned when the message is read back.",
5155
+ description: "Whether to preview the first link in `body`. Omitted on reads.",
5048
5156
  },
5049
5157
  ],
5050
5158
  },
@@ -5054,14 +5162,14 @@ exports.birdProperties = [
5054
5162
  type: "collection",
5055
5163
  placeholder: "Add Field",
5056
5164
  default: {},
5057
- description: "A free-form video. Deliverable only inside an open customer service window.",
5165
+ description: "Free-form video; requires an open customer service window",
5058
5166
  options: [
5059
5167
  {
5060
5168
  displayName: "URL",
5061
5169
  name: "url",
5062
5170
  type: "string",
5063
5171
  default: "",
5064
- description: "Public `https` URL of the video. WhatsApp fetches it at send time, so it must still be reachable then. MP4 with H.264 video and AAC audio, up to 16 MB.",
5172
+ description: "Public HTTPS URL fetched at send time. MP4 with H.264 video and AAC audio, up to 16 MB.",
5065
5173
  },
5066
5174
  {
5067
5175
  displayName: "Caption",
@@ -31,9 +31,9 @@ exports.birdRoutes = {
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"] },
34
- "sms:stats_summary": { method: "GET", path: "/v1/sms/stats/summary", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["from", "to", "timezone", "originator", "country", "category", "carrier", "compare"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["sms"] },
35
- "sms:stats_daily": { method: "GET", path: "/v1/sms/stats/daily", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["from", "to", "timezone", "originator", "country", "category", "carrier"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["sms"] },
36
- "sms:stats_hourly": { method: "GET", path: "/v1/sms/stats/hourly", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["from", "to", "timezone", "originator", "country", "category", "carrier"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: ["from", "to"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["sms"] },
34
+ "sms:stats_summary": { method: "GET", path: "/v1/sms/stats/summary", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["from", "to", "timezone", "originator", "country", "category", "carrier", "cost_center", "compare"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["sms"] },
35
+ "sms:stats_daily": { method: "GET", path: "/v1/sms/stats/daily", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["from", "to", "timezone", "originator", "country", "category", "carrier", "cost_center"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["sms"] },
36
+ "sms:stats_hourly": { method: "GET", path: "/v1/sms/stats/hourly", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["from", "to", "timezone", "originator", "country", "category", "carrier", "cost_center"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: ["from", "to"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["sms"] },
37
37
  "sms:stats_by_country": { method: "GET", path: "/v1/sms/stats/countries", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["from", "to", "timezone", "sort", "limit", "include_trend", "trend_grain"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["sms"] },
38
38
  "sms:stats_by_carrier": { method: "GET", path: "/v1/sms/stats/carriers", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["from", "to", "timezone", "sort", "limit", "include_trend", "trend_grain"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["sms"] },
39
39
  "sms:stats_by_category": { method: "GET", path: "/v1/sms/stats/categories", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["from", "to", "timezone", "sort", "limit", "include_trend", "trend_grain"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["sms"] },
@@ -41,6 +41,7 @@ exports.birdRoutes = {
41
41
  "sms:stats_by_status": { method: "GET", path: "/v1/sms/stats/statuses", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["from", "to", "timezone"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["sms"] },
42
42
  "sms:stats_by_error_code": { method: "GET", path: "/v1/sms/stats/error-codes", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["from", "to", "timezone", "sort", "limit", "include_trend", "trend_grain"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["sms"] },
43
43
  "sms:stats_by_tag": { method: "GET", path: "/v1/sms/stats/tags", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["from", "to", "timezone", "sort", "limit", "include_trend", "trend_grain"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["sms"] },
44
+ "sms:stats_by_cost_center": { method: "GET", path: "/v1/sms/stats/cost-centers", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["from", "to", "timezone", "sort", "limit", "include_trend", "trend_grain"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["sms"] },
44
45
  "sms:stats_inbound_summary": { method: "GET", path: "/v1/sms/stats/inbound/summary", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["from", "to", "timezone", "compare"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["sms"] },
45
46
  "sms:stats_inbound_daily": { method: "GET", path: "/v1/sms/stats/inbound/daily", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["from", "to", "timezone"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["sms"] },
46
47
  "sms:stats_inbound_hourly": { method: "GET", path: "/v1/sms/stats/inbound/hourly", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["from", "to", "timezone"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: ["from", "to"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["sms"] },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@messagebird/n8n-nodes-bird",
3
- "version": "0.33.0",
3
+ "version": "0.34.1",
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": {