@zernio/node 0.2.974 → 0.2.975

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.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.974",
39
+ version: "0.2.975",
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.974",
8
+ version: "0.2.975",
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.974",
3
+ "version": "0.2.975",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -13858,6 +13858,11 @@ export const removeTrackingTagFromStore = <ThrowOnError extends boolean = false>
13858
13858
  * settings, TikTok pixel events, Meta custom conversions. Platforms where events are just
13859
13859
  * names the site sends (Pinterest) answer 501.
13860
13860
  *
13861
+ * OpenAI Ads: the account's conversion event settings whose source is this pixel.
13862
+ * `siteEventId` is the event name the site sends (a standard event such as
13863
+ * `order_created`, or the lowercase custom event name); `clickWindowDays` is the
13864
+ * attribution window.
13865
+ *
13861
13866
  */
13862
13867
  export const listTrackingTagEvents = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<ListTrackingTagEventsData, ThrowOnError>) => {
13863
13868
  return (options?.client ?? client).get<ListTrackingTagEventsResponse, ListTrackingTagEventsError, ThrowOnError>({
@@ -13874,6 +13879,18 @@ export const listTrackingTagEvents = <ThrowOnError extends boolean = false>(opti
13874
13879
  * optional fields; sending one it does not store answers 400 naming the supported fields.
13875
13880
  * NOT idempotent unless noted per platform: do not retry blindly.
13876
13881
  *
13882
+ * OpenAI Ads: creates a conversion event setting on the pixel (`POST
13883
+ * /conversions/event_settings`, source = the pixel). Accepts `name`, `type` and
13884
+ * `siteEvent` only. `type` is a standard event (`order_created`, `lead_created`,
13885
+ * `items_added`, `contents_viewed`, `checkout_started`, `registration_completed`,
13886
+ * `subscription_created`, `trial_started`, `appointment_scheduled`, `page_viewed`,
13887
+ * `app_installed`, `app_opened`) or, for anything else, the custom event name itself
13888
+ * (1 to 64 letters, digits, underscores or dashes; stored lowercase). `siteEvent` maps
13889
+ * `search` and `add_payment_info` to the custom events `search` and `addpaymentinfo`,
13890
+ * the names Zernio's Shopify pixel sends. The click attribution window is 30 days, the
13891
+ * only value OpenAI documents. Only standard events can be a conversions campaign's
13892
+ * optimization goal.
13893
+ *
13877
13894
  */
13878
13895
  export const createTrackingTagEvent = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<CreateTrackingTagEventData, ThrowOnError>) => {
13879
13896
  return (options?.client ?? client).post<CreateTrackingTagEventResponse, CreateTrackingTagEventError, ThrowOnError>({
@@ -13885,6 +13902,11 @@ export const createTrackingTagEvent = <ThrowOnError extends boolean = false>(opt
13885
13902
  /**
13886
13903
  * Update a conversion event
13887
13904
  * Partial update; at least one field. A field the platform does not store answers 400.
13905
+ *
13906
+ * OpenAI Ads answers 501: OpenAI documents only list and create for event settings, and
13907
+ * `POST`/`PATCH`/`PUT /v1/conversions/event_settings/{id}` answer 404 "Invalid URL".
13908
+ * Create a new event instead.
13909
+ *
13888
13910
  */
13889
13911
  export const updateTrackingTagEvent = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<UpdateTrackingTagEventData, ThrowOnError>) => {
13890
13912
  return (options?.client ?? client).patch<UpdateTrackingTagEventResponse, UpdateTrackingTagEventError, ThrowOnError>({
@@ -13898,6 +13920,10 @@ export const updateTrackingTagEvent = <ThrowOnError extends boolean = false>(opt
13898
13920
  * Removes the conversion event. Platforms without a hard delete archive or disable it
13899
13921
  * instead; `state` in the response says which (`deleted`, `archived`, `disabled`).
13900
13922
  *
13923
+ * OpenAI Ads answers 501: there is no delete or archive route for event settings
13924
+ * (`DELETE /v1/conversions/event_settings/{id}` and `POST .../{id}/archive` answer 404
13925
+ * "Invalid URL"). Archive the event in OpenAI Ads Manager.
13926
+ *
13901
13927
  */
13902
13928
  export const deleteTrackingTagEvent = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<DeleteTrackingTagEventData, ThrowOnError>) => {
13903
13929
  return (options?.client ?? client).delete<DeleteTrackingTagEventResponse, DeleteTrackingTagEventError, ThrowOnError>({