@getlatedev/node 0.2.483 → 0.2.485

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
@@ -1816,7 +1816,7 @@ type AdTreeAdSet = {
1816
1816
  page_id?: string;
1817
1817
  } | null;
1818
1818
  /**
1819
- * Individual ads within this ad set (capped at 100). Returns a subset of Ad fields from the aggregation (core fields like _id, name, platform, status, budget, metrics, creative, goal are included; targeting and schedule may be absent). When `timeIncrement=1&dailyLevel=ad`, each entry also carries a `daily[]` array of `AdDailyMetrics`.
1819
+ * Individual ads within this ad set (capped at 100). Returns a subset of Ad fields from the aggregation: `_id`, `name`, `platform`, `status`, `configuredStatus`, `reviewStatus`, `budget`, `metrics`, `creative`, `goal` and the `platform*` ids are always included; `targeting` and `schedule` may be absent. `configuredStatus` (the ad's own on/off toggle) and `reviewStatus` (the platform's review verdict) are part of this contract, not incidental: a rejected ad is only distinguishable from a healthy one through `reviewStatus`. When `timeIncrement=1&dailyLevel=ad`, each entry also carries a `daily[]` array of `AdDailyMetrics`.
1820
1820
  */
1821
1821
  ads?: Array<Ad>;
1822
1822
  /**
@@ -27942,6 +27942,12 @@ type CreateStandaloneAdData = {
27942
27942
  /**
27943
27943
  * Pixel ID. **Meta:** Facebook Pixel ID, required for `goal: conversions`.
27944
27944
  * **TikTok:** TikTok Pixel ID, required for `goal: conversions`.
27945
+ * To discover the pixels an ad account can use, call
27946
+ * `GET /v1/accounts/{accountId}/tracking-tags?adAccountId=act_...` (each entry
27947
+ * carries `kind` and `ownerAdAccountId`), or
27948
+ * `GET /v1/accounts/{accountId}/conversion-destinations`. Note this is a
27949
+ * different resource from `GET /v1/ads/{adId}/tracking-tags`, which reads an
27950
+ * ad's click-URL params (`url_tags`), not pixels.
27945
27951
  *
27946
27952
  */
27947
27953
  pixelId?: string;
package/dist/index.d.ts CHANGED
@@ -1816,7 +1816,7 @@ type AdTreeAdSet = {
1816
1816
  page_id?: string;
1817
1817
  } | null;
1818
1818
  /**
1819
- * Individual ads within this ad set (capped at 100). Returns a subset of Ad fields from the aggregation (core fields like _id, name, platform, status, budget, metrics, creative, goal are included; targeting and schedule may be absent). When `timeIncrement=1&dailyLevel=ad`, each entry also carries a `daily[]` array of `AdDailyMetrics`.
1819
+ * Individual ads within this ad set (capped at 100). Returns a subset of Ad fields from the aggregation: `_id`, `name`, `platform`, `status`, `configuredStatus`, `reviewStatus`, `budget`, `metrics`, `creative`, `goal` and the `platform*` ids are always included; `targeting` and `schedule` may be absent. `configuredStatus` (the ad's own on/off toggle) and `reviewStatus` (the platform's review verdict) are part of this contract, not incidental: a rejected ad is only distinguishable from a healthy one through `reviewStatus`. When `timeIncrement=1&dailyLevel=ad`, each entry also carries a `daily[]` array of `AdDailyMetrics`.
1820
1820
  */
1821
1821
  ads?: Array<Ad>;
1822
1822
  /**
@@ -27942,6 +27942,12 @@ type CreateStandaloneAdData = {
27942
27942
  /**
27943
27943
  * Pixel ID. **Meta:** Facebook Pixel ID, required for `goal: conversions`.
27944
27944
  * **TikTok:** TikTok Pixel ID, required for `goal: conversions`.
27945
+ * To discover the pixels an ad account can use, call
27946
+ * `GET /v1/accounts/{accountId}/tracking-tags?adAccountId=act_...` (each entry
27947
+ * carries `kind` and `ownerAdAccountId`), or
27948
+ * `GET /v1/accounts/{accountId}/conversion-destinations`. Note this is a
27949
+ * different resource from `GET /v1/ads/{adId}/tracking-tags`, which reads an
27950
+ * ad's click-URL params (`url_tags`), not pixels.
27945
27951
  *
27946
27952
  */
27947
27953
  pixelId?: string;
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.483",
39
+ version: "0.2.485",
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.483",
8
+ version: "0.2.485",
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": "@getlatedev/node",
3
- "version": "0.2.483",
3
+ "version": "0.2.485",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -4128,10 +4128,10 @@ export const listSmsOptOuts = <ThrowOnError extends boolean = false>(options?: O
4128
4128
  * Constraints: 3-11 characters (letters, digits, spaces; at least one
4129
4129
  * letter). Sends cannot reach the US, Canada, or Puerto Rico, are
4130
4130
  * text-only, and recipients cannot reply. Sender IDs that impersonate
4131
- * well-known brands or institutions are rejected, and an ID already
4132
- * registered by another workspace returns 409 (active sender IDs are
4133
- * globally unique, first-come-first-served). Creating the same sender ID
4134
- * again is a no-op (re-activates it after a delete).
4131
+ * well-known brands or institutions are rejected. Names are not
4132
+ * exclusive: the same sender ID can be registered by any number of
4133
+ * workspaces. Creating the same sender ID again is a no-op
4134
+ * (re-activates it after a delete).
4135
4135
  *
4136
4136
  */
4137
4137
  export const createSmsSenderId = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<CreateSmsSenderIdData, ThrowOnError>) => {
@@ -6908,6 +6908,12 @@ export const updateAdSetStatus = <ThrowOnError extends boolean = false>(options:
6908
6908
  * (`campaign` default, or `adset` / `ad`) to choose which levels carry the series. This replaces
6909
6909
  * calling the tree once per day for per-campaign daily trends.
6910
6910
  *
6911
+ * **Deleted objects stay in the tree.** Deleting an ad or a campaign is a soft delete: the Ad
6912
+ * documents move to `status: cancelled` and are kept indefinitely, so their historical spend
6913
+ * still counts toward the metrics of any date range they fall in. There is no pruning job and
6914
+ * no retention window. Filter on `status` if your view should hide them, but do that after
6915
+ * reading the totals, not before.
6916
+ *
6911
6917
  */
6912
6918
  export const getAdTree = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetAdTreeData, ThrowOnError>) => {
6913
6919
  return (options?.client ?? client).get<GetAdTreeResponse, GetAdTreeError, ThrowOnError>({
@@ -7167,6 +7173,11 @@ export const getAdAnalytics = <ThrowOnError extends boolean = false>(options: Op
7167
7173
  * - LinkedIn (linkedinads): the campaign's Dynamic UTM `dynamicValueParameters` + `customValueParameters`.
7168
7174
  * Returns 405 for platforms without a click-URL tracking surface (TikTok, X, Pinterest).
7169
7175
  *
7176
+ * **Not pixels.** Despite the shared path segment, this endpoint has nothing to do with
7177
+ * measurement tags. For an ad account's pixels use
7178
+ * `GET /v1/accounts/{accountId}/tracking-tags?adAccountId=act_...` (Meta Pixels, with `kind`
7179
+ * and `ownerAdAccountId`) or `GET /v1/accounts/{accountId}/conversion-destinations`.
7180
+ *
7170
7181
  */
7171
7182
  export const getAdTrackingTags = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetAdTrackingTagsData, ThrowOnError>) => {
7172
7183
  return (options?.client ?? client).get<GetAdTrackingTagsResponse, GetAdTrackingTagsError, ThrowOnError>({
@@ -644,7 +644,7 @@ export type AdTreeAdSet = {
644
644
  page_id?: string;
645
645
  } | null;
646
646
  /**
647
- * Individual ads within this ad set (capped at 100). Returns a subset of Ad fields from the aggregation (core fields like _id, name, platform, status, budget, metrics, creative, goal are included; targeting and schedule may be absent). When `timeIncrement=1&dailyLevel=ad`, each entry also carries a `daily[]` array of `AdDailyMetrics`.
647
+ * Individual ads within this ad set (capped at 100). Returns a subset of Ad fields from the aggregation: `_id`, `name`, `platform`, `status`, `configuredStatus`, `reviewStatus`, `budget`, `metrics`, `creative`, `goal` and the `platform*` ids are always included; `targeting` and `schedule` may be absent. `configuredStatus` (the ad's own on/off toggle) and `reviewStatus` (the platform's review verdict) are part of this contract, not incidental: a rejected ad is only distinguishable from a healthy one through `reviewStatus`. When `timeIncrement=1&dailyLevel=ad`, each entry also carries a `daily[]` array of `AdDailyMetrics`.
648
648
  */
649
649
  ads?: Array<Ad>;
650
650
  /**
@@ -28472,6 +28472,12 @@ export type CreateStandaloneAdData = {
28472
28472
  /**
28473
28473
  * Pixel ID. **Meta:** Facebook Pixel ID, required for `goal: conversions`.
28474
28474
  * **TikTok:** TikTok Pixel ID, required for `goal: conversions`.
28475
+ * To discover the pixels an ad account can use, call
28476
+ * `GET /v1/accounts/{accountId}/tracking-tags?adAccountId=act_...` (each entry
28477
+ * carries `kind` and `ownerAdAccountId`), or
28478
+ * `GET /v1/accounts/{accountId}/conversion-destinations`. Note this is a
28479
+ * different resource from `GET /v1/ads/{adId}/tracking-tags`, which reads an
28480
+ * ad's click-URL params (`url_tags`), not pixels.
28475
28481
  *
28476
28482
  */
28477
28483
  pixelId?: string;