@messagebird/n8n-nodes-bird 0.33.0 → 0.34.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/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",
@@ -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.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": {