@messagebird/n8n-nodes-bird 0.16.2 → 0.18.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>
|
|
24
|
+
<summary><strong>180 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
|
|
@@ -32,7 +32,7 @@ The **Bird** node covers the public Bird API: email and SMS sends, delivery stat
|
|
|
32
32
|
- **Inbound Address** (5) — Create, Delete, Get, List, Update
|
|
33
33
|
- **Inbound Message** (4) — Attachments, Body, Get, List
|
|
34
34
|
- **Lookup** (3) — Email, Email Batch, Phone Number
|
|
35
|
-
- **Number** (
|
|
35
|
+
- **Number** (9) — 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
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
|
|
@@ -240,6 +240,7 @@ exports.birdProperties = [
|
|
|
240
240
|
{ name: "List Available Numbers", value: "available_list", action: "List available phone numbers", description: "List available phone numbers" },
|
|
241
241
|
{ name: "List Orders", value: "orders_list", action: "List your number orders", description: "List your number orders" },
|
|
242
242
|
{ name: "Release", value: "release", action: "Release a dedicated number", description: "Release a dedicated number" },
|
|
243
|
+
{ name: "Update", value: "update", action: "Update an allocated number", description: "Update an allocated number" },
|
|
243
244
|
],
|
|
244
245
|
default: "list",
|
|
245
246
|
},
|
|
@@ -3055,7 +3056,7 @@ exports.birdProperties = [
|
|
|
3055
3056
|
name: "error_code",
|
|
3056
3057
|
type: "string",
|
|
3057
3058
|
default: "",
|
|
3058
|
-
description: "Keep only messages whose failure reason (`last_error.code`) matches; separate values with a comma to match any of several. One of `invalid_destination`, `unreachable`, `blocked_by_carrier`, `blocked_by_recipient`, `landline_unreachable`, `content_rejected`, `sender_unregistered`, `recipient_opted_out`, `provider_unavailable`, `insufficient_balance`, or `unknown`.",
|
|
3059
|
+
description: "Keep only messages whose failure reason (`last_error.code`) matches; separate values with a comma to match any of several. One of `invalid_destination`, `unreachable`, `blocked_by_carrier`, `blocked_by_fraud_protection`, `blocked_by_recipient`, `landline_unreachable`, `content_rejected`, `sender_unregistered`, `recipient_opted_out`, `provider_unavailable`, `insufficient_balance`, or `unknown`.",
|
|
3059
3060
|
},
|
|
3060
3061
|
{
|
|
3061
3062
|
displayName: "From",
|
|
@@ -5574,6 +5575,20 @@ exports.birdProperties = [
|
|
|
5574
5575
|
default: "",
|
|
5575
5576
|
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.",
|
|
5576
5577
|
},
|
|
5578
|
+
{
|
|
5579
|
+
displayName: "Reference",
|
|
5580
|
+
name: "reference",
|
|
5581
|
+
type: "string",
|
|
5582
|
+
default: "",
|
|
5583
|
+
description: "Return numbers with this exact reference. Matching is case-sensitive.",
|
|
5584
|
+
},
|
|
5585
|
+
{
|
|
5586
|
+
displayName: "Search",
|
|
5587
|
+
name: "search",
|
|
5588
|
+
type: "string",
|
|
5589
|
+
default: "",
|
|
5590
|
+
description: "Matches part of the number, name, or reference, ignoring case. Number matching also ignores phone formatting such as spaces, parentheses, and hyphens. Name and reference matching preserves punctuation. Characters such as percent and underscore match literally.",
|
|
5591
|
+
},
|
|
5577
5592
|
],
|
|
5578
5593
|
},
|
|
5579
5594
|
{
|
|
@@ -5599,6 +5614,53 @@ exports.birdProperties = [
|
|
|
5599
5614
|
],
|
|
5600
5615
|
description: "Identifier of the number, as returned in the ID field of GET /v1/numbers",
|
|
5601
5616
|
},
|
|
5617
|
+
{
|
|
5618
|
+
displayName: "Number",
|
|
5619
|
+
name: "number_id",
|
|
5620
|
+
type: "resourceLocator",
|
|
5621
|
+
required: true,
|
|
5622
|
+
default: { mode: "list", value: "" },
|
|
5623
|
+
displayOptions: { show: { resource: ["numbers"], operation: ["update"] } },
|
|
5624
|
+
modes: [
|
|
5625
|
+
{
|
|
5626
|
+
displayName: "From List",
|
|
5627
|
+
name: "list",
|
|
5628
|
+
type: "list",
|
|
5629
|
+
placeholder: "Select a Number...",
|
|
5630
|
+
typeOptions: { searchListMethod: "numbersList", searchable: true },
|
|
5631
|
+
},
|
|
5632
|
+
{
|
|
5633
|
+
displayName: "By ID",
|
|
5634
|
+
name: "id",
|
|
5635
|
+
type: "string",
|
|
5636
|
+
},
|
|
5637
|
+
],
|
|
5638
|
+
description: "Identifier returned by the allocated-number list",
|
|
5639
|
+
},
|
|
5640
|
+
{
|
|
5641
|
+
displayName: "Update Fields",
|
|
5642
|
+
name: "updateFields",
|
|
5643
|
+
type: "collection",
|
|
5644
|
+
placeholder: "Add Field",
|
|
5645
|
+
default: {},
|
|
5646
|
+
displayOptions: { show: { resource: ["numbers"], operation: ["update"] } },
|
|
5647
|
+
options: [
|
|
5648
|
+
{
|
|
5649
|
+
displayName: "Name",
|
|
5650
|
+
name: "name",
|
|
5651
|
+
type: "string",
|
|
5652
|
+
default: "",
|
|
5653
|
+
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.",
|
|
5654
|
+
},
|
|
5655
|
+
{
|
|
5656
|
+
displayName: "Reference",
|
|
5657
|
+
name: "reference",
|
|
5658
|
+
type: "string",
|
|
5659
|
+
default: "",
|
|
5660
|
+
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.",
|
|
5661
|
+
},
|
|
5662
|
+
],
|
|
5663
|
+
},
|
|
5602
5664
|
{
|
|
5603
5665
|
displayName: "Number",
|
|
5604
5666
|
name: "number_id",
|
|
@@ -5717,6 +5779,23 @@ exports.birdProperties = [
|
|
|
5717
5779
|
default: "",
|
|
5718
5780
|
description: "The number to acquire, in E.164 format, as returned by `GET /v1/numbers/available`",
|
|
5719
5781
|
},
|
|
5782
|
+
{
|
|
5783
|
+
displayName: "Additional Fields",
|
|
5784
|
+
name: "additionalFields",
|
|
5785
|
+
type: "collection",
|
|
5786
|
+
placeholder: "Add Field",
|
|
5787
|
+
default: {},
|
|
5788
|
+
displayOptions: { show: { resource: ["numbers"], operation: ["orders_create"] } },
|
|
5789
|
+
options: [
|
|
5790
|
+
{
|
|
5791
|
+
displayName: "Reference",
|
|
5792
|
+
name: "reference",
|
|
5793
|
+
type: "string",
|
|
5794
|
+
default: "",
|
|
5795
|
+
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.",
|
|
5796
|
+
},
|
|
5797
|
+
],
|
|
5798
|
+
},
|
|
5720
5799
|
{
|
|
5721
5800
|
displayName: "Return All",
|
|
5722
5801
|
name: "returnAll",
|
|
@@ -6552,6 +6631,13 @@ exports.birdProperties = [
|
|
|
6552
6631
|
default: false,
|
|
6553
6632
|
description: "Whether the response includes a `total` field with the total number of items matching the request's filters across all pages",
|
|
6554
6633
|
},
|
|
6634
|
+
{
|
|
6635
|
+
displayName: "URL",
|
|
6636
|
+
name: "url",
|
|
6637
|
+
type: "string",
|
|
6638
|
+
default: "",
|
|
6639
|
+
description: "Only endpoints delivering to exactly this URL. Several endpoints can share a URL, so this finds matches for a setup to reuse; it does not prevent a duplicate.",
|
|
6640
|
+
},
|
|
6555
6641
|
],
|
|
6556
6642
|
},
|
|
6557
6643
|
{
|
|
@@ -6610,15 +6696,6 @@ exports.birdProperties = [
|
|
|
6610
6696
|
],
|
|
6611
6697
|
description: "ID of the webhook endpoint (`whk_` prefix), as returned when it was created",
|
|
6612
6698
|
},
|
|
6613
|
-
{
|
|
6614
|
-
displayName: "URL",
|
|
6615
|
-
name: "url",
|
|
6616
|
-
type: "string",
|
|
6617
|
-
required: true,
|
|
6618
|
-
displayOptions: { show: { resource: ["webhooks"], operation: ["create"] } },
|
|
6619
|
-
default: "",
|
|
6620
|
-
description: "HTTPS URL to deliver events to, at most 2048 characters. The host must be publicly reachable: URLs on private, loopback, or link-local addresses are rejected with a `422`.",
|
|
6621
|
-
},
|
|
6622
6699
|
{
|
|
6623
6700
|
displayName: "Events",
|
|
6624
6701
|
name: "events",
|
|
@@ -6703,6 +6780,13 @@ exports.birdProperties = [
|
|
|
6703
6780
|
default: {},
|
|
6704
6781
|
displayOptions: { show: { resource: ["webhooks"], operation: ["create"] } },
|
|
6705
6782
|
options: [
|
|
6783
|
+
{
|
|
6784
|
+
displayName: "URL",
|
|
6785
|
+
name: "url",
|
|
6786
|
+
type: "string",
|
|
6787
|
+
default: "",
|
|
6788
|
+
description: "HTTPS URL to deliver events to, at most 2048 characters. The host must be publicly reachable: URLs on private, loopback, or link-local addresses are rejected with a `422`. Required unless `destination` is a connector, whose URL comes from the connector and its `config`; a URL given with one must equal it.",
|
|
6789
|
+
},
|
|
6706
6790
|
{
|
|
6707
6791
|
displayName: "Description",
|
|
6708
6792
|
name: "description",
|
|
@@ -6931,11 +7015,33 @@ exports.birdProperties = [
|
|
|
6931
7015
|
displayOptions: { show: { resource: ["webhooks"], operation: ["update"] } },
|
|
6932
7016
|
options: [
|
|
6933
7017
|
{
|
|
6934
|
-
displayName: "
|
|
6935
|
-
name: "
|
|
6936
|
-
type: "
|
|
6937
|
-
|
|
6938
|
-
|
|
7018
|
+
displayName: "Credentials",
|
|
7019
|
+
name: "credentials",
|
|
7020
|
+
type: "fixedCollection",
|
|
7021
|
+
typeOptions: { multipleValues: true },
|
|
7022
|
+
placeholder: "Add Pair",
|
|
7023
|
+
default: {},
|
|
7024
|
+
description: "New values for a `connector` destination's secret fields, merged over the stored ones: a key given replaces that field and an omitted key keeps its value. The merged set is checked as at creation, and the next delivery, retries included, uses it. On an endpoint without a `connector` destination this returns a `422`. Omit to keep the current credentials.",
|
|
7025
|
+
options: [
|
|
7026
|
+
{
|
|
7027
|
+
displayName: "Pair",
|
|
7028
|
+
name: "pairs",
|
|
7029
|
+
values: [
|
|
7030
|
+
{
|
|
7031
|
+
displayName: "Key",
|
|
7032
|
+
name: "key",
|
|
7033
|
+
type: "string",
|
|
7034
|
+
default: "",
|
|
7035
|
+
},
|
|
7036
|
+
{
|
|
7037
|
+
displayName: "Value",
|
|
7038
|
+
name: "value",
|
|
7039
|
+
type: "string",
|
|
7040
|
+
default: "",
|
|
7041
|
+
},
|
|
7042
|
+
],
|
|
7043
|
+
},
|
|
7044
|
+
],
|
|
6939
7045
|
},
|
|
6940
7046
|
{
|
|
6941
7047
|
displayName: "Description",
|
|
@@ -7030,6 +7136,13 @@ exports.birdProperties = [
|
|
|
7030
7136
|
default: "",
|
|
7031
7137
|
description: "`paused` stops all deliveries; `active` re-enables a paused endpoint. Omit to leave the status unchanged. Events that fire while paused are not delivered and a replay cannot recover them, because they were never attempted; after re-enabling, [Replay failed deliveries](/docs/api/reference/create-webhook-replay) reaches only the deliveries that failed before the pause. A `degraded` endpoint cannot be reset through this field: it returns to `active` automatically once deliveries succeed again.",
|
|
7032
7138
|
},
|
|
7139
|
+
{
|
|
7140
|
+
displayName: "URL",
|
|
7141
|
+
name: "url",
|
|
7142
|
+
type: "string",
|
|
7143
|
+
default: "",
|
|
7144
|
+
description: "Replacement delivery URL. Same rules as at creation: HTTPS, at most 2048 characters, and the host must be publicly reachable (private, loopback, and link-local addresses return a `422`). Omit to keep the current URL. A connector endpoint's URL comes from its connector and cannot be replaced: any value returns a `422`.",
|
|
7145
|
+
},
|
|
7033
7146
|
],
|
|
7034
7147
|
},
|
|
7035
7148
|
{
|
|
@@ -68,12 +68,13 @@ exports.birdRoutes = {
|
|
|
68
68
|
"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"] },
|
|
69
69
|
"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"] },
|
|
70
70
|
"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"] },
|
|
71
|
-
"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"] },
|
|
71
|
+
"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"] },
|
|
72
72
|
"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"] },
|
|
73
|
+
"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"] },
|
|
73
74
|
"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"] },
|
|
74
75
|
"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"] },
|
|
75
76
|
"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"] },
|
|
76
|
-
"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"] },
|
|
77
|
+
"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"] },
|
|
77
78
|
"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"] },
|
|
78
79
|
"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"] },
|
|
79
80
|
"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"] },
|
|
@@ -95,15 +96,15 @@ exports.birdRoutes = {
|
|
|
95
96
|
"suppression:get": { method: "GET", path: "/v1/email/suppressions/{suppression_id}", pathParams: ["suppression_id"], topLevel: ["suppression_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["email_management"] },
|
|
96
97
|
"suppression:add": { method: "POST", path: "/v1/email/suppressions", pathParams: [], topLevel: ["email"], collections: ["additionalFields"], query: [], body: ["email"], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["email_management"] },
|
|
97
98
|
"suppression:remove": { method: "DELETE", path: "/v1/email/suppressions/{suppression_id}", pathParams: ["suppression_id"], topLevel: ["suppression_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["email_management"] },
|
|
98
|
-
"webhooks:list": { method: "GET", path: "/v1/webhooks", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["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: ["webhooks"] },
|
|
99
|
+
"webhooks:list": { method: "GET", path: "/v1/webhooks", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["sort", "order", "limit", "starting_after", "ending_before", "include_total", "url"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["webhooks"] },
|
|
99
100
|
"webhooks:get": { method: "GET", path: "/v1/webhooks/{webhook_id}", pathParams: ["webhook_id"], topLevel: ["webhook_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["webhooks"] },
|
|
100
|
-
"webhooks:create": { method: "POST", path: "/v1/webhooks", pathParams: [], topLevel: ["
|
|
101
|
+
"webhooks:create": { method: "POST", path: "/v1/webhooks", pathParams: [], topLevel: ["events"], collections: ["additionalFields"], query: [], body: ["url", "events", "description"], jsonFields: [], structured: {}, renames: {}, arrayFields: ["events"], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["webhooks"] },
|
|
101
102
|
"webhooks:test": { method: "POST", path: "/v1/webhooks/{webhook_id}/test", pathParams: ["webhook_id"], topLevel: ["webhook_id"], collections: ["additionalFields"], query: [], body: ["event_type"], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["webhooks"] },
|
|
102
103
|
"webhooks:delete": { method: "DELETE", path: "/v1/webhooks/{webhook_id}", pathParams: ["webhook_id"], topLevel: ["webhook_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["webhooks"] },
|
|
103
104
|
"webhooks:attempts": { method: "GET", path: "/v1/webhooks/{webhook_id}/attempts", pathParams: ["webhook_id"], topLevel: ["webhook_id"], collections: ["additionalFields"], query: ["limit", "before", "after"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: ["before", "after"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["webhooks"] },
|
|
104
105
|
"webhooks:replay": { method: "POST", path: "/v1/webhooks/{webhook_id}/replay", pathParams: ["webhook_id"], topLevel: ["webhook_id"], collections: ["additionalFields"], query: [], body: ["since", "until"], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: ["since", "until"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["webhooks"] },
|
|
105
106
|
"webhooks:rotate_secret": { method: "POST", path: "/v1/webhooks/{webhook_id}/rotate-secret", pathParams: ["webhook_id"], topLevel: ["webhook_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["webhooks"] },
|
|
106
|
-
"webhooks:update": { method: "PATCH", path: "/v1/webhooks/{webhook_id}", pathParams: ["webhook_id"], topLevel: ["webhook_id"], collections: ["updateFields"], query: [], body: ["url", "description", "events", "status"], jsonFields: [], structured: {}, renames: {}, arrayFields: ["events"], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["webhooks"] },
|
|
107
|
+
"webhooks:update": { method: "PATCH", path: "/v1/webhooks/{webhook_id}", pathParams: ["webhook_id"], topLevel: ["webhook_id"], collections: ["updateFields"], query: [], body: ["url", "description", "events", "credentials", "status"], jsonFields: [], structured: { "credentials": "map" }, renames: {}, arrayFields: ["events"], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["webhooks"] },
|
|
107
108
|
"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"] },
|
|
108
109
|
"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: [] },
|
|
109
110
|
"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: [] },
|
package/package.json
CHANGED