@zernio/node 0.2.734 → 0.2.736

package/dist/index.d.mts

@@ -10262,6 +10262,30 @@ type WebhookPayloadMessage = {
              */
             product_retailer_id?: string;
         };
+        /**
+         * WhatsApp only. The location pin the user shared, forwarded
+         * verbatim from Meta. The message `text` is only the emoji preview
+         * (`📍 <name>`); the coordinates live here.
+         *
+         */
+        location?: {
+            /**
+             * Latitude in decimal degrees.
+             */
+            latitude?: number;
+            /**
+             * Longitude in decimal degrees.
+             */
+            longitude?: number;
+            /**
+             * Location name, when the user shared a named place.
+             */
+            name?: string;
+            /**
+             * Street address, when Meta sends one.
+             */
+            address?: string;
+        };
         /**
          * WhatsApp only. Contact cards the user shared, forwarded verbatim
          * from Meta. Read `contactsOrigin` before treating any number here
@@ -10688,9 +10712,48 @@ type WebhookPayloadMessageSent = {
     conversation: InboxWebhookConversation;
     account: InboxWebhookAccount;
     /**
-     * Platform-specific context for the sent message. The key is present only when the send carried some context, and absent otherwise: it is never null and never an empty object.
+     * Platform-specific context for the sent message: a quote-reply reference, a WhatsApp location pin or WhatsApp contact cards. The key is present only when the send carried some context, and absent otherwise: it is never null and never an empty object. Read it to tell a location or contact-card message from a text one without a GET on the message.
      */
     metadata?: {
+        /**
+         * WhatsApp only. The location pin this message carries, in the same
+         * shape the inbox send API accepts. Present on API sends that passed
+         * `location`, and on Coexistence echoes of a pin shared from the
+         * WhatsApp Business app. The message `text` is only the emoji
+         * preview (`📍 <name>`); the pin itself lives here.
+         *
+         */
+        location?: {
+            /**
+             * Latitude in decimal degrees.
+             */
+            latitude?: number;
+            /**
+             * Longitude in decimal degrees.
+             */
+            longitude?: number;
+            /**
+             * Location name, when one was given.
+             */
+            name?: string;
+            /**
+             * Street address, when one was given.
+             */
+            address?: string;
+        };
+        /**
+         * WhatsApp only. The contact cards this message carries. On API
+         * sends this is the `contacts` array exactly as given to the inbox
+         * send API (`name`, `phones[].phone` / `type`, `emails[]`); on
+         * Coexistence echoes of a card shared from the WhatsApp Business
+         * app it is Meta's shape (`phones[].wa_id`, `vcard`). The message
+         * `text` is only the emoji preview (`👤 <name>`); the cards live
+         * here.
+         *
+         */
+        contacts?: Array<{
+            [key: string]: unknown;
+        }>;
         /**
          * `platformMessageId` of the message this send is a quote-reply to.
          *
@@ -26316,13 +26379,20 @@ type ListPhoneNumberCountriesResponse = ({
          * Live carrier-stock snapshot (refreshed every 6h + on availability checks): false when NO offered type currently has deliverable inventory, so a purchase would fail. Treat as advisory; the purchase itself re-checks.
          */
         inStock?: boolean;
+        /**
+         * At least one out-of-stock type here can be pre-ordered (see `types[].preOrderable`).
+         */
+        preOrderable?: boolean;
         /**
          * Every number type offered in this country (default first). Capabilities, KYC tier, monthly price, and stock are per type. The country-level fields above mirror the first (default) entry. Pass the chosen `numberType` to POST /v1/phone-numbers/purchase.
          *
          */
         types?: Array<{
             numberType?: 'local' | 'mobile' | 'national' | 'toll_free';
-            tier?: 1 | 2 | 3 | 4;
+            /**
+             * Null on a `fulfilment: request` type, whose document tier is only known once its requirements are read.
+             */
+            tier?: (1 | 2 | 3 | 4) | null;
             needsKyc?: boolean;
             /**
              * Price a NEW number of this type costs per month, in cents.
@@ -26335,6 +26405,14 @@ type ListPhoneNumberCountriesResponse = ({
             smsAvailable?: boolean;
             callsAvailable?: boolean;
             inStock?: boolean;
+            /**
+             * `request`: the carrier stocks this type nowhere and only sources it to order, so it is always a pre-order.
+             */
+            fulfilment?: 'instant' | 'request';
+            /**
+             * Out of stock but orderable anyway. Submit KYC as usual (POST /v1/phone-numbers/kyc) and the carrier sources the number after review, usually about 3 weeks and never guaranteed. Only document tiers (3/4) qualify, and nothing is billed until the number is active.
+             */
+            preOrderable?: boolean;
         }>;
     }>;
 });
@@ -26408,6 +26486,10 @@ type CheckPhoneNumberAvailabilityResponse = ({
      * Whether deliverable voice inventory exists right now.
      */
     available?: boolean;
+    /**
+     * Nothing deliverable now, but this pair can be pre-ordered: submit KYC as usual and the carrier sources the number after review (usually about 3 weeks, never guaranteed). Only document tiers (3/4) qualify.
+     */
+    preOrderable?: boolean;
     addressConstraint?: 'geo' | 'country' | 'none';
     /**
      * For `geo` only: the area(s) the registered address must be in.
@@ -26672,6 +26754,10 @@ type CheckWhatsAppNumberAvailabilityResponse = ({
      * Whether deliverable voice inventory exists right now.
      */
     available?: boolean;
+    /**
+     * Nothing deliverable now, but this pair can be pre-ordered: submit KYC as usual and the carrier sources the number after review (usually about 3 weeks, never guaranteed). Only document tiers (3/4) qualify.
+     */
+    preOrderable?: boolean;
     addressConstraint?: 'geo' | 'country' | 'none';
     /**
      * For `geo` only: the area(s) the registered address must be in.
@@ -26853,6 +26939,10 @@ type SubmitPhoneNumberKycData = {
 };
 type SubmitPhoneNumberKycResponse = ({
     status?: 'kyc_submitted' | 'kyc_reused' | 'kyc_already_submitted';
+    /**
+     * True when nothing was in stock and this submission placed a pre-order. The number stays `pending_regulatory` until the carrier sources it (usually about 3 weeks) and is not billed until active. A pre-order is one number: `quantity` above 1 is rejected with 400.
+     */
+    preOrder?: boolean;
     /**
      * The first/primary number, kept at the top level for backward compatibility. See `numbers` for the full set when `quantity` > 1.
      */
@@ -27613,6 +27703,10 @@ type SubmitWhatsAppNumberKycData = {
 };
 type SubmitWhatsAppNumberKycResponse = ({
     status?: 'kyc_submitted' | 'kyc_reused' | 'kyc_already_submitted';
+    /**
+     * True when nothing was in stock and this submission placed a pre-order. The number stays `pending_regulatory` until the carrier sources it (usually about 3 weeks) and is not billed until active. A pre-order is one number: `quantity` above 1 is rejected with 400.
+     */
+    preOrder?: boolean;
     /**
      * The first/primary number, kept at the top level for backward compatibility. See `numbers` for the full set when `quantity` > 1.
      */

package/dist/index.d.ts

@@ -10262,6 +10262,30 @@ type WebhookPayloadMessage = {
              */
             product_retailer_id?: string;
         };
+        /**
+         * WhatsApp only. The location pin the user shared, forwarded
+         * verbatim from Meta. The message `text` is only the emoji preview
+         * (`📍 <name>`); the coordinates live here.
+         *
+         */
+        location?: {
+            /**
+             * Latitude in decimal degrees.
+             */
+            latitude?: number;
+            /**
+             * Longitude in decimal degrees.
+             */
+            longitude?: number;
+            /**
+             * Location name, when the user shared a named place.
+             */
+            name?: string;
+            /**
+             * Street address, when Meta sends one.
+             */
+            address?: string;
+        };
         /**
          * WhatsApp only. Contact cards the user shared, forwarded verbatim
          * from Meta. Read `contactsOrigin` before treating any number here
@@ -10688,9 +10712,48 @@ type WebhookPayloadMessageSent = {
     conversation: InboxWebhookConversation;
     account: InboxWebhookAccount;
     /**
-     * Platform-specific context for the sent message. The key is present only when the send carried some context, and absent otherwise: it is never null and never an empty object.
+     * Platform-specific context for the sent message: a quote-reply reference, a WhatsApp location pin or WhatsApp contact cards. The key is present only when the send carried some context, and absent otherwise: it is never null and never an empty object. Read it to tell a location or contact-card message from a text one without a GET on the message.
      */
     metadata?: {
+        /**
+         * WhatsApp only. The location pin this message carries, in the same
+         * shape the inbox send API accepts. Present on API sends that passed
+         * `location`, and on Coexistence echoes of a pin shared from the
+         * WhatsApp Business app. The message `text` is only the emoji
+         * preview (`📍 <name>`); the pin itself lives here.
+         *
+         */
+        location?: {
+            /**
+             * Latitude in decimal degrees.
+             */
+            latitude?: number;
+            /**
+             * Longitude in decimal degrees.
+             */
+            longitude?: number;
+            /**
+             * Location name, when one was given.
+             */
+            name?: string;
+            /**
+             * Street address, when one was given.
+             */
+            address?: string;
+        };
+        /**
+         * WhatsApp only. The contact cards this message carries. On API
+         * sends this is the `contacts` array exactly as given to the inbox
+         * send API (`name`, `phones[].phone` / `type`, `emails[]`); on
+         * Coexistence echoes of a card shared from the WhatsApp Business
+         * app it is Meta's shape (`phones[].wa_id`, `vcard`). The message
+         * `text` is only the emoji preview (`👤 <name>`); the cards live
+         * here.
+         *
+         */
+        contacts?: Array<{
+            [key: string]: unknown;
+        }>;
         /**
          * `platformMessageId` of the message this send is a quote-reply to.
          *
@@ -26316,13 +26379,20 @@ type ListPhoneNumberCountriesResponse = ({
          * Live carrier-stock snapshot (refreshed every 6h + on availability checks): false when NO offered type currently has deliverable inventory, so a purchase would fail. Treat as advisory; the purchase itself re-checks.
          */
         inStock?: boolean;
+        /**
+         * At least one out-of-stock type here can be pre-ordered (see `types[].preOrderable`).
+         */
+        preOrderable?: boolean;
         /**
          * Every number type offered in this country (default first). Capabilities, KYC tier, monthly price, and stock are per type. The country-level fields above mirror the first (default) entry. Pass the chosen `numberType` to POST /v1/phone-numbers/purchase.
          *
          */
         types?: Array<{
             numberType?: 'local' | 'mobile' | 'national' | 'toll_free';
-            tier?: 1 | 2 | 3 | 4;
+            /**
+             * Null on a `fulfilment: request` type, whose document tier is only known once its requirements are read.
+             */
+            tier?: (1 | 2 | 3 | 4) | null;
             needsKyc?: boolean;
             /**
              * Price a NEW number of this type costs per month, in cents.
@@ -26335,6 +26405,14 @@ type ListPhoneNumberCountriesResponse = ({
             smsAvailable?: boolean;
             callsAvailable?: boolean;
             inStock?: boolean;
+            /**
+             * `request`: the carrier stocks this type nowhere and only sources it to order, so it is always a pre-order.
+             */
+            fulfilment?: 'instant' | 'request';
+            /**
+             * Out of stock but orderable anyway. Submit KYC as usual (POST /v1/phone-numbers/kyc) and the carrier sources the number after review, usually about 3 weeks and never guaranteed. Only document tiers (3/4) qualify, and nothing is billed until the number is active.
+             */
+            preOrderable?: boolean;
         }>;
     }>;
 });
@@ -26408,6 +26486,10 @@ type CheckPhoneNumberAvailabilityResponse = ({
      * Whether deliverable voice inventory exists right now.
      */
     available?: boolean;
+    /**
+     * Nothing deliverable now, but this pair can be pre-ordered: submit KYC as usual and the carrier sources the number after review (usually about 3 weeks, never guaranteed). Only document tiers (3/4) qualify.
+     */
+    preOrderable?: boolean;
     addressConstraint?: 'geo' | 'country' | 'none';
     /**
      * For `geo` only: the area(s) the registered address must be in.
@@ -26672,6 +26754,10 @@ type CheckWhatsAppNumberAvailabilityResponse = ({
      * Whether deliverable voice inventory exists right now.
      */
     available?: boolean;
+    /**
+     * Nothing deliverable now, but this pair can be pre-ordered: submit KYC as usual and the carrier sources the number after review (usually about 3 weeks, never guaranteed). Only document tiers (3/4) qualify.
+     */
+    preOrderable?: boolean;
     addressConstraint?: 'geo' | 'country' | 'none';
     /**
      * For `geo` only: the area(s) the registered address must be in.
@@ -26853,6 +26939,10 @@ type SubmitPhoneNumberKycData = {
 };
 type SubmitPhoneNumberKycResponse = ({
     status?: 'kyc_submitted' | 'kyc_reused' | 'kyc_already_submitted';
+    /**
+     * True when nothing was in stock and this submission placed a pre-order. The number stays `pending_regulatory` until the carrier sources it (usually about 3 weeks) and is not billed until active. A pre-order is one number: `quantity` above 1 is rejected with 400.
+     */
+    preOrder?: boolean;
     /**
      * The first/primary number, kept at the top level for backward compatibility. See `numbers` for the full set when `quantity` > 1.
      */
@@ -27613,6 +27703,10 @@ type SubmitWhatsAppNumberKycData = {
 };
 type SubmitWhatsAppNumberKycResponse = ({
     status?: 'kyc_submitted' | 'kyc_reused' | 'kyc_already_submitted';
+    /**
+     * True when nothing was in stock and this submission placed a pre-order. The number stays `pending_regulatory` until the carrier sources it (usually about 3 weeks) and is not billed until active. A pre-order is one number: `quantity` above 1 is rejected with 400.
+     */
+    preOrder?: boolean;
     /**
      * The first/primary number, kept at the top level for backward compatibility. See `numbers` for the full set when `quantity` > 1.
      */

package/dist/index.js

@@ -36,7 +36,7 @@ module.exports = __toCommonJS(index_exports);
 // package.json
 var package_default = {
   name: "@zernio/node",
-  version: "0.2.734",
+  version: "0.2.736",
   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.734",
+  version: "0.2.736",
   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.734",
+  "version": "0.2.736",
   "description": "The official Node.js library for the Zernio API",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

package/src/generated/sdk.gen.ts

@@ -6483,9 +6483,9 @@ export const disableVoiceOnNumber = <ThrowOnError extends boolean = false>(optio
  * it if you miss the stock. Up to 20 watches at once.
  *
  * Countries and types marked `fulfilment: request` by
- * GET /v1/phone-numbers/countries can also be watched. Those are sourced
- * by a carrier request rather than held in stock, so a watch records
- * interest and no date is implied.
+ * GET /v1/phone-numbers/countries can also be watched, but anything with
+ * `preOrderable: true` does not need a watch: submit KYC and the carrier
+ * sources the number to order.
  *
  */
 export const createPhoneNumberStockWatch = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<CreatePhoneNumberStockWatchData, ThrowOnError>) => {

package/src/generated/types.gen.ts

@@ -9061,6 +9061,30 @@ export type WebhookPayloadMessage = {
              */
             product_retailer_id?: string;
         };
+        /**
+         * WhatsApp only. The location pin the user shared, forwarded
+         * verbatim from Meta. The message `text` is only the emoji preview
+         * (`📍 <name>`); the coordinates live here.
+         *
+         */
+        location?: {
+            /**
+             * Latitude in decimal degrees.
+             */
+            latitude?: number;
+            /**
+             * Longitude in decimal degrees.
+             */
+            longitude?: number;
+            /**
+             * Location name, when the user shared a named place.
+             */
+            name?: string;
+            /**
+             * Street address, when Meta sends one.
+             */
+            address?: string;
+        };
         /**
          * WhatsApp only. Contact cards the user shared, forwarded verbatim
          * from Meta. Read `contactsOrigin` before treating any number here
@@ -9498,9 +9522,48 @@ export type WebhookPayloadMessageSent = {
     conversation: InboxWebhookConversation;
     account: InboxWebhookAccount;
     /**
-     * Platform-specific context for the sent message. The key is present only when the send carried some context, and absent otherwise: it is never null and never an empty object.
+     * Platform-specific context for the sent message: a quote-reply reference, a WhatsApp location pin or WhatsApp contact cards. The key is present only when the send carried some context, and absent otherwise: it is never null and never an empty object. Read it to tell a location or contact-card message from a text one without a GET on the message.
      */
     metadata?: {
+        /**
+         * WhatsApp only. The location pin this message carries, in the same
+         * shape the inbox send API accepts. Present on API sends that passed
+         * `location`, and on Coexistence echoes of a pin shared from the
+         * WhatsApp Business app. The message `text` is only the emoji
+         * preview (`📍 <name>`); the pin itself lives here.
+         *
+         */
+        location?: {
+            /**
+             * Latitude in decimal degrees.
+             */
+            latitude?: number;
+            /**
+             * Longitude in decimal degrees.
+             */
+            longitude?: number;
+            /**
+             * Location name, when one was given.
+             */
+            name?: string;
+            /**
+             * Street address, when one was given.
+             */
+            address?: string;
+        };
+        /**
+         * WhatsApp only. The contact cards this message carries. On API
+         * sends this is the `contacts` array exactly as given to the inbox
+         * send API (`name`, `phones[].phone` / `type`, `emails[]`); on
+         * Coexistence echoes of a card shared from the WhatsApp Business
+         * app it is Meta's shape (`phones[].wa_id`, `vcard`). The message
+         * `text` is only the emoji preview (`👤 <name>`); the cards live
+         * here.
+         *
+         */
+        contacts?: Array<{
+            [key: string]: unknown;
+        }>;
         /**
          * `platformMessageId` of the message this send is a quote-reply to.
          *
@@ -26193,13 +26256,20 @@ export type ListPhoneNumberCountriesResponse = ({
          * Live carrier-stock snapshot (refreshed every 6h + on availability checks): false when NO offered type currently has deliverable inventory, so a purchase would fail. Treat as advisory; the purchase itself re-checks.
          */
         inStock?: boolean;
+        /**
+         * At least one out-of-stock type here can be pre-ordered (see `types[].preOrderable`).
+         */
+        preOrderable?: boolean;
         /**
          * Every number type offered in this country (default first). Capabilities, KYC tier, monthly price, and stock are per type. The country-level fields above mirror the first (default) entry. Pass the chosen `numberType` to POST /v1/phone-numbers/purchase.
          *
          */
         types?: Array<{
             numberType?: 'local' | 'mobile' | 'national' | 'toll_free';
-            tier?: 1 | 2 | 3 | 4;
+            /**
+             * Null on a `fulfilment: request` type, whose document tier is only known once its requirements are read.
+             */
+            tier?: (1 | 2 | 3 | 4) | null;
             needsKyc?: boolean;
             /**
              * Price a NEW number of this type costs per month, in cents.
@@ -26212,6 +26282,14 @@ export type ListPhoneNumberCountriesResponse = ({
             smsAvailable?: boolean;
             callsAvailable?: boolean;
             inStock?: boolean;
+            /**
+             * `request`: the carrier stocks this type nowhere and only sources it to order, so it is always a pre-order.
+             */
+            fulfilment?: 'instant' | 'request';
+            /**
+             * Out of stock but orderable anyway. Submit KYC as usual (POST /v1/phone-numbers/kyc) and the carrier sources the number after review, usually about 3 weeks and never guaranteed. Only document tiers (3/4) qualify, and nothing is billed until the number is active.
+             */
+            preOrderable?: boolean;
         }>;
     }>;
 });
@@ -26291,6 +26369,10 @@ export type CheckPhoneNumberAvailabilityResponse = ({
      * Whether deliverable voice inventory exists right now.
      */
     available?: boolean;
+    /**
+     * Nothing deliverable now, but this pair can be pre-ordered: submit KYC as usual and the carrier sources the number after review (usually about 3 weeks, never guaranteed). Only document tiers (3/4) qualify.
+     */
+    preOrderable?: boolean;
     addressConstraint?: 'geo' | 'country' | 'none';
     /**
      * For `geo` only: the area(s) the registered address must be in.
@@ -26569,6 +26651,10 @@ export type CheckWhatsAppNumberAvailabilityResponse = ({
      * Whether deliverable voice inventory exists right now.
      */
     available?: boolean;
+    /**
+     * Nothing deliverable now, but this pair can be pre-ordered: submit KYC as usual and the carrier sources the number after review (usually about 3 weeks, never guaranteed). Only document tiers (3/4) qualify.
+     */
+    preOrderable?: boolean;
     addressConstraint?: 'geo' | 'country' | 'none';
     /**
      * For `geo` only: the area(s) the registered address must be in.
@@ -26756,6 +26842,10 @@ export type SubmitPhoneNumberKycData = {
 
 export type SubmitPhoneNumberKycResponse = ({
     status?: 'kyc_submitted' | 'kyc_reused' | 'kyc_already_submitted';
+    /**
+     * True when nothing was in stock and this submission placed a pre-order. The number stays `pending_regulatory` until the carrier sources it (usually about 3 weeks) and is not billed until active. A pre-order is one number: `quantity` above 1 is rejected with 400.
+     */
+    preOrder?: boolean;
     /**
      * The first/primary number, kept at the top level for backward compatibility. See `numbers` for the full set when `quantity` > 1.
      */
@@ -27569,6 +27659,10 @@ export type SubmitWhatsAppNumberKycData = {
 
 export type SubmitWhatsAppNumberKycResponse = ({
     status?: 'kyc_submitted' | 'kyc_reused' | 'kyc_already_submitted';
+    /**
+     * True when nothing was in stock and this submission placed a pre-order. The number stays `pending_regulatory` until the carrier sources it (usually about 3 weeks) and is not billed until active. A pre-order is one number: `quantity` above 1 is rejected with 400.
+     */
+    preOrder?: boolean;
     /**
      * The first/primary number, kept at the top level for backward compatibility. See `numbers` for the full set when `quantity` > 1.
      */