@zernio/node 0.2.884 → 0.2.886
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/dist/index.d.mts +24 -0
- package/dist/index.d.ts +24 -0
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/sdk.gen.ts +11 -0
- package/src/generated/types.gen.ts +24 -0
package/dist/index.d.mts
CHANGED
|
@@ -10138,6 +10138,14 @@ type Webhook = {
|
|
|
10138
10138
|
* Resource groups this subscription does not receive (opt-out denylist, same vocabulary and same semantics as the field on API keys). Absent or empty means the subscription receives every event listed in `events`, which is how every subscription created before this field existed behaves. An event whose group is listed here is dropped before delivery even when it is still present in `events`, and the same check runs on every replay path (test fire, redelivery, dead-letter requeue). Editing the denylist applies to every event emitted afterwards; events already queued when the edit landed can still be delivered for up to five minutes after they were enqueued.
|
|
10139
10139
|
*/
|
|
10140
10140
|
disabledResourceGroups?: Array<('publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks')>;
|
|
10141
|
+
/**
|
|
10142
|
+
* Profiles this subscription receives events for (allowlist). Absent or empty means every profile, which is how every subscription created before this field existed behaves. A scoped subscription is only sent events attributable to a listed profile. An aggregate `post.*` event is attributed to the profile of every account the post targets, so a post spanning two scoped endpoints' profiles reaches both. Events with no profile behind them (`verification.*`, `phone_number.*`, a legacy post whose accounts were deleted) are not delivered to it. Applied when the event is emitted: a redelivery replays a delivery already made to this endpoint, and a test fire ignores the list.
|
|
10143
|
+
*/
|
|
10144
|
+
profileIds?: Array<(string)>;
|
|
10145
|
+
/**
|
|
10146
|
+
* Connected accounts this subscription receives events for (allowlist). Absent or empty means every account. Same semantics as `profileIds`, keyed on the account: an aggregate `post.*` event is attributed to every account the post targets. A subscription with both lists must be satisfied on both. Applied when the event is emitted; a redelivery replays a delivery already made to this endpoint and a test fire ignores the list.
|
|
10147
|
+
*/
|
|
10148
|
+
accountIds?: Array<(string)>;
|
|
10141
10149
|
};
|
|
10142
10150
|
/**
|
|
10143
10151
|
* A single webhook delivery attempt recorded by Zernio (30-day retention).
|
|
@@ -22297,6 +22305,14 @@ type CreateWebhookSettingsData = {
|
|
|
22297
22305
|
* Resource groups this subscription does not receive (opt-out denylist). Omit or send an empty array to receive every event in `events`. Listing a group here drops its events before delivery and on every replay path. Set at creation it applies to everything this subscription ever receives; changed later via PUT it applies to events emitted after the change, with a five-minute tail for events already queued (see that operation). When the caller is a restricted (zrk_) key, that key's own disabled groups are unioned into whatever you send here, so a restricted key can never create a subscription wider than itself.
|
|
22298
22306
|
*/
|
|
22299
22307
|
disabledResourceGroups?: Array<('publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks')>;
|
|
22308
|
+
/**
|
|
22309
|
+
* Profiles this subscription receives events for. Omit or send an empty array to receive every profile. Every id must be a profile in your team, otherwise the request fails with 404 `profile_not_found` and nothing is created. Typical use is routing the profile that holds test accounts to a staging endpoint.
|
|
22310
|
+
*/
|
|
22311
|
+
profileIds?: Array<(string)>;
|
|
22312
|
+
/**
|
|
22313
|
+
* Connected accounts this subscription receives events for. Omit or send an empty array to receive every account. Every id must be an account in your team, otherwise the request fails with 404 `account_not_found` and nothing is created. Combine with `profileIds` to narrow further; both must match.
|
|
22314
|
+
*/
|
|
22315
|
+
accountIds?: Array<(string)>;
|
|
22300
22316
|
};
|
|
22301
22317
|
};
|
|
22302
22318
|
type CreateWebhookSettingsResponse = ({
|
|
@@ -22354,6 +22370,14 @@ type UpdateWebhookSettingsData = {
|
|
|
22354
22370
|
* Replaces the subscription's denylist. Send an empty array to clear it and receive every event in `events` again. Omitting the field leaves the current denylist untouched. Applies to events emitted after the update; already-queued events can still deliver for up to five minutes after they were enqueued. When the caller is a restricted (zrk_) key, that key's own disabled groups are unioned back in either way, so a restricted key can neither clear nor widen a subscription past its own groups.
|
|
22355
22371
|
*/
|
|
22356
22372
|
disabledResourceGroups?: Array<('publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks')>;
|
|
22373
|
+
/**
|
|
22374
|
+
* Replaces the subscription's profile allowlist. Send an empty array to receive every profile again. Omitting the field leaves the current list untouched. Every id must be a profile in your team, otherwise the request fails with 404 `profile_not_found` and nothing changes. Applies to events emitted after the update. Sending the stored list back unchanged is accepted without re-validation, so an endpoint stays editable after a listed profile is deleted.
|
|
22375
|
+
*/
|
|
22376
|
+
profileIds?: Array<(string)>;
|
|
22377
|
+
/**
|
|
22378
|
+
* Replaces the subscription's account allowlist. Send an empty array to receive every account again. Omitting the field leaves the current list untouched. Every id must be an account in your team, otherwise the request fails with 404 `account_not_found` and nothing changes. Sending the stored list back unchanged is accepted without re-validation.
|
|
22379
|
+
*/
|
|
22380
|
+
accountIds?: Array<(string)>;
|
|
22357
22381
|
};
|
|
22358
22382
|
};
|
|
22359
22383
|
type UpdateWebhookSettingsResponse = ({
|
package/dist/index.d.ts
CHANGED
|
@@ -10138,6 +10138,14 @@ type Webhook = {
|
|
|
10138
10138
|
* Resource groups this subscription does not receive (opt-out denylist, same vocabulary and same semantics as the field on API keys). Absent or empty means the subscription receives every event listed in `events`, which is how every subscription created before this field existed behaves. An event whose group is listed here is dropped before delivery even when it is still present in `events`, and the same check runs on every replay path (test fire, redelivery, dead-letter requeue). Editing the denylist applies to every event emitted afterwards; events already queued when the edit landed can still be delivered for up to five minutes after they were enqueued.
|
|
10139
10139
|
*/
|
|
10140
10140
|
disabledResourceGroups?: Array<('publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks')>;
|
|
10141
|
+
/**
|
|
10142
|
+
* Profiles this subscription receives events for (allowlist). Absent or empty means every profile, which is how every subscription created before this field existed behaves. A scoped subscription is only sent events attributable to a listed profile. An aggregate `post.*` event is attributed to the profile of every account the post targets, so a post spanning two scoped endpoints' profiles reaches both. Events with no profile behind them (`verification.*`, `phone_number.*`, a legacy post whose accounts were deleted) are not delivered to it. Applied when the event is emitted: a redelivery replays a delivery already made to this endpoint, and a test fire ignores the list.
|
|
10143
|
+
*/
|
|
10144
|
+
profileIds?: Array<(string)>;
|
|
10145
|
+
/**
|
|
10146
|
+
* Connected accounts this subscription receives events for (allowlist). Absent or empty means every account. Same semantics as `profileIds`, keyed on the account: an aggregate `post.*` event is attributed to every account the post targets. A subscription with both lists must be satisfied on both. Applied when the event is emitted; a redelivery replays a delivery already made to this endpoint and a test fire ignores the list.
|
|
10147
|
+
*/
|
|
10148
|
+
accountIds?: Array<(string)>;
|
|
10141
10149
|
};
|
|
10142
10150
|
/**
|
|
10143
10151
|
* A single webhook delivery attempt recorded by Zernio (30-day retention).
|
|
@@ -22297,6 +22305,14 @@ type CreateWebhookSettingsData = {
|
|
|
22297
22305
|
* Resource groups this subscription does not receive (opt-out denylist). Omit or send an empty array to receive every event in `events`. Listing a group here drops its events before delivery and on every replay path. Set at creation it applies to everything this subscription ever receives; changed later via PUT it applies to events emitted after the change, with a five-minute tail for events already queued (see that operation). When the caller is a restricted (zrk_) key, that key's own disabled groups are unioned into whatever you send here, so a restricted key can never create a subscription wider than itself.
|
|
22298
22306
|
*/
|
|
22299
22307
|
disabledResourceGroups?: Array<('publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks')>;
|
|
22308
|
+
/**
|
|
22309
|
+
* Profiles this subscription receives events for. Omit or send an empty array to receive every profile. Every id must be a profile in your team, otherwise the request fails with 404 `profile_not_found` and nothing is created. Typical use is routing the profile that holds test accounts to a staging endpoint.
|
|
22310
|
+
*/
|
|
22311
|
+
profileIds?: Array<(string)>;
|
|
22312
|
+
/**
|
|
22313
|
+
* Connected accounts this subscription receives events for. Omit or send an empty array to receive every account. Every id must be an account in your team, otherwise the request fails with 404 `account_not_found` and nothing is created. Combine with `profileIds` to narrow further; both must match.
|
|
22314
|
+
*/
|
|
22315
|
+
accountIds?: Array<(string)>;
|
|
22300
22316
|
};
|
|
22301
22317
|
};
|
|
22302
22318
|
type CreateWebhookSettingsResponse = ({
|
|
@@ -22354,6 +22370,14 @@ type UpdateWebhookSettingsData = {
|
|
|
22354
22370
|
* Replaces the subscription's denylist. Send an empty array to clear it and receive every event in `events` again. Omitting the field leaves the current denylist untouched. Applies to events emitted after the update; already-queued events can still deliver for up to five minutes after they were enqueued. When the caller is a restricted (zrk_) key, that key's own disabled groups are unioned back in either way, so a restricted key can neither clear nor widen a subscription past its own groups.
|
|
22355
22371
|
*/
|
|
22356
22372
|
disabledResourceGroups?: Array<('publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks')>;
|
|
22373
|
+
/**
|
|
22374
|
+
* Replaces the subscription's profile allowlist. Send an empty array to receive every profile again. Omitting the field leaves the current list untouched. Every id must be a profile in your team, otherwise the request fails with 404 `profile_not_found` and nothing changes. Applies to events emitted after the update. Sending the stored list back unchanged is accepted without re-validation, so an endpoint stays editable after a listed profile is deleted.
|
|
22375
|
+
*/
|
|
22376
|
+
profileIds?: Array<(string)>;
|
|
22377
|
+
/**
|
|
22378
|
+
* Replaces the subscription's account allowlist. Send an empty array to receive every account again. Omitting the field leaves the current list untouched. Every id must be an account in your team, otherwise the request fails with 404 `account_not_found` and nothing changes. Sending the stored list back unchanged is accepted without re-validation.
|
|
22379
|
+
*/
|
|
22380
|
+
accountIds?: Array<(string)>;
|
|
22357
22381
|
};
|
|
22358
22382
|
};
|
|
22359
22383
|
type UpdateWebhookSettingsResponse = ({
|
package/dist/index.js
CHANGED
|
@@ -36,7 +36,7 @@ module.exports = __toCommonJS(index_exports);
|
|
|
36
36
|
// package.json
|
|
37
37
|
var package_default = {
|
|
38
38
|
name: "@zernio/node",
|
|
39
|
-
version: "0.2.
|
|
39
|
+
version: "0.2.886",
|
|
40
40
|
description: "The official Node.js library for the Zernio API",
|
|
41
41
|
main: "dist/index.js",
|
|
42
42
|
module: "dist/index.mjs",
|
package/dist/index.mjs
CHANGED
|
@@ -5,7 +5,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
|
|
|
5
5
|
// package.json
|
|
6
6
|
var package_default = {
|
|
7
7
|
name: "@zernio/node",
|
|
8
|
-
version: "0.2.
|
|
8
|
+
version: "0.2.886",
|
|
9
9
|
description: "The official Node.js library for the Zernio API",
|
|
10
10
|
main: "dist/index.js",
|
|
11
11
|
module: "dist/index.mjs",
|
package/package.json
CHANGED
package/src/generated/sdk.gen.ts
CHANGED
|
@@ -3547,6 +3547,13 @@ export const getWebhookSettings = <ThrowOnError extends boolean = false>(options
|
|
|
3547
3547
|
* subscriptions behave. A restricted key's own disabled groups are always
|
|
3548
3548
|
* unioned in.
|
|
3549
3549
|
*
|
|
3550
|
+
* `profileIds` pins the subscription to a set of profiles and `accountIds`
|
|
3551
|
+
* to a set of connected accounts: only events attributable to one of the
|
|
3552
|
+
* listed ids are delivered, and a subscription with both lists must match
|
|
3553
|
+
* on both. Use them to send test accounts to a staging endpoint. Ids
|
|
3554
|
+
* outside your team are rejected with 404 (`profile_not_found`,
|
|
3555
|
+
* `account_not_found`).
|
|
3556
|
+
*
|
|
3550
3557
|
*/
|
|
3551
3558
|
export const createWebhookSettings = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<CreateWebhookSettingsData, ThrowOnError>) => {
|
|
3552
3559
|
return (options?.client ?? client).post<CreateWebhookSettingsResponse, CreateWebhookSettingsError, ThrowOnError>({
|
|
@@ -3581,6 +3588,10 @@ export const createWebhookSettings = <ThrowOnError extends boolean = false>(opti
|
|
|
3581
3588
|
* subscription. Retries beyond that window, dead-letter replays, test fires,
|
|
3582
3589
|
* and redeliveries are all checked against the current denylist.
|
|
3583
3590
|
*
|
|
3591
|
+
* `profileIds` and `accountIds` replace the subscription's allowlists; an
|
|
3592
|
+
* empty array clears one. Ids outside your team are rejected with 404
|
|
3593
|
+
* (`profile_not_found`, `account_not_found`).
|
|
3594
|
+
*
|
|
3584
3595
|
*/
|
|
3585
3596
|
export const updateWebhookSettings = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<UpdateWebhookSettingsData, ThrowOnError>) => {
|
|
3586
3597
|
return (options?.client ?? client).put<UpdateWebhookSettingsResponse, UpdateWebhookSettingsError, ThrowOnError>({
|
|
@@ -8802,6 +8802,14 @@ export type Webhook = {
|
|
|
8802
8802
|
* Resource groups this subscription does not receive (opt-out denylist, same vocabulary and same semantics as the field on API keys). Absent or empty means the subscription receives every event listed in `events`, which is how every subscription created before this field existed behaves. An event whose group is listed here is dropped before delivery even when it is still present in `events`, and the same check runs on every replay path (test fire, redelivery, dead-letter requeue). Editing the denylist applies to every event emitted afterwards; events already queued when the edit landed can still be delivered for up to five minutes after they were enqueued.
|
|
8803
8803
|
*/
|
|
8804
8804
|
disabledResourceGroups?: Array<('publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks')>;
|
|
8805
|
+
/**
|
|
8806
|
+
* Profiles this subscription receives events for (allowlist). Absent or empty means every profile, which is how every subscription created before this field existed behaves. A scoped subscription is only sent events attributable to a listed profile. An aggregate `post.*` event is attributed to the profile of every account the post targets, so a post spanning two scoped endpoints' profiles reaches both. Events with no profile behind them (`verification.*`, `phone_number.*`, a legacy post whose accounts were deleted) are not delivered to it. Applied when the event is emitted: a redelivery replays a delivery already made to this endpoint, and a test fire ignores the list.
|
|
8807
|
+
*/
|
|
8808
|
+
profileIds?: Array<(string)>;
|
|
8809
|
+
/**
|
|
8810
|
+
* Connected accounts this subscription receives events for (allowlist). Absent or empty means every account. Same semantics as `profileIds`, keyed on the account: an aggregate `post.*` event is attributed to every account the post targets. A subscription with both lists must be satisfied on both. Applied when the event is emitted; a redelivery replays a delivery already made to this endpoint and a test fire ignores the list.
|
|
8811
|
+
*/
|
|
8812
|
+
accountIds?: Array<(string)>;
|
|
8805
8813
|
};
|
|
8806
8814
|
|
|
8807
8815
|
/**
|
|
@@ -21718,6 +21726,14 @@ export type CreateWebhookSettingsData = {
|
|
|
21718
21726
|
* Resource groups this subscription does not receive (opt-out denylist). Omit or send an empty array to receive every event in `events`. Listing a group here drops its events before delivery and on every replay path. Set at creation it applies to everything this subscription ever receives; changed later via PUT it applies to events emitted after the change, with a five-minute tail for events already queued (see that operation). When the caller is a restricted (zrk_) key, that key's own disabled groups are unioned into whatever you send here, so a restricted key can never create a subscription wider than itself.
|
|
21719
21727
|
*/
|
|
21720
21728
|
disabledResourceGroups?: Array<('publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks')>;
|
|
21729
|
+
/**
|
|
21730
|
+
* Profiles this subscription receives events for. Omit or send an empty array to receive every profile. Every id must be a profile in your team, otherwise the request fails with 404 `profile_not_found` and nothing is created. Typical use is routing the profile that holds test accounts to a staging endpoint.
|
|
21731
|
+
*/
|
|
21732
|
+
profileIds?: Array<(string)>;
|
|
21733
|
+
/**
|
|
21734
|
+
* Connected accounts this subscription receives events for. Omit or send an empty array to receive every account. Every id must be an account in your team, otherwise the request fails with 404 `account_not_found` and nothing is created. Combine with `profileIds` to narrow further; both must match.
|
|
21735
|
+
*/
|
|
21736
|
+
accountIds?: Array<(string)>;
|
|
21721
21737
|
};
|
|
21722
21738
|
};
|
|
21723
21739
|
|
|
@@ -21778,6 +21794,14 @@ export type UpdateWebhookSettingsData = {
|
|
|
21778
21794
|
* Replaces the subscription's denylist. Send an empty array to clear it and receive every event in `events` again. Omitting the field leaves the current denylist untouched. Applies to events emitted after the update; already-queued events can still deliver for up to five minutes after they were enqueued. When the caller is a restricted (zrk_) key, that key's own disabled groups are unioned back in either way, so a restricted key can neither clear nor widen a subscription past its own groups.
|
|
21779
21795
|
*/
|
|
21780
21796
|
disabledResourceGroups?: Array<('publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks')>;
|
|
21797
|
+
/**
|
|
21798
|
+
* Replaces the subscription's profile allowlist. Send an empty array to receive every profile again. Omitting the field leaves the current list untouched. Every id must be a profile in your team, otherwise the request fails with 404 `profile_not_found` and nothing changes. Applies to events emitted after the update. Sending the stored list back unchanged is accepted without re-validation, so an endpoint stays editable after a listed profile is deleted.
|
|
21799
|
+
*/
|
|
21800
|
+
profileIds?: Array<(string)>;
|
|
21801
|
+
/**
|
|
21802
|
+
* Replaces the subscription's account allowlist. Send an empty array to receive every account again. Omitting the field leaves the current list untouched. Every id must be an account in your team, otherwise the request fails with 404 `account_not_found` and nothing changes. Sending the stored list back unchanged is accepted without re-validation.
|
|
21803
|
+
*/
|
|
21804
|
+
accountIds?: Array<(string)>;
|
|
21781
21805
|
};
|
|
21782
21806
|
};
|
|
21783
21807
|
|