@getlatedev/node 0.2.1086 → 0.2.1088
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 +39 -12
- package/dist/index.d.ts +39 -12
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/sdk.gen.ts +6 -2
- package/src/generated/types.gen.ts +39 -12
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: "@getlatedev/node",
|
|
39
|
-
version: "0.2.
|
|
39
|
+
version: "0.2.1088",
|
|
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: "@getlatedev/node",
|
|
8
|
-
version: "0.2.
|
|
8
|
+
version: "0.2.1088",
|
|
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
|
@@ -9453,7 +9453,9 @@ export const createAdCampaign = <ThrowOnError extends boolean = false>(options:
|
|
|
9453
9453
|
* `skipped: 1`, with the reason). Otherwise the switch is written (`updated: 1`), read back and
|
|
9454
9454
|
* stored, and the delivery status of the ads under it (up to 20) is re-read and stored, so an
|
|
9455
9455
|
* immediate GET returns what the platform now reports. A stored switch never skips a write, and
|
|
9456
|
-
* when the platform cannot be read the write always goes out.
|
|
9456
|
+
* when the platform cannot be read the write always goes out. On Meta the check reads the
|
|
9457
|
+
* campaign's own `status`, so a delivery status such as `IN_PROCESS` or `WITH_ISSUES` does not
|
|
9458
|
+
* force a write.
|
|
9457
9459
|
*
|
|
9458
9460
|
*/
|
|
9459
9461
|
export const updateAdCampaignStatus = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<UpdateAdCampaignStatusData, ThrowOnError>) => {
|
|
@@ -10005,7 +10007,9 @@ export const deleteAdSet = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
10005
10007
|
* the delivery status of its ads (up to 20) is re-read and stored, so an
|
|
10006
10008
|
* immediate GET returns what the platform now reports. A stored switch
|
|
10007
10009
|
* never skips a write, and when the platform cannot be read the write
|
|
10008
|
-
* always goes out.
|
|
10010
|
+
* always goes out. On Meta the check reads the ad set's own `status`, so
|
|
10011
|
+
* a repeated request skips even while `platformAdSetStatus` reads
|
|
10012
|
+
* `CAMPAIGN_PAUSED`, `WITH_ISSUES` or `IN_PROCESS`.
|
|
10009
10013
|
*
|
|
10010
10014
|
*/
|
|
10011
10015
|
export const updateAdSetStatus = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<UpdateAdSetStatusData, ThrowOnError>) => {
|
|
@@ -442,6 +442,11 @@ export type goal = 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lea
|
|
|
442
442
|
|
|
443
443
|
export type type = 'daily' | 'lifetime';
|
|
444
444
|
|
|
445
|
+
/**
|
|
446
|
+
* Request-side publish switch for `adStatus` on ad creation endpoints only (`status`, `campaignStatus` and `adSetStatus` carry their own inline ACTIVE/PAUSED enum there; the status-update endpoints are a separate lowercase `active`/`paused` enum). Distinct from `AdStatus` (the platform-reported delivery status returned on reads).
|
|
447
|
+
*/
|
|
448
|
+
export type AdActivationStatus = 'ACTIVE' | 'PAUSED';
|
|
449
|
+
|
|
445
450
|
export type AdAnalyticsResponse = {
|
|
446
451
|
/**
|
|
447
452
|
* Present and true while historical data is being backfilled.
|
|
@@ -4564,7 +4569,7 @@ export type CtwaAdRequestBody = {
|
|
|
4564
4569
|
* PAUSED to create every object paused.
|
|
4565
4570
|
*
|
|
4566
4571
|
*/
|
|
4567
|
-
adStatus?:
|
|
4572
|
+
adStatus?: AdActivationStatus;
|
|
4568
4573
|
/**
|
|
4569
4574
|
* Meta bid strategy applied to the shared ad set. Defaults to
|
|
4570
4575
|
* `LOWEST_COST_WITHOUT_CAP` (auto-bid) when omitted.
|
|
@@ -4692,15 +4697,6 @@ export type campaignStatus = 'ACTIVE' | 'PAUSED';
|
|
|
4692
4697
|
*/
|
|
4693
4698
|
export type adSetStatus = 'ACTIVE' | 'PAUSED';
|
|
4694
4699
|
|
|
4695
|
-
/**
|
|
4696
|
-
* Ad-level status, same semantics as `POST /v1/ads/create`. Sets the
|
|
4697
|
-
* new ads' switch and overrides `status` for them, also with
|
|
4698
|
-
* `adSetId`. Send `campaignStatus`, `adSetStatus` and `adStatus` all
|
|
4699
|
-
* PAUSED to create every object paused.
|
|
4700
|
-
*
|
|
4701
|
-
*/
|
|
4702
|
-
export type adStatus = 'ACTIVE' | 'PAUSED';
|
|
4703
|
-
|
|
4704
4700
|
/**
|
|
4705
4701
|
* Meta bid strategy applied to the shared ad set. Defaults to
|
|
4706
4702
|
* `LOWEST_COST_WITHOUT_CAP` (auto-bid) when omitted.
|
|
@@ -39131,6 +39127,10 @@ export type ListAdCampaignsData = {
|
|
|
39131
39127
|
* Platform ad account ID (e.g. act_123 for Meta)
|
|
39132
39128
|
*/
|
|
39133
39129
|
adAccountId?: string;
|
|
39130
|
+
/**
|
|
39131
|
+
* Platform campaign ID (the `platformCampaignId` on each returned campaign). Returns only that campaign, or an empty list when it is not visible to the caller. Mirrors the same filter on /v1/ads and /v1/ads/tree.
|
|
39132
|
+
*/
|
|
39133
|
+
campaignId?: string;
|
|
39134
39134
|
/**
|
|
39135
39135
|
* Start of metrics date range (YYYY-MM-DD, inclusive). Defaults to 90 days ago when both date params are omitted.
|
|
39136
39136
|
*/
|
|
@@ -39739,8 +39739,17 @@ export type DuplicateAdCampaignData = {
|
|
|
39739
39739
|
* Reschedule the copied hierarchy's end, read like `startTime`; a date-only end runs to 23:59:59 local. Defaults to the source's end.
|
|
39740
39740
|
*/
|
|
39741
39741
|
endTime?: string;
|
|
39742
|
+
/**
|
|
39743
|
+
* Meta's native `rename_strategy` values. `DEEP_RENAME` renames the copied campaign and every copied child (ad sets, ads) with `renamePrefix` / `renameSuffix`. `ONLY_TOP_LEVEL_RENAME` renames only the copied campaign; children keep their source names. `NO_RENAME` keeps every source name. With no rename option at all, Meta appends its own ` - Copy` suffix; LinkedIn defaults to `DEEP_RENAME` (its campaign group and campaigns are renamed). Ignored on TikTok, where `renamePrefix` / `renameSuffix` apply to every copied object.
|
|
39744
|
+
*/
|
|
39742
39745
|
renameStrategy?: 'DEEP_RENAME' | 'ONLY_TOP_LEVEL_RENAME' | 'NO_RENAME';
|
|
39746
|
+
/**
|
|
39747
|
+
* Text prepended to each renamed object's name.
|
|
39748
|
+
*/
|
|
39743
39749
|
renamePrefix?: string;
|
|
39750
|
+
/**
|
|
39751
|
+
* Text appended to each renamed object's name. On LinkedIn an omitted suffix defaults to ` (Copy)`.
|
|
39752
|
+
*/
|
|
39744
39753
|
renameSuffix?: string;
|
|
39745
39754
|
/**
|
|
39746
39755
|
* Trigger ads discovery on the owning account after the copy succeeds
|
|
@@ -40131,7 +40140,7 @@ export type CreateAdSetError = (ErrorResponse | unknown);
|
|
|
40131
40140
|
|
|
40132
40141
|
export type DuplicateAdSetData = {
|
|
40133
40142
|
body: {
|
|
40134
|
-
platform: 'facebook' | 'instagram';
|
|
40143
|
+
platform: 'facebook' | 'instagram' | 'tiktok';
|
|
40135
40144
|
/**
|
|
40136
40145
|
* Destination platform campaign id (defaults to the source's campaign)
|
|
40137
40146
|
*/
|
|
@@ -40149,8 +40158,17 @@ export type DuplicateAdSetData = {
|
|
|
40149
40158
|
* Reschedule the copy's end, read like `startTime`; a date-only end runs to 23:59:59 local.
|
|
40150
40159
|
*/
|
|
40151
40160
|
endTime?: string;
|
|
40161
|
+
/**
|
|
40162
|
+
* Meta's native `rename_strategy` values. `DEEP_RENAME` renames the copied ad set and its copied ads with `renamePrefix` / `renameSuffix`. `ONLY_TOP_LEVEL_RENAME` renames only the copied ad set; its ads keep their source names. `NO_RENAME` keeps every source name. With no rename option at all, Meta appends its own ` - Copy` suffix. Ignored on TikTok, where `renamePrefix` / `renameSuffix` still apply.
|
|
40163
|
+
*/
|
|
40152
40164
|
renameStrategy?: 'DEEP_RENAME' | 'ONLY_TOP_LEVEL_RENAME' | 'NO_RENAME';
|
|
40165
|
+
/**
|
|
40166
|
+
* Text prepended to each renamed object's name.
|
|
40167
|
+
*/
|
|
40153
40168
|
renamePrefix?: string;
|
|
40169
|
+
/**
|
|
40170
|
+
* Text appended to each renamed object's name.
|
|
40171
|
+
*/
|
|
40154
40172
|
renameSuffix?: string;
|
|
40155
40173
|
syncAfter?: boolean;
|
|
40156
40174
|
};
|
|
@@ -40191,8 +40209,17 @@ export type DuplicateAdData = {
|
|
|
40191
40209
|
*/
|
|
40192
40210
|
adSetId?: string;
|
|
40193
40211
|
statusOption?: 'ACTIVE' | 'PAUSED' | 'INHERITED_FROM_SOURCE';
|
|
40212
|
+
/**
|
|
40213
|
+
* Meta's native `rename_strategy` values. An ad has no copied children, so `DEEP_RENAME` and `ONLY_TOP_LEVEL_RENAME` both rename the copy with `renamePrefix` / `renameSuffix`, and `NO_RENAME` keeps the source name. With no rename option at all, Meta appends its own ` - Copy` suffix.
|
|
40214
|
+
*/
|
|
40194
40215
|
renameStrategy?: 'DEEP_RENAME' | 'ONLY_TOP_LEVEL_RENAME' | 'NO_RENAME';
|
|
40216
|
+
/**
|
|
40217
|
+
* Text prepended to the copy's name.
|
|
40218
|
+
*/
|
|
40195
40219
|
renamePrefix?: string;
|
|
40220
|
+
/**
|
|
40221
|
+
* Text appended to the copy's name.
|
|
40222
|
+
*/
|
|
40196
40223
|
renameSuffix?: string;
|
|
40197
40224
|
syncAfter?: boolean;
|
|
40198
40225
|
/**
|
|
@@ -45566,7 +45593,7 @@ export type CreateStandaloneAdData = {
|
|
|
45566
45593
|
* X returns a 400: a promoted post has no switch of its own, so hold the line item with `adSetStatus`. `PAUSED` with `buyingType: RESERVED` returns a 400 (Meta creates the first Reach and Frequency ad ACTIVE). Performance Max and Demand Gen accept PAUSED only.
|
|
45567
45594
|
*
|
|
45568
45595
|
*/
|
|
45569
|
-
adStatus?:
|
|
45596
|
+
adStatus?: AdActivationStatus;
|
|
45570
45597
|
/**
|
|
45571
45598
|
* Meta only. Where the budget lives, which selects the Meta budget model:
|
|
45572
45599
|
* - `adset` (default): ABO (Ad-set Budget Optimization). The budget is set on the
|