@zernio/node 0.2.883 → 0.2.885
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 +21 -2
- package/dist/index.d.ts +21 -2
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/sdk.gen.ts +8 -0
- package/src/generated/types.gen.ts +21 -2
package/dist/index.d.mts
CHANGED
|
@@ -10138,6 +10138,10 @@ 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; events with no profile behind them (`verification.*`, `phone_number.*`) 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)>;
|
|
10141
10145
|
};
|
|
10142
10146
|
/**
|
|
10143
10147
|
* A single webhook delivery attempt recorded by Zernio (30-day retention).
|
|
@@ -17056,7 +17060,12 @@ type ConnectAdsData = {
|
|
|
17056
17060
|
* gives one, `details.disableReason`. Unsettled and in-grace accounts
|
|
17057
17061
|
* are accepted, matching the `selectable` flag of `GET /v1/ads/accounts`.
|
|
17058
17062
|
* Setting a scope also removes already synced ads from de-scoped ad
|
|
17059
|
-
* accounts.
|
|
17063
|
+
* accounts. On Meta the scope also decides which ad accounts Zernio
|
|
17064
|
+
* subscribes to ad-account webhooks: only the scoped ones, instead of
|
|
17065
|
+
* every ad account the login can reach. The scope is kept when this
|
|
17066
|
+
* call returns an `authUrl`, so the Meta Ads account created after
|
|
17067
|
+
* OAuth is scoped (and only its scoped ad accounts synced and
|
|
17068
|
+
* subscribed) from the start. For multiple accounts use `adAccountIds` instead.
|
|
17060
17069
|
*
|
|
17061
17070
|
*/
|
|
17062
17071
|
adAccountId?: string;
|
|
@@ -17066,8 +17075,10 @@ type ConnectAdsData = {
|
|
|
17066
17075
|
* (`?adAccountIds=act_1&adAccountIds=act_2`) or comma-separate
|
|
17067
17076
|
* (`?adAccountIds=act_1,act_2`). Persisted server-side; latest call
|
|
17068
17077
|
* wins, and de-scoped ad accounts have their synced ads removed.
|
|
17078
|
+
* On Meta only the scoped ad accounts get webhook subscriptions,
|
|
17079
|
+
* including when the call starts a fresh OAuth.
|
|
17069
17080
|
* Omitting both `adAccountId` and `adAccountIds` keeps any previously
|
|
17070
|
-
* persisted scope unchanged.
|
|
17081
|
+
* persisted scope unchanged (no scope means every reachable ad account).
|
|
17071
17082
|
*
|
|
17072
17083
|
*/
|
|
17073
17084
|
adAccountIds?: Array<(string)>;
|
|
@@ -22290,6 +22301,10 @@ type CreateWebhookSettingsData = {
|
|
|
22290
22301
|
* 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.
|
|
22291
22302
|
*/
|
|
22292
22303
|
disabledResourceGroups?: Array<('publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks')>;
|
|
22304
|
+
/**
|
|
22305
|
+
* 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.
|
|
22306
|
+
*/
|
|
22307
|
+
profileIds?: Array<(string)>;
|
|
22293
22308
|
};
|
|
22294
22309
|
};
|
|
22295
22310
|
type CreateWebhookSettingsResponse = ({
|
|
@@ -22347,6 +22362,10 @@ type UpdateWebhookSettingsData = {
|
|
|
22347
22362
|
* 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.
|
|
22348
22363
|
*/
|
|
22349
22364
|
disabledResourceGroups?: Array<('publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks')>;
|
|
22365
|
+
/**
|
|
22366
|
+
* 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.
|
|
22367
|
+
*/
|
|
22368
|
+
profileIds?: Array<(string)>;
|
|
22350
22369
|
};
|
|
22351
22370
|
};
|
|
22352
22371
|
type UpdateWebhookSettingsResponse = ({
|
package/dist/index.d.ts
CHANGED
|
@@ -10138,6 +10138,10 @@ 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; events with no profile behind them (`verification.*`, `phone_number.*`) 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)>;
|
|
10141
10145
|
};
|
|
10142
10146
|
/**
|
|
10143
10147
|
* A single webhook delivery attempt recorded by Zernio (30-day retention).
|
|
@@ -17056,7 +17060,12 @@ type ConnectAdsData = {
|
|
|
17056
17060
|
* gives one, `details.disableReason`. Unsettled and in-grace accounts
|
|
17057
17061
|
* are accepted, matching the `selectable` flag of `GET /v1/ads/accounts`.
|
|
17058
17062
|
* Setting a scope also removes already synced ads from de-scoped ad
|
|
17059
|
-
* accounts.
|
|
17063
|
+
* accounts. On Meta the scope also decides which ad accounts Zernio
|
|
17064
|
+
* subscribes to ad-account webhooks: only the scoped ones, instead of
|
|
17065
|
+
* every ad account the login can reach. The scope is kept when this
|
|
17066
|
+
* call returns an `authUrl`, so the Meta Ads account created after
|
|
17067
|
+
* OAuth is scoped (and only its scoped ad accounts synced and
|
|
17068
|
+
* subscribed) from the start. For multiple accounts use `adAccountIds` instead.
|
|
17060
17069
|
*
|
|
17061
17070
|
*/
|
|
17062
17071
|
adAccountId?: string;
|
|
@@ -17066,8 +17075,10 @@ type ConnectAdsData = {
|
|
|
17066
17075
|
* (`?adAccountIds=act_1&adAccountIds=act_2`) or comma-separate
|
|
17067
17076
|
* (`?adAccountIds=act_1,act_2`). Persisted server-side; latest call
|
|
17068
17077
|
* wins, and de-scoped ad accounts have their synced ads removed.
|
|
17078
|
+
* On Meta only the scoped ad accounts get webhook subscriptions,
|
|
17079
|
+
* including when the call starts a fresh OAuth.
|
|
17069
17080
|
* Omitting both `adAccountId` and `adAccountIds` keeps any previously
|
|
17070
|
-
* persisted scope unchanged.
|
|
17081
|
+
* persisted scope unchanged (no scope means every reachable ad account).
|
|
17071
17082
|
*
|
|
17072
17083
|
*/
|
|
17073
17084
|
adAccountIds?: Array<(string)>;
|
|
@@ -22290,6 +22301,10 @@ type CreateWebhookSettingsData = {
|
|
|
22290
22301
|
* 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.
|
|
22291
22302
|
*/
|
|
22292
22303
|
disabledResourceGroups?: Array<('publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks')>;
|
|
22304
|
+
/**
|
|
22305
|
+
* 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.
|
|
22306
|
+
*/
|
|
22307
|
+
profileIds?: Array<(string)>;
|
|
22293
22308
|
};
|
|
22294
22309
|
};
|
|
22295
22310
|
type CreateWebhookSettingsResponse = ({
|
|
@@ -22347,6 +22362,10 @@ type UpdateWebhookSettingsData = {
|
|
|
22347
22362
|
* 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.
|
|
22348
22363
|
*/
|
|
22349
22364
|
disabledResourceGroups?: Array<('publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks')>;
|
|
22365
|
+
/**
|
|
22366
|
+
* 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.
|
|
22367
|
+
*/
|
|
22368
|
+
profileIds?: Array<(string)>;
|
|
22350
22369
|
};
|
|
22351
22370
|
};
|
|
22352
22371
|
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.885",
|
|
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.885",
|
|
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,11 @@ 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: only events
|
|
3551
|
+
* attributable to one of them are delivered. Use it to send the profile
|
|
3552
|
+
* holding your test accounts to a staging endpoint. Ids outside your team
|
|
3553
|
+
* are rejected with 404 `profile_not_found`.
|
|
3554
|
+
*
|
|
3550
3555
|
*/
|
|
3551
3556
|
export const createWebhookSettings = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<CreateWebhookSettingsData, ThrowOnError>) => {
|
|
3552
3557
|
return (options?.client ?? client).post<CreateWebhookSettingsResponse, CreateWebhookSettingsError, ThrowOnError>({
|
|
@@ -3581,6 +3586,9 @@ export const createWebhookSettings = <ThrowOnError extends boolean = false>(opti
|
|
|
3581
3586
|
* subscription. Retries beyond that window, dead-letter replays, test fires,
|
|
3582
3587
|
* and redeliveries are all checked against the current denylist.
|
|
3583
3588
|
*
|
|
3589
|
+
* `profileIds` replaces the subscription's profile allowlist; an empty array
|
|
3590
|
+
* clears it. Ids outside your team are rejected with 404 `profile_not_found`.
|
|
3591
|
+
*
|
|
3584
3592
|
*/
|
|
3585
3593
|
export const updateWebhookSettings = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<UpdateWebhookSettingsData, ThrowOnError>) => {
|
|
3586
3594
|
return (options?.client ?? client).put<UpdateWebhookSettingsResponse, UpdateWebhookSettingsError, ThrowOnError>({
|
|
@@ -8802,6 +8802,10 @@ 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; events with no profile behind them (`verification.*`, `phone_number.*`) 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)>;
|
|
8805
8809
|
};
|
|
8806
8810
|
|
|
8807
8811
|
/**
|
|
@@ -16102,7 +16106,12 @@ export type ConnectAdsData = {
|
|
|
16102
16106
|
* gives one, `details.disableReason`. Unsettled and in-grace accounts
|
|
16103
16107
|
* are accepted, matching the `selectable` flag of `GET /v1/ads/accounts`.
|
|
16104
16108
|
* Setting a scope also removes already synced ads from de-scoped ad
|
|
16105
|
-
* accounts.
|
|
16109
|
+
* accounts. On Meta the scope also decides which ad accounts Zernio
|
|
16110
|
+
* subscribes to ad-account webhooks: only the scoped ones, instead of
|
|
16111
|
+
* every ad account the login can reach. The scope is kept when this
|
|
16112
|
+
* call returns an `authUrl`, so the Meta Ads account created after
|
|
16113
|
+
* OAuth is scoped (and only its scoped ad accounts synced and
|
|
16114
|
+
* subscribed) from the start. For multiple accounts use `adAccountIds` instead.
|
|
16106
16115
|
*
|
|
16107
16116
|
*/
|
|
16108
16117
|
adAccountId?: string;
|
|
@@ -16112,8 +16121,10 @@ export type ConnectAdsData = {
|
|
|
16112
16121
|
* (`?adAccountIds=act_1&adAccountIds=act_2`) or comma-separate
|
|
16113
16122
|
* (`?adAccountIds=act_1,act_2`). Persisted server-side; latest call
|
|
16114
16123
|
* wins, and de-scoped ad accounts have their synced ads removed.
|
|
16124
|
+
* On Meta only the scoped ad accounts get webhook subscriptions,
|
|
16125
|
+
* including when the call starts a fresh OAuth.
|
|
16115
16126
|
* Omitting both `adAccountId` and `adAccountIds` keeps any previously
|
|
16116
|
-
* persisted scope unchanged.
|
|
16127
|
+
* persisted scope unchanged (no scope means every reachable ad account).
|
|
16117
16128
|
*
|
|
16118
16129
|
*/
|
|
16119
16130
|
adAccountIds?: Array<(string)>;
|
|
@@ -21711,6 +21722,10 @@ export type CreateWebhookSettingsData = {
|
|
|
21711
21722
|
* 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.
|
|
21712
21723
|
*/
|
|
21713
21724
|
disabledResourceGroups?: Array<('publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks')>;
|
|
21725
|
+
/**
|
|
21726
|
+
* 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.
|
|
21727
|
+
*/
|
|
21728
|
+
profileIds?: Array<(string)>;
|
|
21714
21729
|
};
|
|
21715
21730
|
};
|
|
21716
21731
|
|
|
@@ -21771,6 +21786,10 @@ export type UpdateWebhookSettingsData = {
|
|
|
21771
21786
|
* 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.
|
|
21772
21787
|
*/
|
|
21773
21788
|
disabledResourceGroups?: Array<('publishing' | 'engagement' | 'messages' | 'contacts' | 'analytics' | 'ads' | 'telephony' | 'accounts' | 'billing' | 'webhooks')>;
|
|
21789
|
+
/**
|
|
21790
|
+
* 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.
|
|
21791
|
+
*/
|
|
21792
|
+
profileIds?: Array<(string)>;
|
|
21774
21793
|
};
|
|
21775
21794
|
};
|
|
21776
21795
|
|