@getlatedev/node 0.2.1146 → 0.2.1148
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 +31 -5
- package/dist/index.d.ts +31 -5
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/sdk.gen.ts +2 -2
- package/src/generated/types.gen.ts +31 -4
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.1148",
|
|
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.1148",
|
|
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
|
@@ -11226,7 +11226,7 @@ export const listAdsTikTokIdentities = <ThrowOnError extends boolean = false>(op
|
|
|
11226
11226
|
|
|
11227
11227
|
/**
|
|
11228
11228
|
* Per-creative performance inside TikTok Smart+ ads
|
|
11229
|
-
* Breaks a Smart+ ad (or ad group) down by creative material, one row per Spark post, video or image, from TikTok's Smart+ material report. For a Spark post `tiktokItemId` is the TikTok post id. Conversion metrics are TikTok web (pixel) events. TikTok allows two dimensions per report, so rows are keyed by the Smart+ ad (`level=ad`) or by the ad group (`level=adGroup`), not both. Metrics TikTok returns empty come back as null.
|
|
11229
|
+
* Breaks a Smart+ ad (or ad group) down by creative material, one row per Spark post, video or image, from TikTok's Smart+ material report. For a Spark post `tiktokItemId` is the TikTok post id. Conversion metrics are TikTok web (pixel) events. `purchases`, `purchaseValue` and `roas` come from Complete Payment, or from Place an Order (legacy ON_WEB_ORDER pixels) when that reports more; the two are never summed. TikTok allows two dimensions per report, so rows are keyed by the Smart+ ad (`level=ad`) or by the ad group (`level=adGroup`), not both. Metrics TikTok returns empty come back as null.
|
|
11230
11230
|
*/
|
|
11231
11231
|
export const getTikTokSmartPlusMaterialReport = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetTikTokSmartPlusMaterialReportData, ThrowOnError>) => {
|
|
11232
11232
|
return (options?.client ?? client).get<GetTikTokSmartPlusMaterialReportResponse, GetTikTokSmartPlusMaterialReportError, ThrowOnError>({
|
|
@@ -16444,7 +16444,7 @@ export const downloadTikTokVideo = <ThrowOnError extends boolean = false>(option
|
|
|
16444
16444
|
|
|
16445
16445
|
/**
|
|
16446
16446
|
* List API changelog entries
|
|
16447
|
-
* The API changelog, newest first. No API key needed; one address may make 120 requests a minute. Each entry is what the `api.changelog.published` webhook delivered: the announcement in `message`, and in `changes` the deterministic diff of the OpenAPI spec (operations and schemas added, removed and modified) for automation to act on. Page with `before` set to the previous page's `nextCursor`.
|
|
16447
|
+
* The API changelog, newest first. No API key needed; one address may make 120 requests a minute. Each entry is what the `api.changelog.published` webhook delivered: the announcement in `message`, its `impact` on existing integrations, and in `changes` the deterministic diff of the OpenAPI spec (operations and schemas added, removed and modified) for automation to act on. Page with `before` set to the previous page's `nextCursor`.
|
|
16448
16448
|
*
|
|
16449
16449
|
*/
|
|
16450
16450
|
export const listChangelog = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<ListChangelogData, ThrowOnError>) => {
|
|
@@ -773,7 +773,7 @@ export type AdEngagementCounts = {
|
|
|
773
773
|
*
|
|
774
774
|
* Every field is 0 when that step never fired. Populated for Meta ads and,
|
|
775
775
|
* from 2026-10-08, TikTok (contentViews, cartAdds, checkoutsInitiated,
|
|
776
|
-
* purchases = app purchases, else website complete payments, leads; the
|
|
776
|
+
* purchases = app purchases, else website complete payments, else Place an Order, leads; the
|
|
777
777
|
* other steps stay 0). Other platforms report a different action taxonomy
|
|
778
778
|
* and generally leave these at 0 (read `actions` for those). At ad-set and
|
|
779
779
|
* campaign level each step is summed from its per-ad values.
|
|
@@ -979,19 +979,19 @@ export type AdMetrics = {
|
|
|
979
979
|
*/
|
|
980
980
|
costPerConversion?: number;
|
|
981
981
|
/**
|
|
982
|
-
* Per-action-type counts summed over the date range, keyed by the platform's action-type names. Meta: raw Insights action_type keys (link_click, offsite_conversion.fb_pixel_purchase, onsite_conversion.lead_grouped, ...), covering both engagement and conversion events. TikTok: conversion events plus the paid-engagement family (follow, post_reaction for paid likes, comment, share). Website (pixel) events: complete_payment (TikTok's website purchase, the event a SHOPPING-optimised campaign counts in `conversions`), initiate_checkout, add_to_cart, view_content, lead (website form submissions plus TikTok instant-form leads). App events: purchase, view_content (added to the website count). Follow is how FOLLOWERS-goal campaigns report their result. TikTok history note: website add_to_cart, initiate_checkout, complete_payment and lead counts were missing before 2026-10-08 (TikTok rejected the metric names we requested), and each sync re-fetches only the last 7 days, so older days keep them absent until the ad is re-synced from scratch. X: conversion types (purchase, sign_up, site_visit, download, custom). LinkedIn: conversion types (post_click, post_view, lead_gen) plus `video_view`, which carries LinkedIn's `videoViews` under the same key every other platform uses, so it feeds `engagementBreakdown.videoViews` too; it is an engagement, NOT a conversion, and is excluded from `conversions`. Google returns {} (its per-action names aren't synced per ad). Empty object when no actions are reported. NOTE: keys differ by platform, so branch on the ad's platform when interpreting them.
|
|
982
|
+
* Per-action-type counts summed over the date range, keyed by the platform's action-type names. Meta: raw Insights action_type keys (link_click, offsite_conversion.fb_pixel_purchase, onsite_conversion.lead_grouped, ...), covering both engagement and conversion events. TikTok: conversion events plus the paid-engagement family (follow, post_reaction for paid likes, comment, share). Website (pixel) events: complete_payment (TikTok's website purchase, the event a SHOPPING-optimised campaign counts in `conversions`), place_order (Place an Order, the website purchase of pixels set up with the legacy ON_WEB_ORDER event; absent from days synced before this metric was added until the ad is re-synced), initiate_checkout, add_to_cart, view_content, lead (website form submissions plus TikTok instant-form leads). App events: purchase, view_content (added to the website count). Follow is how FOLLOWERS-goal campaigns report their result. TikTok history note: website add_to_cart, initiate_checkout, complete_payment and lead counts were missing before 2026-10-08 (TikTok rejected the metric names we requested), and each sync re-fetches only the last 7 days, so older days keep them absent until the ad is re-synced from scratch. X: conversion types (purchase, sign_up, site_visit, download, custom). LinkedIn: conversion types (post_click, post_view, lead_gen) plus `video_view`, which carries LinkedIn's `videoViews` under the same key every other platform uses, so it feeds `engagementBreakdown.videoViews` too; it is an engagement, NOT a conversion, and is excluded from `conversions`. Google returns {} (its per-action names aren't synced per ad). Empty object when no actions are reported. NOTE: keys differ by platform, so branch on the ad's platform when interpreting them.
|
|
983
983
|
*/
|
|
984
984
|
actions?: {
|
|
985
985
|
[key: string]: (number);
|
|
986
986
|
};
|
|
987
987
|
/**
|
|
988
|
-
* Monetary mirror of `actions`, from Meta's Insights `action_values[]` array. Same keying: values are the revenue attributed to each action_type, in ad-account native currency (same unit as `spend`; see the campaign node's `currency` field). Use this to compute revenue-per-event (e.g. avg purchase value). Meta and TikTok; other platforms return {}. TikTok: the value TikTok attributes to each key of `actions` (purchase and view_content from app events, complete_payment, initiate_checkout, add_to_cart, view_content and lead from the website pixel), present only when the advertiser sends a value with the event. initiate_checkout and add_to_cart values are basket values, not revenue; revenue is complete_payment (website) and purchase (app). Same history note as `actions`.
|
|
988
|
+
* Monetary mirror of `actions`, from Meta's Insights `action_values[]` array. Same keying: values are the revenue attributed to each action_type, in ad-account native currency (same unit as `spend`; see the campaign node's `currency` field). Use this to compute revenue-per-event (e.g. avg purchase value). Meta and TikTok; other platforms return {}. TikTok: the value TikTok attributes to each key of `actions` (purchase and view_content from app events, complete_payment, initiate_checkout, add_to_cart, view_content and lead from the website pixel), present only when the advertiser sends a value with the event. initiate_checkout and add_to_cart values are basket values, not revenue; revenue is complete_payment or place_order (website) and purchase (app). Same history note as `actions`.
|
|
989
989
|
*/
|
|
990
990
|
actionValues?: {
|
|
991
991
|
[key: string]: (number);
|
|
992
992
|
};
|
|
993
993
|
/**
|
|
994
|
-
* Convenience sum of purchase-type action values, picked from `actionValues` for the ad set promoted_object event (custom conversion, custom_event_type, else PURCHASE). It matches `conversions` for conversion-optimized ad sets; when the optimization goal reports a different result (LINK_CLICKS, LANDING_PAGE_VIEWS, ...) it stays on the promoted event so ROAS keeps its purchase basis. In ad-account native currency. 0 when the campaign has no purchase event configured. TikTok: app purchase value plus website complete-payment value (from 2026-10-08;
|
|
994
|
+
* Convenience sum of purchase-type action values, picked from `actionValues` for the ad set promoted_object event (custom conversion, custom_event_type, else PURCHASE). It matches `conversions` for conversion-optimized ad sets; when the optimization goal reports a different result (LINK_CLICKS, LANDING_PAGE_VIEWS, ...) it stays on the promoted event so ROAS keeps its purchase basis. In ad-account native currency. 0 when the campaign has no purchase event configured. TikTok: app purchase value plus website complete-payment value (from 2026-10-08), or the Place an Order value when that is larger (they are never summed, since a pixel can fire both for one sale); days synced before each was added carry the app value only until the ad is re-synced. Other platforms report 0.
|
|
995
995
|
*/
|
|
996
996
|
purchaseValue?: number;
|
|
997
997
|
/**
|
|
@@ -1976,7 +1976,14 @@ export type ApiChangelogEntry = {
|
|
|
1976
1976
|
* Stable entry id; the same entry is never published twice.
|
|
1977
1977
|
*/
|
|
1978
1978
|
id: string;
|
|
1979
|
+
/**
|
|
1980
|
+
* When `impact` is set, `breaking_change` means exactly `impact: action_required`.
|
|
1981
|
+
*/
|
|
1979
1982
|
type: 'new_feature' | 'breaking_change' | 'improvement' | 'deprecation' | 'minor';
|
|
1983
|
+
/**
|
|
1984
|
+
* What an integrator has to do, computed from the OpenAPI diff rather than from the prose. `action_required`: an existing call or parser can break (an operation, parameter or field removed, a field newly required, a type narrowed, an enum value removed, or authentication changed). `additive`: only new or looser things, existing integrations keep working. `none`: descriptions or examples only. Null on entries published before October 2026.
|
|
1985
|
+
*/
|
|
1986
|
+
impact: ('none' | 'additive' | 'action_required') | null;
|
|
1980
1987
|
/**
|
|
1981
1988
|
* Platform and area slugs the entry is about: a platform (`instagram`, `facebook`, `threads`, `tiktok`, `x`, `linkedin`, `youtube`, `pinterest`, `reddit`, `bluesky`, `telegram`, `snapchat`, `whatsapp`, `discord`, `slack`, `google-business`, `imessage`), an ads platform (`meta-ads`, `google-ads`, `tiktok-ads`, `linkedin-ads`, `pinterest-ads`, `x-ads`) or an area (`ads`, `publishing`, `inbox`, `telephony`, `commerce`, `analytics`, `webhooks`, `general`). Filter with the `platform` query parameter.
|
|
1982
1989
|
*/
|
|
@@ -2014,12 +2021,28 @@ export type ApiChangelogEntry = {
|
|
|
2014
2021
|
};
|
|
2015
2022
|
};
|
|
2016
2023
|
|
|
2024
|
+
/**
|
|
2025
|
+
* When `impact` is set, `breaking_change` means exactly `impact: action_required`.
|
|
2026
|
+
*/
|
|
2017
2027
|
export type type2 = 'new_feature' | 'breaking_change' | 'improvement' | 'deprecation' | 'minor';
|
|
2018
2028
|
|
|
2029
|
+
/**
|
|
2030
|
+
* What an integrator has to do, computed from the OpenAPI diff rather than from the prose. `action_required`: an existing call or parser can break (an operation, parameter or field removed, a field newly required, a type narrowed, an enum value removed, or authentication changed). `additive`: only new or looser things, existing integrations keep working. `none`: descriptions or examples only. Null on entries published before October 2026.
|
|
2031
|
+
*/
|
|
2032
|
+
export type impact = 'none' | 'additive' | 'action_required';
|
|
2033
|
+
|
|
2019
2034
|
export type ApiChangelogOperationRef = {
|
|
2020
2035
|
method: string;
|
|
2021
2036
|
path: string;
|
|
2022
2037
|
operationId?: string;
|
|
2038
|
+
/**
|
|
2039
|
+
* OpenAPI tags of the operation.
|
|
2040
|
+
*/
|
|
2041
|
+
tags?: Array<(string)>;
|
|
2042
|
+
/**
|
|
2043
|
+
* The operation's `x-platforms` list, verbatim.
|
|
2044
|
+
*/
|
|
2045
|
+
xPlatforms?: Array<(string)>;
|
|
2023
2046
|
};
|
|
2024
2047
|
|
|
2025
2048
|
export type ApiKey = {
|
|
@@ -56011,6 +56034,10 @@ export type ListChangelogData = {
|
|
|
56011
56034
|
* Only entries published strictly before this instant. Pass the previous page's `nextCursor`.
|
|
56012
56035
|
*/
|
|
56013
56036
|
before?: string;
|
|
56037
|
+
/**
|
|
56038
|
+
* Only entries with this impact. `action_required` lists the changes an integration may need to act on.
|
|
56039
|
+
*/
|
|
56040
|
+
impact?: 'none' | 'additive' | 'action_required';
|
|
56014
56041
|
limit?: number;
|
|
56015
56042
|
/**
|
|
56016
56043
|
* Only entries tagged with this platform or area slug (see `platforms` on the entry). One slug per request.
|