@messagebird/n8n-nodes-bird 0.16.1 → 0.17.0

package/README.md

@@ -21,7 +21,7 @@ On a self-hosted instance that has not enabled community nodes in the panel, use
 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).
 
 <details>
-<summary><strong>179 operations across 22 resources</strong></summary>
+<summary><strong>180 operations across 22 resources</strong></summary>
 
 - **Audience** (9) — Add Contacts, Create, Delete, Get, List, List Contacts, Remove Contact, Remove Contacts, Update
 - **Contact** (7) — Batch, Create, Delete, Get, List, List Preferences, Update
@@ -32,7 +32,7 @@ The **Bird** node covers the public Bird API: email and SMS sends, delivery stat
 - **Inbound Address** (5) — Create, Delete, Get, List, Update
 - **Inbound Message** (4) — Attachments, Body, Get, List
 - **Lookup** (3) — Email, Email Batch, Phone Number
-- **Number** (8) — Create Order, Get, Get Available Number, Get Order, List, List Available Numbers, List Orders, Release
+- **Number** (9) — Create Order, Get, Get Available Number, Get Order, List, List Available Numbers, List Orders, Release, Update
 - **Preference** (4) — Create, Delete, Get, List
 - **Realtime** (9) — Create App, Create App Key, Delete App, Get App, List App Keys, List Apps, List Regions, Revoke App Key, Update App
 - **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

package/dist/nodes/Bird/generated/properties.gen.js

@@ -240,6 +240,7 @@ exports.birdProperties = [
             { name: "List Available Numbers", value: "available_list", action: "List available phone numbers", description: "List available phone numbers" },
             { name: "List Orders", value: "orders_list", action: "List your number orders", description: "List your number orders" },
             { name: "Release", value: "release", action: "Release a dedicated number", description: "Release a dedicated number" },
+            { name: "Update", value: "update", action: "Update an allocated number", description: "Update an allocated number" },
         ],
         default: "list",
     },
@@ -738,7 +739,7 @@ exports.birdProperties = [
                         typeOptions: { multipleValues: true },
                         placeholder: "Add Pair",
                         default: {},
-                        description: "Values for the template's variables, keyed by the variable name. A variable name is a single word. Every variable in the template's `variables` list needs a value. A send that omits one is rejected. Languages can use different variables, and a value unused by the selected language is ignored. The API supplies values under the reserved `bird` key, so a send that sets it is rejected. `parameters` is capped at 16 KB once serialized.",
+                        description: "Values for caller parameters, keyed by name. A parameter name is a single word. Caller parameters have `system` set to false or absent in the template's `variables` list. Supply each required caller parameter used by the resolved send language; omitting one returns `422`. A version's list covers all its languages, and values unused by the resolved language are ignored. The `bird` namespace is reserved for values filled by Bird, so a send that sets it is rejected. `parameters` is capped at 16 KB once serialized.",
                         options: [
                             {
                                 displayName: "Pair",
@@ -5574,6 +5575,20 @@ exports.birdProperties = [
                 default: "",
                 description: "Return only numbers that start with these digits. With `country_code`, the digits are national ones, matched right after the country dial code: with `country_code=US`, `prefix=212` returns the +1 212 area-code numbers allocated to you. Leave out the dial code and any national dialing prefix such as a leading 0; short codes never match a country-anchored prefix search. Without `country_code`, the digits are matched from the start of each stored number, ignoring a leading `+`, so short codes are reachable and a full number in digits finds itself. Digits only: up to 10 of them with `country_code`, 15 without.",
             },
+            {
+                displayName: "Reference",
+                name: "reference",
+                type: "string",
+                default: "",
+                description: "Return numbers with this exact reference. Matching is case-sensitive.",
+            },
+            {
+                displayName: "Search",
+                name: "search",
+                type: "string",
+                default: "",
+                description: "Matches part of the number, name, or reference, ignoring case. Characters such as percent and underscore match literally.",
+            },
         ],
     },
     {
@@ -5599,6 +5614,53 @@ exports.birdProperties = [
         ],
         description: "Identifier of the number, as returned in the ID field of GET /v1/numbers",
     },
+    {
+        displayName: "Number",
+        name: "number_id",
+        type: "resourceLocator",
+        required: true,
+        default: { mode: "list", value: "" },
+        displayOptions: { show: { resource: ["numbers"], operation: ["update"] } },
+        modes: [
+            {
+                displayName: "From List",
+                name: "list",
+                type: "list",
+                placeholder: "Select a Number...",
+                typeOptions: { searchListMethod: "numbersList", searchable: true },
+            },
+            {
+                displayName: "By ID",
+                name: "id",
+                type: "string",
+            },
+        ],
+        description: "Identifier returned by the allocated-number list",
+    },
+    {
+        displayName: "Update Fields",
+        name: "updateFields",
+        type: "collection",
+        placeholder: "Add Field",
+        default: {},
+        displayOptions: { show: { resource: ["numbers"], operation: ["update"] } },
+        options: [
+            {
+                displayName: "Name",
+                name: "name",
+                type: "string",
+                default: "",
+                description: "A name for this number in your workspace, such as Support line. Send null to clear it, or omit it to keep the current name.",
+            },
+            {
+                displayName: "Reference",
+                name: "reference",
+                type: "string",
+                default: "",
+                description: "Your own reference for this number, such as an identifier from your records. References need not be unique. Send null to clear it, or omit it to keep the current reference.",
+            },
+        ],
+    },
     {
         displayName: "Number",
         name: "number_id",
@@ -5717,6 +5779,23 @@ exports.birdProperties = [
         default: "",
         description: "The number to acquire, in E.164 format, as returned by `GET /v1/numbers/available`",
     },
+    {
+        displayName: "Additional Fields",
+        name: "additionalFields",
+        type: "collection",
+        placeholder: "Add Field",
+        default: {},
+        displayOptions: { show: { resource: ["numbers"], operation: ["orders_create"] } },
+        options: [
+            {
+                displayName: "Reference",
+                name: "reference",
+                type: "string",
+                default: "",
+                description: "Your own reference to set on the number when this purchase completes. Leading and trailing whitespace is removed. A pending order keeps the reference until the number is allocated.",
+            },
+        ],
+    },
     {
         displayName: "Return All",
         name: "returnAll",

package/dist/nodes/Bird/generated/routing.gen.js

@@ -68,12 +68,13 @@ exports.birdRoutes = {
     "lookup:phone_number": { method: "POST", path: "/v1/lookup/phone-number", pathParams: [], topLevel: ["phone_number"], collections: ["additionalFields"], query: [], body: ["phone_number", "type"], jsonFields: [], structured: {}, renames: {}, arrayFields: ["type"], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["lookup"] },
     "lookup:email": { method: "POST", path: "/v1/lookup/email", pathParams: [], topLevel: ["email"], collections: ["additionalFields"], query: [], body: ["email"], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["lookup"] },
     "lookup:email_batch": { method: "POST", path: "/v1/lookup/email/batch", pathParams: [], topLevel: ["emails"], collections: ["additionalFields"], query: [], body: ["emails"], jsonFields: [], structured: {}, renames: {}, arrayFields: ["emails"], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: true, scopes: ["lookup"] },
-    "numbers:list": { method: "GET", path: "/v1/numbers", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["number", "country_code", "number_type", "prefix", "capabilities", "limit", "starting_after", "ending_before"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: ["capabilities"], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["numbers"] },
+    "numbers:list": { method: "GET", path: "/v1/numbers", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["search", "reference", "number", "country_code", "number_type", "prefix", "capabilities", "limit", "starting_after", "ending_before"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: ["capabilities"], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["numbers"] },
     "numbers:get": { method: "GET", path: "/v1/numbers/{number_id}", pathParams: ["number_id"], topLevel: ["number_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["numbers"] },
+    "numbers:update": { method: "PATCH", path: "/v1/numbers/{number_id}", pathParams: ["number_id"], topLevel: ["number_id"], collections: ["updateFields"], query: [], body: ["name", "reference"], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: ["name", "reference"], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["numbers"] },
     "numbers:release": { method: "DELETE", path: "/v1/numbers/{number_id}", pathParams: ["number_id"], topLevel: ["number_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["numbers"] },
     "numbers:available_list": { method: "GET", path: "/v1/numbers/available", pathParams: [], topLevel: ["country_code"], collections: ["additionalFields"], query: ["country_code", "number_type", "prefix", "capabilities", "limit", "starting_after", "ending_before"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: ["capabilities"], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["numbers"] },
     "numbers:available_get": { method: "GET", path: "/v1/numbers/available/{number}", pathParams: ["number"], topLevel: ["number"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["numbers"] },
-    "numbers:orders_create": { method: "POST", path: "/v1/numbers/orders", pathParams: [], topLevel: ["number"], collections: ["additionalFields"], query: [], body: ["number"], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["numbers"] },
+    "numbers:orders_create": { method: "POST", path: "/v1/numbers/orders", pathParams: [], topLevel: ["number"], collections: ["additionalFields"], query: [], body: ["number", "reference"], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["numbers"] },
     "numbers:orders_list": { method: "GET", path: "/v1/numbers/orders", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["status", "limit", "starting_after", "ending_before"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["numbers"] },
     "numbers:orders_get": { method: "GET", path: "/v1/numbers/orders/{order_id}", pathParams: ["order_id"], topLevel: ["order_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["numbers"] },
     "domains:list": { method: "GET", path: "/v1/email/domains", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["name", "sort", "order", "limit", "starting_after", "ending_before", "include_total"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["domains"] },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@messagebird/n8n-nodes-bird",
-  "version": "0.16.1",
+  "version": "0.17.0",
   "description": "The official Bird node for n8n: email, SMS, WhatsApp, and verification, plus a webhook trigger for Bird events.",
   "license": "MIT",
   "author": {