@zernio/node 0.2.518 → 0.2.519

package/dist/index.d.mts

@@ -47,6 +47,12 @@ interface ClientOptions {
  */
 declare class Zernio {
     private _options;
+    /**
+     * HTTP client owned by this instance. Every namespace method below is bound
+     * to it, so two Zernio instances in the same process never see each other's
+     * credentials.
+     */
+    private _client;
     /**
      * API key used for authentication.
      */
@@ -55,6 +61,13 @@ declare class Zernio {
      * Base URL for API requests.
      */
     baseURL: string;
+    /**
+     * Routes a generated operation through this instance's client, preserving the
+     * operation's own signature. Reads `_client` when the method is called, not
+     * when it is bound, because class fields initialize before the constructor
+     * body runs.
+     */
+    private _bind;
     /**
      * validate API
      */
@@ -2785,6 +2798,15 @@ type ConversionEvent = {
          * Meta advanced matching (ge). 'f' or 'm'; hashed server-side. Meta only.
          */
         gender?: string;
+        /**
+         * Meta lead ID from a Lead Ad submission, as a string. Required
+         * for Conversion Leads CRM events: send it with
+         * `actionSource: 'crm'` and
+         * `platformData: { event_source: 'crm', lead_event_source: '<CRM name>' }`.
+         * Forwarded unhashed to Meta's `user_data.lead_id`. Meta only.
+         *
+         */
+        leadId?: string;
         /**
          * Platform click identifiers captured from the originating ad click.
          */
@@ -2840,7 +2862,13 @@ type ConversionEvent = {
      */
     actionSource?: 'web' | 'app' | 'offline' | 'crm' | 'phone_call' | 'system_generated';
     /**
-     * Escape hatch for platform-specific fields we haven't normalized. Forwarded as-is.
+     * Escape hatch for platform-specific fields we haven't normalized.
+     * On Meta, keys are shallow-merged into `custom_data` only: fields
+     * Zernio already builds (`value`, `currency`, `contents`,
+     * `num_items`) always win on collision, and `user_data` (hashed
+     * match keys) is never touched. Use first-class fields (e.g.
+     * `user.leadId`) for anything that must reach `user_data`.
+     *
      */
     platformData?: {
         [key: string]: unknown;

package/dist/index.d.ts

@@ -47,6 +47,12 @@ interface ClientOptions {
  */
 declare class Zernio {
     private _options;
+    /**
+     * HTTP client owned by this instance. Every namespace method below is bound
+     * to it, so two Zernio instances in the same process never see each other's
+     * credentials.
+     */
+    private _client;
     /**
      * API key used for authentication.
      */
@@ -55,6 +61,13 @@ declare class Zernio {
      * Base URL for API requests.
      */
     baseURL: string;
+    /**
+     * Routes a generated operation through this instance's client, preserving the
+     * operation's own signature. Reads `_client` when the method is called, not
+     * when it is bound, because class fields initialize before the constructor
+     * body runs.
+     */
+    private _bind;
     /**
      * validate API
      */
@@ -2785,6 +2798,15 @@ type ConversionEvent = {
          * Meta advanced matching (ge). 'f' or 'm'; hashed server-side. Meta only.
          */
         gender?: string;
+        /**
+         * Meta lead ID from a Lead Ad submission, as a string. Required
+         * for Conversion Leads CRM events: send it with
+         * `actionSource: 'crm'` and
+         * `platformData: { event_source: 'crm', lead_event_source: '<CRM name>' }`.
+         * Forwarded unhashed to Meta's `user_data.lead_id`. Meta only.
+         *
+         */
+        leadId?: string;
         /**
          * Platform click identifiers captured from the originating ad click.
          */
@@ -2840,7 +2862,13 @@ type ConversionEvent = {
      */
     actionSource?: 'web' | 'app' | 'offline' | 'crm' | 'phone_call' | 'system_generated';
     /**
-     * Escape hatch for platform-specific fields we haven't normalized. Forwarded as-is.
+     * Escape hatch for platform-specific fields we haven't normalized.
+     * On Meta, keys are shallow-merged into `custom_data` only: fields
+     * Zernio already builds (`value`, `currency`, `contents`,
+     * `num_items`) always win on collision, and `user_data` (hashed
+     * match keys) is never touched. Use first-class fields (e.g.
+     * `user.leadId`) for anything that must reach `user_data`.
+     *
      */
     platformData?: {
         [key: string]: unknown;