@zernio/node 0.2.697 → 0.2.699

package/dist/index.d.mts

@@ -2240,7 +2240,7 @@ type AdTreeAdSet = {
         page_id?: string;
     } | null;
     /**
-     * Individual ads within this ad set (capped at 100). Returns a subset of Ad fields from the aggregation: `_id`, `name`, `platform`, `status`, `configuredStatus`, `reviewStatus`, `budget`, `metrics`, `creative`, `goal` and the `platform*` ids are always included; `targeting` and `schedule` may be absent. `configuredStatus` (the ad's own on/off toggle) and `reviewStatus` (the platform's review verdict) are part of this contract, not incidental: a rejected ad is only distinguishable from a healthy one through `reviewStatus`. When `timeIncrement=1&dailyLevel=ad`, each entry also carries a `daily[]` array of `AdDailyMetrics`.
+     * Individual ads within this ad set (capped at 100). When the ad set has more than 100 ads these are the 100 highest-spending over the requested date range, so this array depends on `fromDate`/`toDate`; `adCount` is always the true ad set size. Returns a subset of Ad fields from the aggregation: `_id`, `name`, `platform`, `status`, `configuredStatus`, `reviewStatus`, `budget`, `metrics`, `creative`, `goal` and the `platform*` ids are always included; `targeting` and `schedule` may be absent. `configuredStatus` (the ad's own on/off toggle) and `reviewStatus` (the platform's review verdict) are part of this contract, not incidental: a rejected ad is only distinguishable from a healthy one through `reviewStatus`. When `timeIncrement=1&dailyLevel=ad`, each entry also carries a `daily[]` array of `AdDailyMetrics`.
      */
     ads?: Array<Ad>;
     /**
@@ -24255,7 +24255,7 @@ type ListPhoneNumbersResponse = ({
          */
         telnyxOrderId?: (string) | null;
         /**
-         * Per-country monthly price in cents ($2..$25).
+         * What this number bills each month, in cents. Stamped when the number was bought, so an existing number keeps its price when the rate card changes.
          */
         monthlyCents?: number;
         /**
@@ -24483,6 +24483,9 @@ type ListPhoneNumberCountriesResponse = ({
          */
         code?: string;
         tier?: 1 | 2 | 3 | 4;
+        /**
+         * Price a NEW number in this country costs per month, in cents, for the default (first) type. 1.5x the carrier's monthly cost, rounded up to a whole dollar, minimum $3.
+         */
         monthlyCents?: number;
         needsKyc?: boolean;
         /**
@@ -24513,6 +24516,9 @@ type ListPhoneNumberCountriesResponse = ({
             numberType?: 'local' | 'mobile' | 'national' | 'toll_free';
             tier?: 1 | 2 | 3 | 4;
             needsKyc?: boolean;
+            /**
+             * Price a NEW number of this type costs per month, in cents.
+             */
             monthlyCents?: number;
             /**
              * Always false for toll_free (WhatsApp does not reliably register toll-free numbers).
@@ -24657,7 +24663,7 @@ type GetWhatsAppPhoneNumbersResponse = ({
          */
         telnyxOrderId?: (string) | null;
         /**
-         * Per-country monthly price in cents ($2..$25).
+         * What this number bills each month, in cents. Stamped when the number was bought, so an existing number keeps its price when the rate card changes.
          */
         monthlyCents?: number;
         /**
@@ -24792,6 +24798,9 @@ type ListWhatsAppNumberCountriesResponse = ({
          */
         code?: string;
         tier?: 1 | 2 | 3 | 4;
+        /**
+         * Price a NEW number in this country costs per month, in cents, for the default (first) type. 1.5x the carrier's monthly cost, rounded up to a whole dollar, minimum $3.
+         */
         monthlyCents?: number;
         needsKyc?: boolean;
         outboundCallingAvailable?: boolean;

package/dist/index.d.ts

@@ -2240,7 +2240,7 @@ type AdTreeAdSet = {
         page_id?: string;
     } | null;
     /**
-     * Individual ads within this ad set (capped at 100). Returns a subset of Ad fields from the aggregation: `_id`, `name`, `platform`, `status`, `configuredStatus`, `reviewStatus`, `budget`, `metrics`, `creative`, `goal` and the `platform*` ids are always included; `targeting` and `schedule` may be absent. `configuredStatus` (the ad's own on/off toggle) and `reviewStatus` (the platform's review verdict) are part of this contract, not incidental: a rejected ad is only distinguishable from a healthy one through `reviewStatus`. When `timeIncrement=1&dailyLevel=ad`, each entry also carries a `daily[]` array of `AdDailyMetrics`.
+     * Individual ads within this ad set (capped at 100). When the ad set has more than 100 ads these are the 100 highest-spending over the requested date range, so this array depends on `fromDate`/`toDate`; `adCount` is always the true ad set size. Returns a subset of Ad fields from the aggregation: `_id`, `name`, `platform`, `status`, `configuredStatus`, `reviewStatus`, `budget`, `metrics`, `creative`, `goal` and the `platform*` ids are always included; `targeting` and `schedule` may be absent. `configuredStatus` (the ad's own on/off toggle) and `reviewStatus` (the platform's review verdict) are part of this contract, not incidental: a rejected ad is only distinguishable from a healthy one through `reviewStatus`. When `timeIncrement=1&dailyLevel=ad`, each entry also carries a `daily[]` array of `AdDailyMetrics`.
      */
     ads?: Array<Ad>;
     /**
@@ -24255,7 +24255,7 @@ type ListPhoneNumbersResponse = ({
          */
         telnyxOrderId?: (string) | null;
         /**
-         * Per-country monthly price in cents ($2..$25).
+         * What this number bills each month, in cents. Stamped when the number was bought, so an existing number keeps its price when the rate card changes.
          */
         monthlyCents?: number;
         /**
@@ -24483,6 +24483,9 @@ type ListPhoneNumberCountriesResponse = ({
          */
         code?: string;
         tier?: 1 | 2 | 3 | 4;
+        /**
+         * Price a NEW number in this country costs per month, in cents, for the default (first) type. 1.5x the carrier's monthly cost, rounded up to a whole dollar, minimum $3.
+         */
         monthlyCents?: number;
         needsKyc?: boolean;
         /**
@@ -24513,6 +24516,9 @@ type ListPhoneNumberCountriesResponse = ({
             numberType?: 'local' | 'mobile' | 'national' | 'toll_free';
             tier?: 1 | 2 | 3 | 4;
             needsKyc?: boolean;
+            /**
+             * Price a NEW number of this type costs per month, in cents.
+             */
             monthlyCents?: number;
             /**
              * Always false for toll_free (WhatsApp does not reliably register toll-free numbers).
@@ -24657,7 +24663,7 @@ type GetWhatsAppPhoneNumbersResponse = ({
          */
         telnyxOrderId?: (string) | null;
         /**
-         * Per-country monthly price in cents ($2..$25).
+         * What this number bills each month, in cents. Stamped when the number was bought, so an existing number keeps its price when the rate card changes.
          */
         monthlyCents?: number;
         /**
@@ -24792,6 +24798,9 @@ type ListWhatsAppNumberCountriesResponse = ({
          */
         code?: string;
         tier?: 1 | 2 | 3 | 4;
+        /**
+         * Price a NEW number in this country costs per month, in cents, for the default (first) type. 1.5x the carrier's monthly cost, rounded up to a whole dollar, minimum $3.
+         */
         monthlyCents?: number;
         needsKyc?: boolean;
         outboundCallingAvailable?: boolean;

package/dist/index.js

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

package/src/generated/sdk.gen.ts

@@ -5587,6 +5587,10 @@ export const releasePhoneNumber = <ThrowOnError extends boolean = false>(options
  * no checkout redirect). No payment method on file returns `402 PAYMENT_REQUIRED`;
  * a regulated country returns `202` with `status: "kyc_required"` and a `kycUrl`.
  *
+ * The monthly price is the one `GET /v1/phone-numbers/countries` quotes for that
+ * country and `numberType` at the time of purchase, and it is stamped on the number:
+ * later rate-card changes never move a number you already own.
+ *
  * Requires usage-based billing (the Usage plan). The maximum number of phone numbers
  * is determined by the user's plan.
  *
@@ -5681,6 +5685,10 @@ export const getWhatsAppPhoneNumbers = <ThrowOnError extends boolean = false>(op
  * no checkout redirect). No payment method on file returns `402 PAYMENT_REQUIRED`;
  * a regulated country returns `202` with `status: "kyc_required"` and a `kycUrl`.
  *
+ * The monthly price is the one `GET /v1/phone-numbers/countries` quotes for that
+ * country and `numberType` at the time of purchase, and it is stamped on the number:
+ * later rate-card changes never move a number you already own.
+ *
  * Requires usage-based billing (the Usage plan). The maximum number of phone numbers
  * is determined by the user's plan.
  *

package/src/generated/types.gen.ts

@@ -925,7 +925,7 @@ export type AdTreeAdSet = {
         page_id?: string;
     } | null;
     /**
-     * Individual ads within this ad set (capped at 100). Returns a subset of Ad fields from the aggregation: `_id`, `name`, `platform`, `status`, `configuredStatus`, `reviewStatus`, `budget`, `metrics`, `creative`, `goal` and the `platform*` ids are always included; `targeting` and `schedule` may be absent. `configuredStatus` (the ad's own on/off toggle) and `reviewStatus` (the platform's review verdict) are part of this contract, not incidental: a rejected ad is only distinguishable from a healthy one through `reviewStatus`. When `timeIncrement=1&dailyLevel=ad`, each entry also carries a `daily[]` array of `AdDailyMetrics`.
+     * Individual ads within this ad set (capped at 100). When the ad set has more than 100 ads these are the 100 highest-spending over the requested date range, so this array depends on `fromDate`/`toDate`; `adCount` is always the true ad set size. Returns a subset of Ad fields from the aggregation: `_id`, `name`, `platform`, `status`, `configuredStatus`, `reviewStatus`, `budget`, `metrics`, `creative`, `goal` and the `platform*` ids are always included; `targeting` and `schedule` may be absent. `configuredStatus` (the ad's own on/off toggle) and `reviewStatus` (the platform's review verdict) are part of this contract, not incidental: a rejected ad is only distinguishable from a healthy one through `reviewStatus`. When `timeIncrement=1&dailyLevel=ad`, each entry also carries a `daily[]` array of `AdDailyMetrics`.
      */
     ads?: Array<Ad>;
     /**
@@ -24247,7 +24247,7 @@ export type ListPhoneNumbersResponse = ({
          */
         telnyxOrderId?: (string) | null;
         /**
-         * Per-country monthly price in cents ($2..$25).
+         * What this number bills each month, in cents. Stamped when the number was bought, so an existing number keeps its price when the rate card changes.
          */
         monthlyCents?: number;
         /**
@@ -24486,6 +24486,9 @@ export type ListPhoneNumberCountriesResponse = ({
          */
         code?: string;
         tier?: 1 | 2 | 3 | 4;
+        /**
+         * Price a NEW number in this country costs per month, in cents, for the default (first) type. 1.5x the carrier's monthly cost, rounded up to a whole dollar, minimum $3.
+         */
         monthlyCents?: number;
         needsKyc?: boolean;
         /**
@@ -24516,6 +24519,9 @@ export type ListPhoneNumberCountriesResponse = ({
             numberType?: 'local' | 'mobile' | 'national' | 'toll_free';
             tier?: 1 | 2 | 3 | 4;
             needsKyc?: boolean;
+            /**
+             * Price a NEW number of this type costs per month, in cents.
+             */
             monthlyCents?: number;
             /**
              * Always false for toll_free (WhatsApp does not reliably register toll-free numbers).
@@ -24669,7 +24675,7 @@ export type GetWhatsAppPhoneNumbersResponse = ({
          */
         telnyxOrderId?: (string) | null;
         /**
-         * Per-country monthly price in cents ($2..$25).
+         * What this number bills each month, in cents. Stamped when the number was bought, so an existing number keeps its price when the rate card changes.
          */
         monthlyCents?: number;
         /**
@@ -24809,6 +24815,9 @@ export type ListWhatsAppNumberCountriesResponse = ({
          */
         code?: string;
         tier?: 1 | 2 | 3 | 4;
+        /**
+         * Price a NEW number in this country costs per month, in cents, for the default (first) type. 1.5x the carrier's monthly cost, rounded up to a whole dollar, minimum $3.
+         */
         monthlyCents?: number;
         needsKyc?: boolean;
         outboundCallingAvailable?: boolean;