@zernio/node 0.2.785 → 0.2.787

package/dist/index.d.mts

@@ -7444,6 +7444,10 @@ type PhoneNumberStockWatch = {
      * The watched number type, or null when the watch covers every type in the country.
      */
     numberType: ('local' | 'mobile' | 'national' | 'toll_free') | null;
+    /**
+     * The watched area code (NDC), or null when the watch covers every area.
+     */
+    areaCode?: (string) | null;
     createdAt: string;
 };
 /**
@@ -11281,6 +11285,14 @@ type WebhookPayloadPhoneNumberStockAvailable = {
              */
             availableCount: number;
         }>;
+        /**
+         * Set when the watch named an area: the area code (NDC) that is back in stock.
+         */
+        areaCode?: string;
+        /**
+         * The name of that area, when known.
+         */
+        areaName?: string;
     };
     /**
      * UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
@@ -27323,6 +27335,24 @@ type CheckPhoneNumberAvailabilityResponse = ({
          */
         count?: number;
     }>;
+    /**
+     * Areas that had stock in the last 90 days and have none now. Pass one as `areaCode` with `preOrder: true` on the KYC submit when `preOrderable` is true, or watch it with POST /v1/phone-numbers/stock-watches.
+     *
+     */
+    soldOutAreas?: Array<{
+        /**
+         * Area code (national destination code).
+         */
+        ndc?: string;
+        /**
+         * Area name.
+         */
+        name?: string;
+        /**
+         * Whether this area can be pre-ordered: the carrier sources a number in it (usually 2 to 4 weeks, never guaranteed).
+         */
+        preOrderable?: boolean;
+    }>;
 });
 type CheckPhoneNumberAvailabilityError = (unknown | {
     error?: string;
@@ -27598,6 +27628,24 @@ type CheckWhatsAppNumberAvailabilityResponse = ({
          */
         count?: number;
     }>;
+    /**
+     * Areas that had stock in the last 90 days and have none now. Pass one as `areaCode` with `preOrder: true` on the KYC submit when `preOrderable` is true, or watch it with POST /v1/phone-numbers/stock-watches.
+     *
+     */
+    soldOutAreas?: Array<{
+        /**
+         * Area code (national destination code).
+         */
+        ndc?: string;
+        /**
+         * Area name.
+         */
+        name?: string;
+        /**
+         * Whether this area can be pre-ordered: the carrier sources a number in it (usually 2 to 4 weeks, never guaranteed).
+         */
+        preOrderable?: boolean;
+    }>;
 });
 type CheckWhatsAppNumberAvailabilityError = (unknown | {
     error?: string;
@@ -27709,6 +27757,10 @@ type SubmitPhoneNumberKycData = {
          * Area code (NDC) the number must be in. Hard constraint: an empty area pool fails with 409 code AREA_CODE_UNAVAILABLE instead of ordering from another area. Omit for any area. Options come from GET /v1/phone-numbers/availability (areaOptions); the purchase 202 kycUrl echoes the areaCode picked at purchase time so it can be passed here.
          */
         areaCode?: string;
+        /**
+         * With areaCode: pre-order that area when it has no stock (an area listed in soldOutAreas with preOrderable true) instead of failing with AREA_CODE_UNAVAILABLE. The carrier sources a number in that area.
+         */
+        preOrder?: boolean;
         /**
          * End user's legal first name. Required when the country has an action/ID-verification (Onfido) requirement.
          */
@@ -27736,6 +27788,10 @@ type SubmitPhoneNumberKycData = {
              * Id from POST /v1/phone-numbers/kyc/upload-document.
              */
             documentId: string;
+            /**
+             * Date printed on the document (YYYY-MM-DD), for slots the regulator windows such as proof of address. The pre-submit review trusts it over its own read of the PDF.
+             */
+            issuedAt?: string;
         })>;
         address?: {
             requirementId?: string;
@@ -28199,6 +28255,10 @@ type ReviewPhoneNumberKycPacketData = {
              * Id from POST /v1/phone-numbers/kyc/upload-document.
              */
             documentId: string;
+            /**
+             * Date printed on the document (YYYY-MM-DD), for slots the regulator windows such as proof of address. The pre-submit review trusts it over its own read of the PDF.
+             */
+            issuedAt?: string;
         }>;
     };
 };
@@ -28321,6 +28381,10 @@ type RespondToPhoneNumberReviewerData = {
              * Id of a document already uploaded out-of-band.
              */
             documentId?: string;
+            /**
+             * Date printed on the document (YYYY-MM-DD), for slots the regulator windows such as proof of address. The pre-submit review trusts it over its own read of the PDF.
+             */
+            issuedAt?: string;
         }>;
         /**
          * A corrected address record, keyed to its requirement.
@@ -28473,6 +28537,10 @@ type SubmitWhatsAppNumberKycData = {
          * Area code (NDC) the number must be in. Hard constraint: an empty area pool fails with 409 code AREA_CODE_UNAVAILABLE instead of ordering from another area. Omit for any area. Options come from GET /v1/phone-numbers/availability (areaOptions); the purchase 202 kycUrl echoes the areaCode picked at purchase time so it can be passed here.
          */
         areaCode?: string;
+        /**
+         * With areaCode: pre-order that area when it has no stock (an area listed in soldOutAreas with preOrderable true) instead of failing with AREA_CODE_UNAVAILABLE. The carrier sources a number in that area.
+         */
+        preOrder?: boolean;
         /**
          * End user's legal first name. Required when the country has an action/ID-verification (Onfido) requirement.
          */
@@ -28859,6 +28927,10 @@ type CreatePhoneNumberStockWatchData = {
          * Narrow the watch to one number type. Omit to be notified when any type in the country is back.
          */
         numberType?: 'local' | 'mobile' | 'national' | 'toll_free';
+        /**
+         * Narrow the watch to one area code (NDC). Requires numberType.
+         */
+        areaCode?: string;
     };
 };
 type CreatePhoneNumberStockWatchResponse = (PhoneNumberStockWatch);

package/dist/index.d.ts

@@ -7444,6 +7444,10 @@ type PhoneNumberStockWatch = {
      * The watched number type, or null when the watch covers every type in the country.
      */
     numberType: ('local' | 'mobile' | 'national' | 'toll_free') | null;
+    /**
+     * The watched area code (NDC), or null when the watch covers every area.
+     */
+    areaCode?: (string) | null;
     createdAt: string;
 };
 /**
@@ -11281,6 +11285,14 @@ type WebhookPayloadPhoneNumberStockAvailable = {
              */
             availableCount: number;
         }>;
+        /**
+         * Set when the watch named an area: the area code (NDC) that is back in stock.
+         */
+        areaCode?: string;
+        /**
+         * The name of that area, when known.
+         */
+        areaName?: string;
     };
     /**
      * UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
@@ -27323,6 +27335,24 @@ type CheckPhoneNumberAvailabilityResponse = ({
          */
         count?: number;
     }>;
+    /**
+     * Areas that had stock in the last 90 days and have none now. Pass one as `areaCode` with `preOrder: true` on the KYC submit when `preOrderable` is true, or watch it with POST /v1/phone-numbers/stock-watches.
+     *
+     */
+    soldOutAreas?: Array<{
+        /**
+         * Area code (national destination code).
+         */
+        ndc?: string;
+        /**
+         * Area name.
+         */
+        name?: string;
+        /**
+         * Whether this area can be pre-ordered: the carrier sources a number in it (usually 2 to 4 weeks, never guaranteed).
+         */
+        preOrderable?: boolean;
+    }>;
 });
 type CheckPhoneNumberAvailabilityError = (unknown | {
     error?: string;
@@ -27598,6 +27628,24 @@ type CheckWhatsAppNumberAvailabilityResponse = ({
          */
         count?: number;
     }>;
+    /**
+     * Areas that had stock in the last 90 days and have none now. Pass one as `areaCode` with `preOrder: true` on the KYC submit when `preOrderable` is true, or watch it with POST /v1/phone-numbers/stock-watches.
+     *
+     */
+    soldOutAreas?: Array<{
+        /**
+         * Area code (national destination code).
+         */
+        ndc?: string;
+        /**
+         * Area name.
+         */
+        name?: string;
+        /**
+         * Whether this area can be pre-ordered: the carrier sources a number in it (usually 2 to 4 weeks, never guaranteed).
+         */
+        preOrderable?: boolean;
+    }>;
 });
 type CheckWhatsAppNumberAvailabilityError = (unknown | {
     error?: string;
@@ -27709,6 +27757,10 @@ type SubmitPhoneNumberKycData = {
          * Area code (NDC) the number must be in. Hard constraint: an empty area pool fails with 409 code AREA_CODE_UNAVAILABLE instead of ordering from another area. Omit for any area. Options come from GET /v1/phone-numbers/availability (areaOptions); the purchase 202 kycUrl echoes the areaCode picked at purchase time so it can be passed here.
          */
         areaCode?: string;
+        /**
+         * With areaCode: pre-order that area when it has no stock (an area listed in soldOutAreas with preOrderable true) instead of failing with AREA_CODE_UNAVAILABLE. The carrier sources a number in that area.
+         */
+        preOrder?: boolean;
         /**
          * End user's legal first name. Required when the country has an action/ID-verification (Onfido) requirement.
          */
@@ -27736,6 +27788,10 @@ type SubmitPhoneNumberKycData = {
              * Id from POST /v1/phone-numbers/kyc/upload-document.
              */
             documentId: string;
+            /**
+             * Date printed on the document (YYYY-MM-DD), for slots the regulator windows such as proof of address. The pre-submit review trusts it over its own read of the PDF.
+             */
+            issuedAt?: string;
         })>;
         address?: {
             requirementId?: string;
@@ -28199,6 +28255,10 @@ type ReviewPhoneNumberKycPacketData = {
              * Id from POST /v1/phone-numbers/kyc/upload-document.
              */
             documentId: string;
+            /**
+             * Date printed on the document (YYYY-MM-DD), for slots the regulator windows such as proof of address. The pre-submit review trusts it over its own read of the PDF.
+             */
+            issuedAt?: string;
         }>;
     };
 };
@@ -28321,6 +28381,10 @@ type RespondToPhoneNumberReviewerData = {
              * Id of a document already uploaded out-of-band.
              */
             documentId?: string;
+            /**
+             * Date printed on the document (YYYY-MM-DD), for slots the regulator windows such as proof of address. The pre-submit review trusts it over its own read of the PDF.
+             */
+            issuedAt?: string;
         }>;
         /**
          * A corrected address record, keyed to its requirement.
@@ -28473,6 +28537,10 @@ type SubmitWhatsAppNumberKycData = {
          * Area code (NDC) the number must be in. Hard constraint: an empty area pool fails with 409 code AREA_CODE_UNAVAILABLE instead of ordering from another area. Omit for any area. Options come from GET /v1/phone-numbers/availability (areaOptions); the purchase 202 kycUrl echoes the areaCode picked at purchase time so it can be passed here.
          */
         areaCode?: string;
+        /**
+         * With areaCode: pre-order that area when it has no stock (an area listed in soldOutAreas with preOrderable true) instead of failing with AREA_CODE_UNAVAILABLE. The carrier sources a number in that area.
+         */
+        preOrder?: boolean;
         /**
          * End user's legal first name. Required when the country has an action/ID-verification (Onfido) requirement.
          */
@@ -28859,6 +28927,10 @@ type CreatePhoneNumberStockWatchData = {
          * Narrow the watch to one number type. Omit to be notified when any type in the country is back.
          */
         numberType?: 'local' | 'mobile' | 'national' | 'toll_free';
+        /**
+         * Narrow the watch to one area code (NDC). Requires numberType.
+         */
+        areaCode?: string;
     };
 };
 type CreatePhoneNumberStockWatchResponse = (PhoneNumberStockWatch);

package/dist/index.js

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

package/src/generated/sdk.gen.ts

@@ -6642,6 +6642,11 @@ export const disableVoiceOnNumber = <ThrowOnError extends boolean = false>(optio
  * `preOrderable: true` does not need a watch: submit KYC and the carrier
  * sources the number to order.
  *
+ * Pass `areaCode` (with `numberType`) to watch one sold-out area, for
+ * example an entry of `soldOutAreas` from
+ * GET /v1/phone-numbers/availability. Area stock is checked live on the
+ * same 6h cadence.
+ *
  */
 export const createPhoneNumberStockWatch = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<CreatePhoneNumberStockWatchData, ThrowOnError>) => {
     return (options?.client ?? client).post<CreatePhoneNumberStockWatchResponse, CreatePhoneNumberStockWatchError, ThrowOnError>({

package/src/generated/types.gen.ts

@@ -6059,6 +6059,10 @@ export type PhoneNumberStockWatch = {
      * The watched number type, or null when the watch covers every type in the country.
      */
     numberType: ('local' | 'mobile' | 'national' | 'toll_free') | null;
+    /**
+     * The watched area code (NDC), or null when the watch covers every area.
+     */
+    areaCode?: (string) | null;
     createdAt: string;
 };
 
@@ -10042,6 +10046,14 @@ export type WebhookPayloadPhoneNumberStockAvailable = {
              */
             availableCount: number;
         }>;
+        /**
+         * Set when the watch named an area: the area code (NDC) that is back in stock.
+         */
+        areaCode?: string;
+        /**
+         * The name of that area, when known.
+         */
+        areaName?: string;
     };
     /**
      * UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
@@ -27179,6 +27191,24 @@ export type CheckPhoneNumberAvailabilityResponse = ({
          */
         count?: number;
     }>;
+    /**
+     * Areas that had stock in the last 90 days and have none now. Pass one as `areaCode` with `preOrder: true` on the KYC submit when `preOrderable` is true, or watch it with POST /v1/phone-numbers/stock-watches.
+     *
+     */
+    soldOutAreas?: Array<{
+        /**
+         * Area code (national destination code).
+         */
+        ndc?: string;
+        /**
+         * Area name.
+         */
+        name?: string;
+        /**
+         * Whether this area can be pre-ordered: the carrier sources a number in it (usually 2 to 4 weeks, never guaranteed).
+         */
+        preOrderable?: boolean;
+    }>;
 });
 
 export type CheckPhoneNumberAvailabilityError = (unknown | {
@@ -27468,6 +27498,24 @@ export type CheckWhatsAppNumberAvailabilityResponse = ({
          */
         count?: number;
     }>;
+    /**
+     * Areas that had stock in the last 90 days and have none now. Pass one as `areaCode` with `preOrder: true` on the KYC submit when `preOrderable` is true, or watch it with POST /v1/phone-numbers/stock-watches.
+     *
+     */
+    soldOutAreas?: Array<{
+        /**
+         * Area code (national destination code).
+         */
+        ndc?: string;
+        /**
+         * Area name.
+         */
+        name?: string;
+        /**
+         * Whether this area can be pre-ordered: the carrier sources a number in it (usually 2 to 4 weeks, never guaranteed).
+         */
+        preOrderable?: boolean;
+    }>;
 });
 
 export type CheckWhatsAppNumberAvailabilityError = (unknown | {
@@ -27584,6 +27632,10 @@ export type SubmitPhoneNumberKycData = {
          * Area code (NDC) the number must be in. Hard constraint: an empty area pool fails with 409 code AREA_CODE_UNAVAILABLE instead of ordering from another area. Omit for any area. Options come from GET /v1/phone-numbers/availability (areaOptions); the purchase 202 kycUrl echoes the areaCode picked at purchase time so it can be passed here.
          */
         areaCode?: string;
+        /**
+         * With areaCode: pre-order that area when it has no stock (an area listed in soldOutAreas with preOrderable true) instead of failing with AREA_CODE_UNAVAILABLE. The carrier sources a number in that area.
+         */
+        preOrder?: boolean;
         /**
          * End user's legal first name. Required when the country has an action/ID-verification (Onfido) requirement.
          */
@@ -27611,6 +27663,10 @@ export type SubmitPhoneNumberKycData = {
      * Id from POST /v1/phone-numbers/kyc/upload-document.
      */
     documentId: string;
+    /**
+     * Date printed on the document (YYYY-MM-DD), for slots the regulator windows such as proof of address. The pre-submit review trusts it over its own read of the PDF.
+     */
+    issuedAt?: string;
 })>;
         address?: {
             requirementId?: string;
@@ -28109,6 +28165,10 @@ export type ReviewPhoneNumberKycPacketData = {
              * Id from POST /v1/phone-numbers/kyc/upload-document.
              */
             documentId: string;
+            /**
+             * Date printed on the document (YYYY-MM-DD), for slots the regulator windows such as proof of address. The pre-submit review trusts it over its own read of the PDF.
+             */
+            issuedAt?: string;
         }>;
     };
 };
@@ -28243,6 +28303,10 @@ export type RespondToPhoneNumberReviewerData = {
              * Id of a document already uploaded out-of-band.
              */
             documentId?: string;
+            /**
+             * Date printed on the document (YYYY-MM-DD), for slots the regulator windows such as proof of address. The pre-submit review trusts it over its own read of the PDF.
+             */
+            issuedAt?: string;
         }>;
         /**
          * A corrected address record, keyed to its requirement.
@@ -28401,6 +28465,10 @@ export type SubmitWhatsAppNumberKycData = {
          * Area code (NDC) the number must be in. Hard constraint: an empty area pool fails with 409 code AREA_CODE_UNAVAILABLE instead of ordering from another area. Omit for any area. Options come from GET /v1/phone-numbers/availability (areaOptions); the purchase 202 kycUrl echoes the areaCode picked at purchase time so it can be passed here.
          */
         areaCode?: string;
+        /**
+         * With areaCode: pre-order that area when it has no stock (an area listed in soldOutAreas with preOrderable true) instead of failing with AREA_CODE_UNAVAILABLE. The carrier sources a number in that area.
+         */
+        preOrder?: boolean;
         /**
          * End user's legal first name. Required when the country has an action/ID-verification (Onfido) requirement.
          */
@@ -28814,6 +28882,10 @@ export type CreatePhoneNumberStockWatchData = {
          * Narrow the watch to one number type. Omit to be notified when any type in the country is back.
          */
         numberType?: 'local' | 'mobile' | 'national' | 'toll_free';
+        /**
+         * Narrow the watch to one area code (NDC). Requires numberType.
+         */
+        areaCode?: string;
     };
 };