@zernio/node 0.2.973 → 0.2.975

package/dist/index.d.mts

@@ -48414,7 +48414,7 @@ type GetTrackingTagData = {
     };
 };
 type GetTrackingTagResponse = ({
-    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads';
+    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
     tag?: TrackingTag;
 });
 type GetTrackingTagError = (ErrorResponse | {
@@ -48451,7 +48451,7 @@ type UpdateTrackingTagData = {
     };
 };
 type UpdateTrackingTagResponse = ({
-    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads';
+    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
     tag?: TrackingTag;
 });
 type UpdateTrackingTagError = (unknown | {
@@ -48542,7 +48542,7 @@ type InstallTrackingTagOnStoreData = {
     };
 };
 type InstallTrackingTagOnStoreResponse = ({
-    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads';
+    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
     install?: (StorePixelInstall & {
         /**
          * Shopify only: the pixel this install replaced on the store, if any.
@@ -48594,7 +48594,7 @@ type GetTrackingTagStoreInstallData = {
     };
 };
 type GetTrackingTagStoreInstallResponse = ({
-    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads';
+    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
     install?: (StorePixelInstall & {
         /**
          * WordPress only.
@@ -48641,7 +48641,7 @@ type RemoveTrackingTagFromStoreData = {
     };
 };
 type RemoveTrackingTagFromStoreResponse = ({
-    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads';
+    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
     install?: (StorePixelInstall & {
         /**
          * WordPress only: number of Zernio widgets deleted.
@@ -48763,7 +48763,7 @@ type GetTrackingTagStatsData = {
     };
 };
 type GetTrackingTagStatsResponse = ({
-    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads';
+    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
     stats?: {
         aggregation?: string;
         startTime?: number;

package/dist/index.d.ts

@@ -48414,7 +48414,7 @@ type GetTrackingTagData = {
     };
 };
 type GetTrackingTagResponse = ({
-    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads';
+    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
     tag?: TrackingTag;
 });
 type GetTrackingTagError = (ErrorResponse | {
@@ -48451,7 +48451,7 @@ type UpdateTrackingTagData = {
     };
 };
 type UpdateTrackingTagResponse = ({
-    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads';
+    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
     tag?: TrackingTag;
 });
 type UpdateTrackingTagError = (unknown | {
@@ -48542,7 +48542,7 @@ type InstallTrackingTagOnStoreData = {
     };
 };
 type InstallTrackingTagOnStoreResponse = ({
-    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads';
+    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
     install?: (StorePixelInstall & {
         /**
          * Shopify only: the pixel this install replaced on the store, if any.
@@ -48594,7 +48594,7 @@ type GetTrackingTagStoreInstallData = {
     };
 };
 type GetTrackingTagStoreInstallResponse = ({
-    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads';
+    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
     install?: (StorePixelInstall & {
         /**
          * WordPress only.
@@ -48641,7 +48641,7 @@ type RemoveTrackingTagFromStoreData = {
     };
 };
 type RemoveTrackingTagFromStoreResponse = ({
-    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads';
+    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
     install?: (StorePixelInstall & {
         /**
          * WordPress only: number of Zernio widgets deleted.
@@ -48763,7 +48763,7 @@ type GetTrackingTagStatsData = {
     };
 };
 type GetTrackingTagStatsResponse = ({
-    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads';
+    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
     stats?: {
         aggregation?: string;
         startTime?: number;

package/dist/index.js

@@ -36,7 +36,7 @@ module.exports = __toCommonJS(index_exports);
 // package.json
 var package_default = {
   name: "@zernio/node",
-  version: "0.2.973",
+  version: "0.2.975",
   description: "The official Node.js library for the Zernio API",
   main: "dist/index.js",
   module: "dist/index.mjs",

package/dist/index.mjs

@@ -5,7 +5,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
 // package.json
 var package_default = {
   name: "@zernio/node",
-  version: "0.2.973",
+  version: "0.2.975",
   description: "The official Node.js library for the Zernio API",
   main: "dist/index.js",
   module: "dist/index.mjs",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zernio/node",
-  "version": "0.2.973",
+  "version": "0.2.975",
   "description": "The official Node.js library for the Zernio API",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

package/src/generated/sdk.gen.ts

@@ -13609,8 +13609,7 @@ export const startBusinessAgentEvalRun = <ThrowOnError extends boolean = false>(
  * to scope the list to a single ad account; omit it to list every pixel
  * reachable by the token (the name is then suffixed with the ad account
  * it was discovered on, for disambiguation). The list view omits `code`.
- * Call `getTrackingTag` for the install snippet and full detail (Meta
- * only; OpenAI Ads has no get-by-id endpoint).
+ * Call `getTrackingTag` for the install snippet and full detail.
  *
  * Meta (platform `metaads`) and OpenAI Ads (platform `openaiads`); other
  * platforms return 501. The `accountId` must be the ads SocialAccount
@@ -13670,9 +13669,15 @@ export const createTrackingTag = <ThrowOnError extends boolean = false>(options:
  * Get a tracking tag
  * Returns the full tag record including the base-code `code` snippet,
  * `lastFiredTime`, `ownerBusinessId`, `isUnavailable`, etc. Meta only
- * (platform `metaads`); other platforms return 501. OpenAI Ads has no
- * get-by-id endpoint, so it answers 501 here too. Use
- * `GET /v1/accounts/{accountId}/tracking-tags` (list) instead.
+ * (platform `metaads`); other platforms return 501.
+ *
+ * OpenAI Ads (`openaiads`): `tagId` is the pixel's API id (`cds_...`) or
+ * its `pixel_id`. OpenAI documents no single-pixel read, so the tag is
+ * resolved from the pixel list; the response adds `code` (the official
+ * `oaiq` base code plus `page_viewed`) and `events` (the conversion
+ * event settings whose source is this pixel). `siteTagId` is the
+ * `pixel_id` the site and the Conversions API send; `id` is what event
+ * settings reference.
  *
  */
 export const getTrackingTag = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetTrackingTagData, ThrowOnError>) => {
@@ -13690,6 +13695,10 @@ export const getTrackingTag = <ThrowOnError extends boolean = false>(options: Op
  * Returns the re-fetched canonical tag. Meta only (platform `metaads`);
  * other platforms return 501.
  *
+ * OpenAI Ads answers 501: its API has no pixel update or delete route
+ * (`POST`/`PATCH`/`PUT`/`DELETE /v1/conversions/pixels/{id}` answer 405
+ * "Invalid method"); rename a pixel in OpenAI Ads Manager.
+ *
  * There is no DELETE: Meta has no API to delete a pixel. To stop using
  * one, unshare it from your ad accounts (`DELETE
  * .../tracking-tags/{tagId}/shared-accounts`) or disable it in Events
@@ -13759,10 +13768,22 @@ export const removeTrackingTagSharedAccount = <ThrowOnError extends boolean = fa
  * Events respect the store's customer privacy settings (marketing consent).
  *
  * `accountId` is the Meta ads account that owns the pixel (`tagId`); `storeAccountId` is the
- * Shopify account. Stores connected before pixel support must re-approve the Zernio app:
+ * Shopify account.
+ *
+ * OpenAI Ads on Shopify: each event is sent through OpenAI's documented image tag
+ * (`GET https://bzr.openai.com/v1/sdk/events`) as `page_viewed`, `contents_viewed`,
+ * `items_added`, `checkout_started`, `order_created`, and custom events `search` and
+ * `addpaymentinfo` (lowercase, so a Conversions API Search/AddPaymentInfo with the same
+ * event id deduplicates). Amounts are sent in the currency's minor unit. The landing
+ * page's `oppref` click id is kept in the `__oppref` cookie for 30 days and sent with
+ * every event. The image tag cannot carry the `__obref` browser id (OpenAI rejects the
+ * parameter), and the search text is never sent. On WordPress the widget holds the
+ * official `oaiq` base code and a `page_viewed` call.
+ *
+ * Stores connected before pixel support must re-approve the Zernio app:
  * the call then answers 409 `reconnect_required` with `details.authUrl` to send the
- * merchant to (the Shopify account id stays the same). Meta only (platform `metaads`);
- * other platforms return 501.
+ * merchant to (the Shopify account id stays the same). Platforms without an install path
+ * return 501.
  *
  * **WordPress** (`storeAccountId` is a connected WordPress.com or self-hosted site): Zernio
  * adds a Custom HTML widget with the Meta pixel base code (fbevents.js, `init`, `PageView`)
@@ -13837,6 +13858,11 @@ export const removeTrackingTagFromStore = <ThrowOnError extends boolean = false>
  * settings, TikTok pixel events, Meta custom conversions. Platforms where events are just
  * names the site sends (Pinterest) answer 501.
  *
+ * OpenAI Ads: the account's conversion event settings whose source is this pixel.
+ * `siteEventId` is the event name the site sends (a standard event such as
+ * `order_created`, or the lowercase custom event name); `clickWindowDays` is the
+ * attribution window.
+ *
  */
 export const listTrackingTagEvents = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<ListTrackingTagEventsData, ThrowOnError>) => {
     return (options?.client ?? client).get<ListTrackingTagEventsResponse, ListTrackingTagEventsError, ThrowOnError>({
@@ -13853,6 +13879,18 @@ export const listTrackingTagEvents = <ThrowOnError extends boolean = false>(opti
  * optional fields; sending one it does not store answers 400 naming the supported fields.
  * NOT idempotent unless noted per platform: do not retry blindly.
  *
+ * OpenAI Ads: creates a conversion event setting on the pixel (`POST
+ * /conversions/event_settings`, source = the pixel). Accepts `name`, `type` and
+ * `siteEvent` only. `type` is a standard event (`order_created`, `lead_created`,
+ * `items_added`, `contents_viewed`, `checkout_started`, `registration_completed`,
+ * `subscription_created`, `trial_started`, `appointment_scheduled`, `page_viewed`,
+ * `app_installed`, `app_opened`) or, for anything else, the custom event name itself
+ * (1 to 64 letters, digits, underscores or dashes; stored lowercase). `siteEvent` maps
+ * `search` and `add_payment_info` to the custom events `search` and `addpaymentinfo`,
+ * the names Zernio's Shopify pixel sends. The click attribution window is 30 days, the
+ * only value OpenAI documents. Only standard events can be a conversions campaign's
+ * optimization goal.
+ *
  */
 export const createTrackingTagEvent = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<CreateTrackingTagEventData, ThrowOnError>) => {
     return (options?.client ?? client).post<CreateTrackingTagEventResponse, CreateTrackingTagEventError, ThrowOnError>({
@@ -13864,6 +13902,11 @@ export const createTrackingTagEvent = <ThrowOnError extends boolean = false>(opt
 /**
  * Update a conversion event
  * Partial update; at least one field. A field the platform does not store answers 400.
+ *
+ * OpenAI Ads answers 501: OpenAI documents only list and create for event settings, and
+ * `POST`/`PATCH`/`PUT /v1/conversions/event_settings/{id}` answer 404 "Invalid URL".
+ * Create a new event instead.
+ *
  */
 export const updateTrackingTagEvent = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<UpdateTrackingTagEventData, ThrowOnError>) => {
     return (options?.client ?? client).patch<UpdateTrackingTagEventResponse, UpdateTrackingTagEventError, ThrowOnError>({
@@ -13877,6 +13920,10 @@ export const updateTrackingTagEvent = <ThrowOnError extends boolean = false>(opt
  * Removes the conversion event. Platforms without a hard delete archive or disable it
  * instead; `state` in the response says which (`deleted`, `archived`, `disabled`).
  *
+ * OpenAI Ads answers 501: there is no delete or archive route for event settings
+ * (`DELETE /v1/conversions/event_settings/{id}` and `POST .../{id}/archive` answer 404
+ * "Invalid URL"). Archive the event in OpenAI Ads Manager.
+ *
  */
 export const deleteTrackingTagEvent = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<DeleteTrackingTagEventData, ThrowOnError>) => {
     return (options?.client ?? client).delete<DeleteTrackingTagEventResponse, DeleteTrackingTagEventError, ThrowOnError>({
@@ -13892,6 +13939,14 @@ export const deleteTrackingTagEvent = <ThrowOnError extends boolean = false>(opt
  * through as-is; their shape depends on the `aggregation` requested.
  * Platforms without a stats API answer 501.
  *
+ * OpenAI Ads: the recent-events stream (`GET /conversions/events`), the
+ * latest (at most 50) Pixel SDK events received in the last 15 minutes,
+ * one row per event (`event_type`, `api_channel`, `event_timestamp_ms`,
+ * `received_at_ms`, ...). Conversions API events are not included. It is
+ * a fixed window: `startTime`/`endTime` answer 400. Use it to confirm an
+ * install fires; attributed totals come from ads analytics. Accounts not
+ * enabled for the stream answer 422 `feature_not_available`.
+ *
  */
 export const getTrackingTagStats = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetTrackingTagStatsData, ThrowOnError>) => {
     return (options?.client ?? client).get<GetTrackingTagStatsResponse, GetTrackingTagStatsError, ThrowOnError>({

package/src/generated/types.gen.ts

@@ -49566,7 +49566,7 @@ export type GetTrackingTagData = {
 };
 
 export type GetTrackingTagResponse = ({
-    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads';
+    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
     tag?: TrackingTag;
 });
 
@@ -49606,7 +49606,7 @@ export type UpdateTrackingTagData = {
 };
 
 export type UpdateTrackingTagResponse = ({
-    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads';
+    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
     tag?: TrackingTag;
 });
 
@@ -49709,7 +49709,7 @@ export type InstallTrackingTagOnStoreData = {
 };
 
 export type InstallTrackingTagOnStoreResponse = ({
-    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads';
+    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
     install?: (StorePixelInstall & {
     /**
      * Shopify only: the pixel this install replaced on the store, if any.
@@ -49764,7 +49764,7 @@ export type GetTrackingTagStoreInstallData = {
 };
 
 export type GetTrackingTagStoreInstallResponse = ({
-    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads';
+    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
     install?: (StorePixelInstall & {
     /**
      * WordPress only.
@@ -49814,7 +49814,7 @@ export type RemoveTrackingTagFromStoreData = {
 };
 
 export type RemoveTrackingTagFromStoreResponse = ({
-    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads';
+    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
     install?: (StorePixelInstall & {
     /**
      * WordPress only: number of Zernio widgets deleted.
@@ -49951,7 +49951,7 @@ export type GetTrackingTagStatsData = {
 };
 
 export type GetTrackingTagStatsResponse = ({
-    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads';
+    platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
     stats?: {
         aggregation?: string;
         startTime?: number;