@messagebird/n8n-nodes-bird 0.28.0 → 0.30.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.
@@ -5291,6 +5291,7 @@ exports.birdProperties = [
5291
5291
  type: "string",
5292
5292
  },
5293
5293
  ],
5294
+ description: "ID of the call leg to retrieve, as returned by the leg list or webhook events",
5294
5295
  },
5295
5296
  {
5296
5297
  displayName: "To",
@@ -5825,6 +5826,30 @@ exports.birdProperties = [
5825
5826
  default: "",
5826
5827
  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.",
5827
5828
  },
5829
+ {
5830
+ displayName: "Compliance",
5831
+ name: "compliance",
5832
+ type: "collection",
5833
+ placeholder: "Add Field",
5834
+ default: {},
5835
+ description: "Ownership paperwork for a number being ordered, where its country requires any. Optional always: the order completes and the number is yours either way, and supplying this only decides whether it can carry traffic sooner. Read `GET /v1/compliance/requirements` for the number to learn what is asked for, or file it after the order with `POST /v1/compliance/submissions`. Filing this cannot fail your order: if it is refused, the number is still yours and you can file again. The answers are a legal representation filed under the name of the business they describe. Sending this block uses the order's existing `numbers` scope at write level.",
5836
+ options: [
5837
+ {
5838
+ displayName: "Answers",
5839
+ name: "answers",
5840
+ type: "json",
5841
+ default: "",
5842
+ description: "Every answer at once, in the same shape `POST /v1/compliance/submissions` takes. There is no draft to fill in over several calls, so send a complete set.",
5843
+ },
5844
+ {
5845
+ displayName: "Identity ID",
5846
+ name: "identity_id",
5847
+ type: "string",
5848
+ default: "",
5849
+ description: "An existing party this number is held for. It fills in the business details you left out from what that party already holds, and each single-value answer you file about the party is written back onto it for next time, whatever the verdict. Documents and multi-value answers are asked fresh each time. An ID belonging to another organization is rejected.",
5850
+ },
5851
+ ],
5852
+ },
5828
5853
  ],
5829
5854
  },
5830
5855
  {
@@ -6696,6 +6721,7 @@ exports.birdProperties = [
6696
6721
  { name: "URL", value: "url" },
6697
6722
  ],
6698
6723
  default: "",
6724
+ description: "Field to sort webhook endpoints by: `created_at` (the default; newest first with the default `order`) or the endpoint URL",
6699
6725
  },
6700
6726
  {
6701
6727
  displayName: "Order",
@@ -7278,6 +7304,19 @@ exports.birdProperties = [
7278
7304
  default: {},
7279
7305
  displayOptions: { show: { resource: ["docs"], operation: ["read"] } },
7280
7306
  options: [
7307
+ {
7308
+ displayName: "View",
7309
+ name: "view",
7310
+ type: "options",
7311
+ options: [
7312
+ { name: "Not Set", value: "" },
7313
+ { name: "Full", value: "full" },
7314
+ { name: "Request", value: "request" },
7315
+ { name: "Response", value: "response" },
7316
+ ],
7317
+ default: "",
7318
+ description: "Sections to read from an API reference. Other documentation pages return full content for every view. Defaults to `full`.",
7319
+ },
7281
7320
  {
7282
7321
  displayName: "Locale",
7283
7322
  name: "locale",
@@ -8971,6 +9010,13 @@ exports.birdProperties = [
8971
9010
  default: "",
8972
9011
  description: "BCC recipients. Each entry is a plain email string, an RFC 5322 mailbox string (`Jane <jane@acme.com>`), or an object with an optional display name. Separate multiple values with a comma.",
8973
9012
  },
9013
+ {
9014
+ displayName: "Cancel On Reply",
9015
+ name: "cancel_on_reply",
9016
+ type: "boolean",
9017
+ default: false,
9018
+ description: "Whether to when scheduled_at is set, cancel if an inbound message arrives in the conversation before dispatch is claimed. Defaults to false: the frozen parent, recipients and content are sent unchanged even if new mail arrives.",
9019
+ },
8974
9020
  {
8975
9021
  displayName: "Category",
8976
9022
  name: "category",
@@ -9033,6 +9079,13 @@ exports.birdProperties = [
9033
9079
  default: "",
9034
9080
  description: "Reply-To addresses. When omitted, the mailbox's `default_reply_to` applies (replies then come back to the mailbox itself). Separate multiple values with a comma.",
9035
9081
  },
9082
+ {
9083
+ displayName: "Scheduled At",
9084
+ name: "scheduled_at",
9085
+ type: "dateTime",
9086
+ default: "",
9087
+ description: "Send between 30 seconds and 30 days ahead, sharing the scheduled-email allowance. The scheduled send is listed separately and enters the conversation only at dispatch. Sender, mailbox and send-volume eligibility are rechecked then; refusal fails the schedule record without adding a conversation message. Retention starts at dispatch. Attachments are not supported on scheduled messages; send now or schedule without attachments.",
9088
+ },
9036
9089
  {
9037
9090
  displayName: "Tags",
9038
9091
  name: "tags",
@@ -9747,6 +9800,13 @@ exports.birdProperties = [
9747
9800
  },
9748
9801
  ],
9749
9802
  },
9803
+ {
9804
+ displayName: "Cancel On Reply",
9805
+ name: "cancel_on_reply",
9806
+ type: "boolean",
9807
+ default: false,
9808
+ description: "Whether to when scheduled_at is set, cancel if an inbound message arrives in the conversation before dispatch is claimed. Defaults to false: the frozen parent, recipients and content are sent unchanged even if new mail arrives.",
9809
+ },
9750
9810
  {
9751
9811
  displayName: "Category",
9752
9812
  name: "category",
@@ -9802,6 +9862,13 @@ exports.birdProperties = [
9802
9862
  default: false,
9803
9863
  description: "Whether to also send the reply to the original To and Cc recipients, minus the mailbox's own address",
9804
9864
  },
9865
+ {
9866
+ displayName: "Scheduled At",
9867
+ name: "scheduled_at",
9868
+ type: "dateTime",
9869
+ default: "",
9870
+ description: "Send between 30 seconds and 30 days ahead, sharing the scheduled-email allowance. The scheduled send is listed separately and enters the conversation only at dispatch. Sender, mailbox and send-volume eligibility are rechecked then; refusal fails the schedule record without adding a conversation message. Retention starts at dispatch. Attachments are not supported on scheduled messages; send now or schedule without attachments.",
9871
+ },
9805
9872
  {
9806
9873
  displayName: "Tags",
9807
9874
  name: "tags",
@@ -75,7 +75,7 @@ exports.birdRoutes = {
75
75
  "numbers:cancel": { 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"] },
76
76
  "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"] },
77
77
  "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"] },
78
- "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"] },
78
+ "numbers:orders_create": { method: "POST", path: "/v1/numbers/orders", pathParams: [], topLevel: ["number"], collections: ["additionalFields"], query: [], body: ["number", "reference", "compliance"], jsonFields: ["compliance.answers"], structured: { "compliance": "struct" }, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["numbers"] },
79
79
  "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"] },
80
80
  "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"] },
81
81
  "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"] },
@@ -108,7 +108,7 @@ exports.birdRoutes = {
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"] },
109
109
  "workspace:get": { method: "GET", path: "/v1/workspace", pathParams: [], topLevel: [], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["workspace"] },
110
110
  "docs:search": { method: "GET", path: "/v1/docs/search", pathParams: [], topLevel: ["q"], collections: ["additionalFields"], query: ["q", "locale", "limit", "contents"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: [] },
111
- "docs:read": { method: "GET", path: "/v1/docs/pages", pathParams: [], topLevel: ["slug"], collections: ["additionalFields"], query: ["slug", "locale"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: [] },
111
+ "docs:read": { method: "GET", path: "/v1/docs/pages", pathParams: [], topLevel: ["slug"], collections: ["additionalFields"], query: ["slug", "view", "locale"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: [] },
112
112
  "preferences:list": { method: "GET", path: "/v1/preferences", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["channel", "handle", "limit", "starting_after", "ending_before"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["preferences"] },
113
113
  "preferences:get": { method: "GET", path: "/v1/preferences/{preference_id}", pathParams: ["preference_id"], topLevel: ["preference_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["preferences"] },
114
114
  "preferences:create": { method: "POST", path: "/v1/preferences", pathParams: [], topLevel: ["handle", "channel", "status"], collections: ["additionalFields"], query: [], body: ["handle", "channel", "status", "coverage", "sender_scope", "source", "consented_at"], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: ["consented_at"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["preferences"] },
@@ -143,7 +143,7 @@ exports.birdRoutes = {
143
143
  "email:mailboxes_restore": { method: "POST", path: "/v1/email/mailboxes/{mailbox_id}/restore", pathParams: ["mailbox_id"], topLevel: ["mailbox_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["mailbox_management"] },
144
144
  "email:mailboxes_resume": { method: "POST", path: "/v1/email/mailboxes/{mailbox_id}/resume", pathParams: ["mailbox_id"], topLevel: ["mailbox_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["mailbox_management"] },
145
145
  "email:mailboxes_stats": { method: "GET", path: "/v1/email/mailboxes/{mailbox_id}/stats", pathParams: ["mailbox_id"], topLevel: ["mailbox_id"], collections: ["additionalFields"], query: ["from", "to", "timezone", "granularity"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["mailbox"] },
146
- "email:mailboxes_messages_create": { method: "POST", path: "/v1/email/mailboxes/{mailbox_id}/messages", pathParams: ["mailbox_id"], topLevel: ["mailbox_id", "to", "subject"], collections: ["additionalFields"], query: [], body: ["to", "cc", "bcc", "subject", "html", "text", "reply_to", "attachments", "tags", "metadata", "category"], jsonFields: [], structured: { "attachments": "list", "tags": "list", "metadata": "map" }, renames: {}, arrayFields: ["to", "cc", "bcc", "reply_to"], dateTimeFields: [], nullableFields: [], binaryFields: ["attachments"], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["mailbox"] },
146
+ "email:mailboxes_messages_create": { method: "POST", path: "/v1/email/mailboxes/{mailbox_id}/messages", pathParams: ["mailbox_id"], topLevel: ["mailbox_id", "to", "subject"], collections: ["additionalFields"], query: [], body: ["scheduled_at", "to", "cc", "bcc", "subject", "html", "text", "reply_to", "attachments", "tags", "metadata", "category", "cancel_on_reply"], jsonFields: [], structured: { "attachments": "list", "tags": "list", "metadata": "map" }, renames: {}, arrayFields: ["to", "cc", "bcc", "reply_to"], dateTimeFields: ["scheduled_at"], nullableFields: [], binaryFields: ["attachments"], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["mailbox"] },
147
147
  "email:mailboxes_labels": { method: "GET", path: "/v1/email/mailboxes/{mailbox_id}/labels", pathParams: ["mailbox_id"], topLevel: ["mailbox_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["mailbox"] },
148
148
  "email:mailboxes_receive_rules_list": { method: "GET", path: "/v1/email/mailboxes/{mailbox_id}/receive-rules", pathParams: ["mailbox_id"], topLevel: ["mailbox_id"], collections: ["additionalFields"], query: ["action", "limit", "starting_after", "ending_before"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["mailbox_management"] },
149
149
  "email:mailboxes_receive_rules_create": { method: "POST", path: "/v1/email/mailboxes/{mailbox_id}/receive-rules", pathParams: ["mailbox_id"], topLevel: ["mailbox_id", "action", "entry"], collections: ["additionalFields"], query: [], body: ["action", "entry", "note"], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["mailbox_management"] },
@@ -155,7 +155,7 @@ exports.birdRoutes = {
155
155
  "email:threads_messages_list": { method: "GET", path: "/v1/email/threads/{thread_id}/messages", pathParams: ["thread_id"], topLevel: ["thread_id"], collections: ["additionalFields"], query: ["direction", "label", "include", "limit", "starting_after", "ending_before"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["mailbox"] },
156
156
  "email:threads_messages_get": { method: "GET", path: "/v1/email/threads/{thread_id}/messages/{message_id}", pathParams: ["thread_id", "message_id"], topLevel: ["thread_id", "message_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["mailbox"] },
157
157
  "email:threads_messages_body": { method: "GET", path: "/v1/email/threads/{thread_id}/messages/{message_id}/body", pathParams: ["thread_id", "message_id"], topLevel: ["thread_id", "message_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["mailbox"] },
158
- "email:threads_messages_reply": { method: "POST", path: "/v1/email/threads/{thread_id}/messages/{message_id}/reply", pathParams: ["thread_id", "message_id"], topLevel: ["thread_id", "message_id"], collections: ["additionalFields"], query: [], body: ["html", "text", "reply_all", "tags", "metadata", "category", "attachments"], jsonFields: [], structured: { "tags": "list", "metadata": "map", "attachments": "list" }, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: ["attachments"], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["mailbox"] },
158
+ "email:threads_messages_reply": { method: "POST", path: "/v1/email/threads/{thread_id}/messages/{message_id}/reply", pathParams: ["thread_id", "message_id"], topLevel: ["thread_id", "message_id"], collections: ["additionalFields"], query: [], body: ["scheduled_at", "html", "text", "reply_all", "tags", "metadata", "category", "attachments", "cancel_on_reply"], jsonFields: [], structured: { "tags": "list", "metadata": "map", "attachments": "list" }, renames: {}, arrayFields: [], dateTimeFields: ["scheduled_at"], nullableFields: [], binaryFields: ["attachments"], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["mailbox"] },
159
159
  "email:threads_messages_attachments": { method: "GET", path: "/v1/email/threads/{thread_id}/messages/{message_id}/attachments", pathParams: ["thread_id", "message_id"], topLevel: ["thread_id", "message_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["mailbox"] },
160
160
  "email:content": { method: "GET", path: "/v1/email/messages/{message_id}/content", 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"] },
161
161
  "email:recipients": { method: "GET", path: "/v1/email/messages/{message_id}/recipients", pathParams: ["message_id"], topLevel: ["message_id"], 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"] },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@messagebird/n8n-nodes-bird",
3
- "version": "0.28.0",
3
+ "version": "0.30.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": {