@zernio/node 0.2.1008 → 0.2.1009

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.d.mts CHANGED
@@ -808,7 +808,7 @@ declare class Zernio {
808
808
  remediatePhoneNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<RemediatePhoneNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RemediatePhoneNumberResponse, unknown, ThrowOnError>;
809
809
  replyToPhoneNumberReviewer: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ReplyToPhoneNumberReviewerData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ReplyToPhoneNumberReviewerResponse, unknown, ThrowOnError>;
810
810
  respondToPhoneNumberReviewer: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<RespondToPhoneNumberReviewerData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RespondToPhoneNumberReviewerResponse, unknown, ThrowOnError>;
811
- createPhoneNumberStockWatch: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreatePhoneNumberStockWatchData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<PhoneNumberStockWatch, unknown, ThrowOnError>;
811
+ createPhoneNumberStockWatch: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreatePhoneNumberStockWatchData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreatePhoneNumberStockWatchResponse, unknown, ThrowOnError>;
812
812
  listPhoneNumberStockWatches: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<unknown, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListPhoneNumberStockWatchesResponse, ListPhoneNumberStockWatchesError, ThrowOnError>;
813
813
  deletePhoneNumberStockWatch: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeletePhoneNumberStockWatchData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeletePhoneNumberStockWatchResponse, unknown, ThrowOnError>;
814
814
  };
@@ -32717,7 +32717,7 @@ type CheckPhoneNumberAvailabilityResponse = ({
32717
32717
  */
32718
32718
  areas?: Array<(string)>;
32719
32719
  /**
32720
- * Live inventory grouped by area code. For US and CA this is the full country inventory (every area code with stock, recognizable metros listed first, then alphabetical); other countries are ordered largest stock first; they list the areas in the latest inventory page (up to 500 numbers, which for most countries is the entire pool). Empty when out of stock (or the area lookup failed). Pass a chosen `ndc` as `areaCode` on POST /v1/phone-numbers/purchase (or on the KYC submit for regulated countries) to require that area.
32720
+ * Live inventory grouped by area code. For US and CA this is the full country inventory (every area code with stock, recognizable metros listed first, then alphabetical); other countries are ordered largest stock first; they list the areas in the latest inventory page (up to 500 numbers, which for most countries is the entire pool). Empty when out of stock (or the area lookup failed). Pass a chosen `ndc` as `areaCode` on POST /v1/phone-numbers/purchase (or on the KYC submit for regulated countries) to require that area. Equal to `areaAvailability.inStock`.
32721
32721
  *
32722
32722
  */
32723
32723
  areaOptions?: Array<{
@@ -32735,7 +32735,7 @@ type CheckPhoneNumberAvailabilityResponse = ({
32735
32735
  count?: number;
32736
32736
  }>;
32737
32737
  /**
32738
- * 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.
32738
+ * Every area of the country's numbering plan with nothing deliverable now: `areaAvailability.preOrder` plus `areaAvailability.outOfStock`, kept for older clients. 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.
32739
32739
  *
32740
32740
  */
32741
32741
  soldOutAreas?: Array<{
@@ -32752,6 +32752,38 @@ type CheckPhoneNumberAvailabilityResponse = ({
32752
32752
  */
32753
32753
  preOrderable?: boolean;
32754
32754
  }>;
32755
+ /**
32756
+ * Every area of the country's numbering plan (Google libphonenumber geocoding, one row per city: Madrid covers 910 to 919), in one of three states, refreshed every 6 hours from the carrier's own inventory counts. The same answer the dashboard picker and the public country pages show. Empty lists mean the pair has no cached coverage yet, not that the country has no areas.
32757
+ *
32758
+ */
32759
+ areaAvailability?: {
32760
+ /**
32761
+ * Deliverable numbers now, deepest first. Pass `ndc` as `areaCode` to hold the order to it.
32762
+ */
32763
+ inStock?: Array<{
32764
+ ndc?: string;
32765
+ name?: string;
32766
+ /**
32767
+ * Numbers we can sell there: the carrier count minus the numbers we hold back (WhatsApp refused them or another order holds them).
32768
+ */
32769
+ count?: number;
32770
+ }>;
32771
+ /**
32772
+ * The carrier lists nothing there and the number type is a document tier: submit KYC with `areaCode` and `preOrder: true`, the carrier sources one (usually 2 to 4 weeks, never guaranteed), nothing is billed until it is active.
32773
+ */
32774
+ preOrder?: Array<{
32775
+ ndc?: string;
32776
+ name?: string;
32777
+ }>;
32778
+ /**
32779
+ * Nothing deliverable and no pre-order: `listed` > 0 is stock the carrier shows that WhatsApp refused recently (held back until it clears), 0 is a dry area of an instant tier. A stock watch (POST /v1/phone-numbers/stock-watches with `areaCode`) is the way to hear when it is back.
32780
+ */
32781
+ outOfStock?: Array<{
32782
+ ndc?: string;
32783
+ name?: string;
32784
+ listed?: number;
32785
+ }>;
32786
+ };
32755
32787
  });
32756
32788
  type CheckPhoneNumberAvailabilityError = (unknown | {
32757
32789
  error?: string;
@@ -32987,7 +33019,7 @@ type CheckWhatsAppNumberAvailabilityResponse = ({
32987
33019
  */
32988
33020
  areas?: Array<(string)>;
32989
33021
  /**
32990
- * Live inventory grouped by area code. For US and CA this is the full country inventory (every area code with stock, recognizable metros listed first, then alphabetical); other countries are ordered largest stock first; they list the areas in the latest inventory page (up to 500 numbers, which for most countries is the entire pool). Empty when out of stock (or the area lookup failed). Pass a chosen `ndc` as `areaCode` on POST /v1/phone-numbers/purchase (or on the KYC submit for regulated countries) to require that area.
33022
+ * Live inventory grouped by area code. For US and CA this is the full country inventory (every area code with stock, recognizable metros listed first, then alphabetical); other countries are ordered largest stock first; they list the areas in the latest inventory page (up to 500 numbers, which for most countries is the entire pool). Empty when out of stock (or the area lookup failed). Pass a chosen `ndc` as `areaCode` on POST /v1/phone-numbers/purchase (or on the KYC submit for regulated countries) to require that area. Equal to `areaAvailability.inStock`.
32991
33023
  *
32992
33024
  */
32993
33025
  areaOptions?: Array<{
@@ -33005,7 +33037,7 @@ type CheckWhatsAppNumberAvailabilityResponse = ({
33005
33037
  count?: number;
33006
33038
  }>;
33007
33039
  /**
33008
- * 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.
33040
+ * Every area of the country's numbering plan with nothing deliverable now: `areaAvailability.preOrder` plus `areaAvailability.outOfStock`, kept for older clients. 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.
33009
33041
  *
33010
33042
  */
33011
33043
  soldOutAreas?: Array<{
@@ -33022,6 +33054,38 @@ type CheckWhatsAppNumberAvailabilityResponse = ({
33022
33054
  */
33023
33055
  preOrderable?: boolean;
33024
33056
  }>;
33057
+ /**
33058
+ * Every area of the country's numbering plan (Google libphonenumber geocoding, one row per city: Madrid covers 910 to 919), in one of three states, refreshed every 6 hours from the carrier's own inventory counts. The same answer the dashboard picker and the public country pages show. Empty lists mean the pair has no cached coverage yet, not that the country has no areas.
33059
+ *
33060
+ */
33061
+ areaAvailability?: {
33062
+ /**
33063
+ * Deliverable numbers now, deepest first. Pass `ndc` as `areaCode` to hold the order to it.
33064
+ */
33065
+ inStock?: Array<{
33066
+ ndc?: string;
33067
+ name?: string;
33068
+ /**
33069
+ * Numbers we can sell there: the carrier count minus the numbers we hold back (WhatsApp refused them or another order holds them).
33070
+ */
33071
+ count?: number;
33072
+ }>;
33073
+ /**
33074
+ * The carrier lists nothing there and the number type is a document tier: submit KYC with `areaCode` and `preOrder: true`, the carrier sources one (usually 2 to 4 weeks, never guaranteed), nothing is billed until it is active.
33075
+ */
33076
+ preOrder?: Array<{
33077
+ ndc?: string;
33078
+ name?: string;
33079
+ }>;
33080
+ /**
33081
+ * Nothing deliverable and no pre-order: `listed` > 0 is stock the carrier shows that WhatsApp refused recently (held back until it clears), 0 is a dry area of an instant tier. A stock watch (POST /v1/phone-numbers/stock-watches with `areaCode`) is the way to hear when it is back.
33082
+ */
33083
+ outOfStock?: Array<{
33084
+ ndc?: string;
33085
+ name?: string;
33086
+ listed?: number;
33087
+ }>;
33088
+ };
33025
33089
  });
33026
33090
  type CheckWhatsAppNumberAvailabilityError = (unknown | {
33027
33091
  error?: string;
@@ -34355,7 +34419,17 @@ type CreatePhoneNumberStockWatchData = {
34355
34419
  areaCode?: string;
34356
34420
  };
34357
34421
  };
34358
- type CreatePhoneNumberStockWatchResponse = (PhoneNumberStockWatch);
34422
+ type CreatePhoneNumberStockWatchResponse = ((PhoneNumberStockWatch & {
34423
+ /**
34424
+ * See the 201 response.
34425
+ */
34426
+ preOrderable?: boolean;
34427
+ }) | (PhoneNumberStockWatch & {
34428
+ /**
34429
+ * True when the watched area can be bought today as a pre-order (the carrier lists nothing there and the type is a document tier): submit KYC with `areaCode` and `preOrder: true` instead of waiting, usually 2 to 4 weeks, nothing billed until active. The watch is armed either way.
34430
+ */
34431
+ preOrderable?: boolean;
34432
+ }));
34359
34433
  type CreatePhoneNumberStockWatchError = (ErrorResponse | {
34360
34434
  error?: string;
34361
34435
  } | unknown);
package/dist/index.d.ts CHANGED
@@ -808,7 +808,7 @@ declare class Zernio {
808
808
  remediatePhoneNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<RemediatePhoneNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RemediatePhoneNumberResponse, unknown, ThrowOnError>;
809
809
  replyToPhoneNumberReviewer: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ReplyToPhoneNumberReviewerData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ReplyToPhoneNumberReviewerResponse, unknown, ThrowOnError>;
810
810
  respondToPhoneNumberReviewer: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<RespondToPhoneNumberReviewerData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RespondToPhoneNumberReviewerResponse, unknown, ThrowOnError>;
811
- createPhoneNumberStockWatch: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreatePhoneNumberStockWatchData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<PhoneNumberStockWatch, unknown, ThrowOnError>;
811
+ createPhoneNumberStockWatch: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreatePhoneNumberStockWatchData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreatePhoneNumberStockWatchResponse, unknown, ThrowOnError>;
812
812
  listPhoneNumberStockWatches: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<unknown, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListPhoneNumberStockWatchesResponse, ListPhoneNumberStockWatchesError, ThrowOnError>;
813
813
  deletePhoneNumberStockWatch: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeletePhoneNumberStockWatchData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeletePhoneNumberStockWatchResponse, unknown, ThrowOnError>;
814
814
  };
@@ -32717,7 +32717,7 @@ type CheckPhoneNumberAvailabilityResponse = ({
32717
32717
  */
32718
32718
  areas?: Array<(string)>;
32719
32719
  /**
32720
- * Live inventory grouped by area code. For US and CA this is the full country inventory (every area code with stock, recognizable metros listed first, then alphabetical); other countries are ordered largest stock first; they list the areas in the latest inventory page (up to 500 numbers, which for most countries is the entire pool). Empty when out of stock (or the area lookup failed). Pass a chosen `ndc` as `areaCode` on POST /v1/phone-numbers/purchase (or on the KYC submit for regulated countries) to require that area.
32720
+ * Live inventory grouped by area code. For US and CA this is the full country inventory (every area code with stock, recognizable metros listed first, then alphabetical); other countries are ordered largest stock first; they list the areas in the latest inventory page (up to 500 numbers, which for most countries is the entire pool). Empty when out of stock (or the area lookup failed). Pass a chosen `ndc` as `areaCode` on POST /v1/phone-numbers/purchase (or on the KYC submit for regulated countries) to require that area. Equal to `areaAvailability.inStock`.
32721
32721
  *
32722
32722
  */
32723
32723
  areaOptions?: Array<{
@@ -32735,7 +32735,7 @@ type CheckPhoneNumberAvailabilityResponse = ({
32735
32735
  count?: number;
32736
32736
  }>;
32737
32737
  /**
32738
- * 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.
32738
+ * Every area of the country's numbering plan with nothing deliverable now: `areaAvailability.preOrder` plus `areaAvailability.outOfStock`, kept for older clients. 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.
32739
32739
  *
32740
32740
  */
32741
32741
  soldOutAreas?: Array<{
@@ -32752,6 +32752,38 @@ type CheckPhoneNumberAvailabilityResponse = ({
32752
32752
  */
32753
32753
  preOrderable?: boolean;
32754
32754
  }>;
32755
+ /**
32756
+ * Every area of the country's numbering plan (Google libphonenumber geocoding, one row per city: Madrid covers 910 to 919), in one of three states, refreshed every 6 hours from the carrier's own inventory counts. The same answer the dashboard picker and the public country pages show. Empty lists mean the pair has no cached coverage yet, not that the country has no areas.
32757
+ *
32758
+ */
32759
+ areaAvailability?: {
32760
+ /**
32761
+ * Deliverable numbers now, deepest first. Pass `ndc` as `areaCode` to hold the order to it.
32762
+ */
32763
+ inStock?: Array<{
32764
+ ndc?: string;
32765
+ name?: string;
32766
+ /**
32767
+ * Numbers we can sell there: the carrier count minus the numbers we hold back (WhatsApp refused them or another order holds them).
32768
+ */
32769
+ count?: number;
32770
+ }>;
32771
+ /**
32772
+ * The carrier lists nothing there and the number type is a document tier: submit KYC with `areaCode` and `preOrder: true`, the carrier sources one (usually 2 to 4 weeks, never guaranteed), nothing is billed until it is active.
32773
+ */
32774
+ preOrder?: Array<{
32775
+ ndc?: string;
32776
+ name?: string;
32777
+ }>;
32778
+ /**
32779
+ * Nothing deliverable and no pre-order: `listed` > 0 is stock the carrier shows that WhatsApp refused recently (held back until it clears), 0 is a dry area of an instant tier. A stock watch (POST /v1/phone-numbers/stock-watches with `areaCode`) is the way to hear when it is back.
32780
+ */
32781
+ outOfStock?: Array<{
32782
+ ndc?: string;
32783
+ name?: string;
32784
+ listed?: number;
32785
+ }>;
32786
+ };
32755
32787
  });
32756
32788
  type CheckPhoneNumberAvailabilityError = (unknown | {
32757
32789
  error?: string;
@@ -32987,7 +33019,7 @@ type CheckWhatsAppNumberAvailabilityResponse = ({
32987
33019
  */
32988
33020
  areas?: Array<(string)>;
32989
33021
  /**
32990
- * Live inventory grouped by area code. For US and CA this is the full country inventory (every area code with stock, recognizable metros listed first, then alphabetical); other countries are ordered largest stock first; they list the areas in the latest inventory page (up to 500 numbers, which for most countries is the entire pool). Empty when out of stock (or the area lookup failed). Pass a chosen `ndc` as `areaCode` on POST /v1/phone-numbers/purchase (or on the KYC submit for regulated countries) to require that area.
33022
+ * Live inventory grouped by area code. For US and CA this is the full country inventory (every area code with stock, recognizable metros listed first, then alphabetical); other countries are ordered largest stock first; they list the areas in the latest inventory page (up to 500 numbers, which for most countries is the entire pool). Empty when out of stock (or the area lookup failed). Pass a chosen `ndc` as `areaCode` on POST /v1/phone-numbers/purchase (or on the KYC submit for regulated countries) to require that area. Equal to `areaAvailability.inStock`.
32991
33023
  *
32992
33024
  */
32993
33025
  areaOptions?: Array<{
@@ -33005,7 +33037,7 @@ type CheckWhatsAppNumberAvailabilityResponse = ({
33005
33037
  count?: number;
33006
33038
  }>;
33007
33039
  /**
33008
- * 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.
33040
+ * Every area of the country's numbering plan with nothing deliverable now: `areaAvailability.preOrder` plus `areaAvailability.outOfStock`, kept for older clients. 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.
33009
33041
  *
33010
33042
  */
33011
33043
  soldOutAreas?: Array<{
@@ -33022,6 +33054,38 @@ type CheckWhatsAppNumberAvailabilityResponse = ({
33022
33054
  */
33023
33055
  preOrderable?: boolean;
33024
33056
  }>;
33057
+ /**
33058
+ * Every area of the country's numbering plan (Google libphonenumber geocoding, one row per city: Madrid covers 910 to 919), in one of three states, refreshed every 6 hours from the carrier's own inventory counts. The same answer the dashboard picker and the public country pages show. Empty lists mean the pair has no cached coverage yet, not that the country has no areas.
33059
+ *
33060
+ */
33061
+ areaAvailability?: {
33062
+ /**
33063
+ * Deliverable numbers now, deepest first. Pass `ndc` as `areaCode` to hold the order to it.
33064
+ */
33065
+ inStock?: Array<{
33066
+ ndc?: string;
33067
+ name?: string;
33068
+ /**
33069
+ * Numbers we can sell there: the carrier count minus the numbers we hold back (WhatsApp refused them or another order holds them).
33070
+ */
33071
+ count?: number;
33072
+ }>;
33073
+ /**
33074
+ * The carrier lists nothing there and the number type is a document tier: submit KYC with `areaCode` and `preOrder: true`, the carrier sources one (usually 2 to 4 weeks, never guaranteed), nothing is billed until it is active.
33075
+ */
33076
+ preOrder?: Array<{
33077
+ ndc?: string;
33078
+ name?: string;
33079
+ }>;
33080
+ /**
33081
+ * Nothing deliverable and no pre-order: `listed` > 0 is stock the carrier shows that WhatsApp refused recently (held back until it clears), 0 is a dry area of an instant tier. A stock watch (POST /v1/phone-numbers/stock-watches with `areaCode`) is the way to hear when it is back.
33082
+ */
33083
+ outOfStock?: Array<{
33084
+ ndc?: string;
33085
+ name?: string;
33086
+ listed?: number;
33087
+ }>;
33088
+ };
33025
33089
  });
33026
33090
  type CheckWhatsAppNumberAvailabilityError = (unknown | {
33027
33091
  error?: string;
@@ -34355,7 +34419,17 @@ type CreatePhoneNumberStockWatchData = {
34355
34419
  areaCode?: string;
34356
34420
  };
34357
34421
  };
34358
- type CreatePhoneNumberStockWatchResponse = (PhoneNumberStockWatch);
34422
+ type CreatePhoneNumberStockWatchResponse = ((PhoneNumberStockWatch & {
34423
+ /**
34424
+ * See the 201 response.
34425
+ */
34426
+ preOrderable?: boolean;
34427
+ }) | (PhoneNumberStockWatch & {
34428
+ /**
34429
+ * True when the watched area can be bought today as a pre-order (the carrier lists nothing there and the type is a document tier): submit KYC with `areaCode` and `preOrder: true` instead of waiting, usually 2 to 4 weeks, nothing billed until active. The watch is armed either way.
34430
+ */
34431
+ preOrderable?: boolean;
34432
+ }));
34359
34433
  type CreatePhoneNumberStockWatchError = (ErrorResponse | {
34360
34434
  error?: string;
34361
34435
  } | unknown);
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.1008",
39
+ version: "0.2.1009",
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.1008",
8
+ version: "0.2.1009",
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.1008",
3
+ "version": "0.2.1009",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -32590,7 +32590,7 @@ export type CheckPhoneNumberAvailabilityResponse = ({
32590
32590
  */
32591
32591
  areas?: Array<(string)>;
32592
32592
  /**
32593
- * Live inventory grouped by area code. For US and CA this is the full country inventory (every area code with stock, recognizable metros listed first, then alphabetical); other countries are ordered largest stock first; they list the areas in the latest inventory page (up to 500 numbers, which for most countries is the entire pool). Empty when out of stock (or the area lookup failed). Pass a chosen `ndc` as `areaCode` on POST /v1/phone-numbers/purchase (or on the KYC submit for regulated countries) to require that area.
32593
+ * Live inventory grouped by area code. For US and CA this is the full country inventory (every area code with stock, recognizable metros listed first, then alphabetical); other countries are ordered largest stock first; they list the areas in the latest inventory page (up to 500 numbers, which for most countries is the entire pool). Empty when out of stock (or the area lookup failed). Pass a chosen `ndc` as `areaCode` on POST /v1/phone-numbers/purchase (or on the KYC submit for regulated countries) to require that area. Equal to `areaAvailability.inStock`.
32594
32594
  *
32595
32595
  */
32596
32596
  areaOptions?: Array<{
@@ -32608,7 +32608,7 @@ export type CheckPhoneNumberAvailabilityResponse = ({
32608
32608
  count?: number;
32609
32609
  }>;
32610
32610
  /**
32611
- * 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.
32611
+ * Every area of the country's numbering plan with nothing deliverable now: `areaAvailability.preOrder` plus `areaAvailability.outOfStock`, kept for older clients. 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.
32612
32612
  *
32613
32613
  */
32614
32614
  soldOutAreas?: Array<{
@@ -32625,6 +32625,38 @@ export type CheckPhoneNumberAvailabilityResponse = ({
32625
32625
  */
32626
32626
  preOrderable?: boolean;
32627
32627
  }>;
32628
+ /**
32629
+ * Every area of the country's numbering plan (Google libphonenumber geocoding, one row per city: Madrid covers 910 to 919), in one of three states, refreshed every 6 hours from the carrier's own inventory counts. The same answer the dashboard picker and the public country pages show. Empty lists mean the pair has no cached coverage yet, not that the country has no areas.
32630
+ *
32631
+ */
32632
+ areaAvailability?: {
32633
+ /**
32634
+ * Deliverable numbers now, deepest first. Pass `ndc` as `areaCode` to hold the order to it.
32635
+ */
32636
+ inStock?: Array<{
32637
+ ndc?: string;
32638
+ name?: string;
32639
+ /**
32640
+ * Numbers we can sell there: the carrier count minus the numbers we hold back (WhatsApp refused them or another order holds them).
32641
+ */
32642
+ count?: number;
32643
+ }>;
32644
+ /**
32645
+ * The carrier lists nothing there and the number type is a document tier: submit KYC with `areaCode` and `preOrder: true`, the carrier sources one (usually 2 to 4 weeks, never guaranteed), nothing is billed until it is active.
32646
+ */
32647
+ preOrder?: Array<{
32648
+ ndc?: string;
32649
+ name?: string;
32650
+ }>;
32651
+ /**
32652
+ * Nothing deliverable and no pre-order: `listed` > 0 is stock the carrier shows that WhatsApp refused recently (held back until it clears), 0 is a dry area of an instant tier. A stock watch (POST /v1/phone-numbers/stock-watches with `areaCode`) is the way to hear when it is back.
32653
+ */
32654
+ outOfStock?: Array<{
32655
+ ndc?: string;
32656
+ name?: string;
32657
+ listed?: number;
32658
+ }>;
32659
+ };
32628
32660
  });
32629
32661
 
32630
32662
  export type CheckPhoneNumberAvailabilityError = (unknown | {
@@ -32874,7 +32906,7 @@ export type CheckWhatsAppNumberAvailabilityResponse = ({
32874
32906
  */
32875
32907
  areas?: Array<(string)>;
32876
32908
  /**
32877
- * Live inventory grouped by area code. For US and CA this is the full country inventory (every area code with stock, recognizable metros listed first, then alphabetical); other countries are ordered largest stock first; they list the areas in the latest inventory page (up to 500 numbers, which for most countries is the entire pool). Empty when out of stock (or the area lookup failed). Pass a chosen `ndc` as `areaCode` on POST /v1/phone-numbers/purchase (or on the KYC submit for regulated countries) to require that area.
32909
+ * Live inventory grouped by area code. For US and CA this is the full country inventory (every area code with stock, recognizable metros listed first, then alphabetical); other countries are ordered largest stock first; they list the areas in the latest inventory page (up to 500 numbers, which for most countries is the entire pool). Empty when out of stock (or the area lookup failed). Pass a chosen `ndc` as `areaCode` on POST /v1/phone-numbers/purchase (or on the KYC submit for regulated countries) to require that area. Equal to `areaAvailability.inStock`.
32878
32910
  *
32879
32911
  */
32880
32912
  areaOptions?: Array<{
@@ -32892,7 +32924,7 @@ export type CheckWhatsAppNumberAvailabilityResponse = ({
32892
32924
  count?: number;
32893
32925
  }>;
32894
32926
  /**
32895
- * 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.
32927
+ * Every area of the country's numbering plan with nothing deliverable now: `areaAvailability.preOrder` plus `areaAvailability.outOfStock`, kept for older clients. 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.
32896
32928
  *
32897
32929
  */
32898
32930
  soldOutAreas?: Array<{
@@ -32909,6 +32941,38 @@ export type CheckWhatsAppNumberAvailabilityResponse = ({
32909
32941
  */
32910
32942
  preOrderable?: boolean;
32911
32943
  }>;
32944
+ /**
32945
+ * Every area of the country's numbering plan (Google libphonenumber geocoding, one row per city: Madrid covers 910 to 919), in one of three states, refreshed every 6 hours from the carrier's own inventory counts. The same answer the dashboard picker and the public country pages show. Empty lists mean the pair has no cached coverage yet, not that the country has no areas.
32946
+ *
32947
+ */
32948
+ areaAvailability?: {
32949
+ /**
32950
+ * Deliverable numbers now, deepest first. Pass `ndc` as `areaCode` to hold the order to it.
32951
+ */
32952
+ inStock?: Array<{
32953
+ ndc?: string;
32954
+ name?: string;
32955
+ /**
32956
+ * Numbers we can sell there: the carrier count minus the numbers we hold back (WhatsApp refused them or another order holds them).
32957
+ */
32958
+ count?: number;
32959
+ }>;
32960
+ /**
32961
+ * The carrier lists nothing there and the number type is a document tier: submit KYC with `areaCode` and `preOrder: true`, the carrier sources one (usually 2 to 4 weeks, never guaranteed), nothing is billed until it is active.
32962
+ */
32963
+ preOrder?: Array<{
32964
+ ndc?: string;
32965
+ name?: string;
32966
+ }>;
32967
+ /**
32968
+ * Nothing deliverable and no pre-order: `listed` > 0 is stock the carrier shows that WhatsApp refused recently (held back until it clears), 0 is a dry area of an instant tier. A stock watch (POST /v1/phone-numbers/stock-watches with `areaCode`) is the way to hear when it is back.
32969
+ */
32970
+ outOfStock?: Array<{
32971
+ ndc?: string;
32972
+ name?: string;
32973
+ listed?: number;
32974
+ }>;
32975
+ };
32912
32976
  });
32913
32977
 
32914
32978
  export type CheckWhatsAppNumberAvailabilityError = (unknown | {
@@ -34331,7 +34395,17 @@ export type CreatePhoneNumberStockWatchData = {
34331
34395
  };
34332
34396
  };
34333
34397
 
34334
- export type CreatePhoneNumberStockWatchResponse = (PhoneNumberStockWatch);
34398
+ export type CreatePhoneNumberStockWatchResponse = ((PhoneNumberStockWatch & {
34399
+ /**
34400
+ * See the 201 response.
34401
+ */
34402
+ preOrderable?: boolean;
34403
+ }) | (PhoneNumberStockWatch & {
34404
+ /**
34405
+ * True when the watched area can be bought today as a pre-order (the carrier lists nothing there and the type is a document tier): submit KYC with `areaCode` and `preOrder: true` instead of waiting, usually 2 to 4 weeks, nothing billed until active. The watch is armed either way.
34406
+ */
34407
+ preOrderable?: boolean;
34408
+ }));
34335
34409
 
34336
34410
  export type CreatePhoneNumberStockWatchError = (ErrorResponse | {
34337
34411
  error?: string;