@zernio/node 0.2.1488 → 0.2.1490

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 CHANGED
@@ -52189,6 +52189,13 @@ type DuplicateAdCampaignResponse = ({
52189
52189
  adIdMap?: {
52190
52190
  [key: string]: (string);
52191
52191
  };
52192
+ /**
52193
+ * The copy exists on the platform in all three cases.
52194
+ *
52195
+ * - `triggered`: an ads sync started and runs after this response, so the copy may not be readable through Zernio yet.
52196
+ * - `skipped`: no sync started, so the copy appears on a later scheduled sync.
52197
+ * - `failed`: the sync could not start. A sync that errors after the response is not reported here.
52198
+ */
52192
52199
  discovery?: 'triggered' | 'skipped' | 'failed';
52193
52200
  /**
52194
52201
  * Platform-native response from the copy (TikTok and LinkedIn). Absent on Meta, which returns `adSetIdMap` and `adIdMap` instead.
@@ -52791,6 +52798,13 @@ type DuplicateAdSetResponse = ({
52791
52798
  adIdMap?: {
52792
52799
  [key: string]: (string);
52793
52800
  };
52801
+ /**
52802
+ * The copy exists on the platform in all three cases.
52803
+ *
52804
+ * - `triggered`: an ads sync started and runs after this response, so the copy may not be readable through Zernio yet.
52805
+ * - `skipped`: no sync started, so the copy appears on a later scheduled sync.
52806
+ * - `failed`: the sync could not start. A sync that errors after the response is not reported here.
52807
+ */
52794
52808
  discovery?: 'triggered' | 'skipped' | 'failed';
52795
52809
  /**
52796
52810
  * Platform-native response from the copy (TikTok). Absent on Meta, which returns `adIdMap` instead.
@@ -52855,6 +52869,13 @@ type DuplicateAdResponse = ({
52855
52869
  * Platform ID of the new ad
52856
52870
  */
52857
52871
  copiedAdId?: string;
52872
+ /**
52873
+ * The copy exists on the platform in all three cases.
52874
+ *
52875
+ * - `triggered`: an ads sync started and runs after this response, so the copy may not be readable through Zernio yet.
52876
+ * - `skipped`: no sync started, so the copy appears on a later scheduled sync.
52877
+ * - `failed`: the sync could not start. A sync that errors after the response is not reported here.
52878
+ */
52858
52879
  discovery?: 'triggered' | 'skipped' | 'failed';
52859
52880
  raw?: {
52860
52881
  [key: string]: unknown;
@@ -58114,7 +58135,7 @@ type ListAdAccountsResponse = ({
58114
58135
  */
58115
58136
  minimumDailyBudget?: number;
58116
58137
  /**
58117
- * Meta only. Meta's `funding_source` ID for the ad account, forwarded unchanged. ABSENT both when this connection's token cannot see billing and when the account has no payment method; read `billingStatus` to tell the two apart.
58138
+ * Meta only. Meta's `funding_source` ID for the ad account, forwarded unchanged. ABSENT when this connection's token cannot see billing, when the account has no payment method, and for accounts paid through Business Billing Hub, which still create ads. Absence alone is not a missing payment method.
58118
58139
  */
58119
58140
  fundingSource?: string;
58120
58141
  /**
@@ -58141,10 +58162,10 @@ type ListAdAccountsResponse = ({
58141
58162
  /**
58142
58163
  * Meta only. Whether the ad account has a payment method:
58143
58164
  *
58144
- * - `missing`: `accountStatus` is `3` (UNSETTLED) or `9` (IN_GRACE_PERIOD), `disableReason` is `3` (RISK_PAYMENT), or the connected person has the MANAGE task on the account (admin, who always sees billing) and Meta returns no funding source.
58165
+ * - `missing`: `accountStatus` is `3` (UNSETTLED) or `9` (IN_GRACE_PERIOD), or `disableReason` is `3` (RISK_PAYMENT).
58145
58166
  * - `missing`, effect: ad creation fails at the ad step with Meta code 100 / subcode 1359188. Add a payment method in Meta's Billing & payments center.
58146
58167
  * - `ok`: Meta returns a funding source. This is presence, not validity: Meta can still refuse the card or balance at ad creation.
58147
- * - `unknown`: the connected person is not an admin of the account, or the token cannot read the billing fields.
58168
+ * - `unknown`: Meta returns no funding source. The token may not see billing, the account may have no payment method, or it is paid through Business Billing Hub (Meta omits the funding source there even for admins). Meta decides at ad creation.
58148
58169
  *
58149
58170
  */
58150
58171
  billingStatus?: 'ok' | 'missing' | 'unknown';
package/dist/index.d.ts CHANGED
@@ -52189,6 +52189,13 @@ type DuplicateAdCampaignResponse = ({
52189
52189
  adIdMap?: {
52190
52190
  [key: string]: (string);
52191
52191
  };
52192
+ /**
52193
+ * The copy exists on the platform in all three cases.
52194
+ *
52195
+ * - `triggered`: an ads sync started and runs after this response, so the copy may not be readable through Zernio yet.
52196
+ * - `skipped`: no sync started, so the copy appears on a later scheduled sync.
52197
+ * - `failed`: the sync could not start. A sync that errors after the response is not reported here.
52198
+ */
52192
52199
  discovery?: 'triggered' | 'skipped' | 'failed';
52193
52200
  /**
52194
52201
  * Platform-native response from the copy (TikTok and LinkedIn). Absent on Meta, which returns `adSetIdMap` and `adIdMap` instead.
@@ -52791,6 +52798,13 @@ type DuplicateAdSetResponse = ({
52791
52798
  adIdMap?: {
52792
52799
  [key: string]: (string);
52793
52800
  };
52801
+ /**
52802
+ * The copy exists on the platform in all three cases.
52803
+ *
52804
+ * - `triggered`: an ads sync started and runs after this response, so the copy may not be readable through Zernio yet.
52805
+ * - `skipped`: no sync started, so the copy appears on a later scheduled sync.
52806
+ * - `failed`: the sync could not start. A sync that errors after the response is not reported here.
52807
+ */
52794
52808
  discovery?: 'triggered' | 'skipped' | 'failed';
52795
52809
  /**
52796
52810
  * Platform-native response from the copy (TikTok). Absent on Meta, which returns `adIdMap` instead.
@@ -52855,6 +52869,13 @@ type DuplicateAdResponse = ({
52855
52869
  * Platform ID of the new ad
52856
52870
  */
52857
52871
  copiedAdId?: string;
52872
+ /**
52873
+ * The copy exists on the platform in all three cases.
52874
+ *
52875
+ * - `triggered`: an ads sync started and runs after this response, so the copy may not be readable through Zernio yet.
52876
+ * - `skipped`: no sync started, so the copy appears on a later scheduled sync.
52877
+ * - `failed`: the sync could not start. A sync that errors after the response is not reported here.
52878
+ */
52858
52879
  discovery?: 'triggered' | 'skipped' | 'failed';
52859
52880
  raw?: {
52860
52881
  [key: string]: unknown;
@@ -58114,7 +58135,7 @@ type ListAdAccountsResponse = ({
58114
58135
  */
58115
58136
  minimumDailyBudget?: number;
58116
58137
  /**
58117
- * Meta only. Meta's `funding_source` ID for the ad account, forwarded unchanged. ABSENT both when this connection's token cannot see billing and when the account has no payment method; read `billingStatus` to tell the two apart.
58138
+ * Meta only. Meta's `funding_source` ID for the ad account, forwarded unchanged. ABSENT when this connection's token cannot see billing, when the account has no payment method, and for accounts paid through Business Billing Hub, which still create ads. Absence alone is not a missing payment method.
58118
58139
  */
58119
58140
  fundingSource?: string;
58120
58141
  /**
@@ -58141,10 +58162,10 @@ type ListAdAccountsResponse = ({
58141
58162
  /**
58142
58163
  * Meta only. Whether the ad account has a payment method:
58143
58164
  *
58144
- * - `missing`: `accountStatus` is `3` (UNSETTLED) or `9` (IN_GRACE_PERIOD), `disableReason` is `3` (RISK_PAYMENT), or the connected person has the MANAGE task on the account (admin, who always sees billing) and Meta returns no funding source.
58165
+ * - `missing`: `accountStatus` is `3` (UNSETTLED) or `9` (IN_GRACE_PERIOD), or `disableReason` is `3` (RISK_PAYMENT).
58145
58166
  * - `missing`, effect: ad creation fails at the ad step with Meta code 100 / subcode 1359188. Add a payment method in Meta's Billing & payments center.
58146
58167
  * - `ok`: Meta returns a funding source. This is presence, not validity: Meta can still refuse the card or balance at ad creation.
58147
- * - `unknown`: the connected person is not an admin of the account, or the token cannot read the billing fields.
58168
+ * - `unknown`: Meta returns no funding source. The token may not see billing, the account may have no payment method, or it is paid through Business Billing Hub (Meta omits the funding source there even for admins). Meta decides at ad creation.
58148
58169
  *
58149
58170
  */
58150
58171
  billingStatus?: 'ok' | 'missing' | 'unknown';
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.1488",
39
+ version: "0.2.1490",
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.1488",
8
+ version: "0.2.1490",
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
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zernio/node",
3
- "version": "0.2.1488",
3
+ "version": "0.2.1490",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -13115,7 +13115,9 @@ export const bulkUpdateAdCampaignStatus = <ThrowOnError extends boolean = false>
13115
13115
  *
13116
13116
  * ### Sync
13117
13117
  *
13118
- * The new hierarchy is asynchronous to materialize in our DB, and we trigger sync discovery automatically. Set `syncAfter: false` to skip and poll `/v1/ads/tree` on your own cadence.
13118
+ * The copy exists on the platform when this call returns. The new hierarchy reaches our DB through a sync discovery that starts automatically and runs after the response, usually within a few minutes.
13119
+ *
13120
+ * Poll `/v1/ads/tree` until it appears; until then, calls that take a copied id return 404, so retry them. Set `syncAfter: false` to skip the sync; the copy then appears on a later scheduled sync.
13119
13121
  *
13120
13122
  */
13121
13123
  export const duplicateAdCampaign = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<DuplicateAdCampaignData, ThrowOnError>) => {
@@ -13319,7 +13321,7 @@ export const createAdSet = <ThrowOnError extends boolean = false>(options: Optio
13319
13321
  * - So an ad set with any number of ads copies: Meta refuses a single deep copy of 3 or more objects.
13320
13322
  * - `statusOption` applies to the ad set and every ad.
13321
13323
  * - If an ad copy fails, the partial ad set copy is deleted and the request fails with Meta's error.
13322
- * - Sync discovery is triggered automatically (`syncAfter: false` to skip).
13324
+ * - A sync discovery starts automatically and runs after the response (`syncAfter: false` to skip). The copy is readable through Zernio once it finishes, usually within a few minutes. Until then, calls that take a copied id return 404, so retry them.
13323
13325
  *
13324
13326
  * TikTok: the ad group is read and recreated under the campaign with its targeting, bidding,
13325
13327
  * budget and schedule (start reset to now); `deepCopy: true` recreates its ads too (default
@@ -13342,7 +13344,7 @@ export const duplicateAdSet = <ThrowOnError extends boolean = false>(options: Op
13342
13344
  *
13343
13345
  * - `adSetId` retargets the copy into another ad set; omitted = the source's own ad set.
13344
13346
  * - Accepts the Zernio ad id or the platform ad id.
13345
- * - Sync discovery is triggered automatically (`syncAfter: false` to skip).
13347
+ * - A sync discovery starts automatically and runs after the response (`syncAfter: false` to skip). The copy is readable through Zernio once it finishes, usually within a few minutes. Until then, calls that take a copied id return 404, so retry them.
13346
13348
  *
13347
13349
  * ### Creative settings
13348
13350
  *
@@ -53013,6 +53013,13 @@ export type DuplicateAdCampaignResponse = ({
53013
53013
  adIdMap?: {
53014
53014
  [key: string]: (string);
53015
53015
  };
53016
+ /**
53017
+ * The copy exists on the platform in all three cases.
53018
+ *
53019
+ * - `triggered`: an ads sync started and runs after this response, so the copy may not be readable through Zernio yet.
53020
+ * - `skipped`: no sync started, so the copy appears on a later scheduled sync.
53021
+ * - `failed`: the sync could not start. A sync that errors after the response is not reported here.
53022
+ */
53016
53023
  discovery?: 'triggered' | 'skipped' | 'failed';
53017
53024
  /**
53018
53025
  * Platform-native response from the copy (TikTok and LinkedIn). Absent on Meta, which returns `adSetIdMap` and `adIdMap` instead.
@@ -53630,6 +53637,13 @@ export type DuplicateAdSetResponse = ({
53630
53637
  adIdMap?: {
53631
53638
  [key: string]: (string);
53632
53639
  };
53640
+ /**
53641
+ * The copy exists on the platform in all three cases.
53642
+ *
53643
+ * - `triggered`: an ads sync started and runs after this response, so the copy may not be readable through Zernio yet.
53644
+ * - `skipped`: no sync started, so the copy appears on a later scheduled sync.
53645
+ * - `failed`: the sync could not start. A sync that errors after the response is not reported here.
53646
+ */
53633
53647
  discovery?: 'triggered' | 'skipped' | 'failed';
53634
53648
  /**
53635
53649
  * Platform-native response from the copy (TikTok). Absent on Meta, which returns `adIdMap` instead.
@@ -53697,6 +53711,13 @@ export type DuplicateAdResponse = ({
53697
53711
  * Platform ID of the new ad
53698
53712
  */
53699
53713
  copiedAdId?: string;
53714
+ /**
53715
+ * The copy exists on the platform in all three cases.
53716
+ *
53717
+ * - `triggered`: an ads sync started and runs after this response, so the copy may not be readable through Zernio yet.
53718
+ * - `skipped`: no sync started, so the copy appears on a later scheduled sync.
53719
+ * - `failed`: the sync could not start. A sync that errors after the response is not reported here.
53720
+ */
53700
53721
  discovery?: 'triggered' | 'skipped' | 'failed';
53701
53722
  raw?: {
53702
53723
  [key: string]: unknown;
@@ -59301,7 +59322,7 @@ export type ListAdAccountsResponse = ({
59301
59322
  */
59302
59323
  minimumDailyBudget?: number;
59303
59324
  /**
59304
- * Meta only. Meta's `funding_source` ID for the ad account, forwarded unchanged. ABSENT both when this connection's token cannot see billing and when the account has no payment method; read `billingStatus` to tell the two apart.
59325
+ * Meta only. Meta's `funding_source` ID for the ad account, forwarded unchanged. ABSENT when this connection's token cannot see billing, when the account has no payment method, and for accounts paid through Business Billing Hub, which still create ads. Absence alone is not a missing payment method.
59305
59326
  */
59306
59327
  fundingSource?: string;
59307
59328
  /**
@@ -59328,10 +59349,10 @@ export type ListAdAccountsResponse = ({
59328
59349
  /**
59329
59350
  * Meta only. Whether the ad account has a payment method:
59330
59351
  *
59331
- * - `missing`: `accountStatus` is `3` (UNSETTLED) or `9` (IN_GRACE_PERIOD), `disableReason` is `3` (RISK_PAYMENT), or the connected person has the MANAGE task on the account (admin, who always sees billing) and Meta returns no funding source.
59352
+ * - `missing`: `accountStatus` is `3` (UNSETTLED) or `9` (IN_GRACE_PERIOD), or `disableReason` is `3` (RISK_PAYMENT).
59332
59353
  * - `missing`, effect: ad creation fails at the ad step with Meta code 100 / subcode 1359188. Add a payment method in Meta's Billing & payments center.
59333
59354
  * - `ok`: Meta returns a funding source. This is presence, not validity: Meta can still refuse the card or balance at ad creation.
59334
- * - `unknown`: the connected person is not an admin of the account, or the token cannot read the billing fields.
59355
+ * - `unknown`: Meta returns no funding source. The token may not see billing, the account may have no payment method, or it is paid through Business Billing Hub (Meta omits the funding source there even for admins). Meta decides at ad creation.
59335
59356
  *
59336
59357
  */
59337
59358
  billingStatus?: 'ok' | 'missing' | 'unknown';