@zernio/node 0.2.748 → 0.2.750

package/dist/index.d.mts

@@ -2951,6 +2951,14 @@ type AnalyticsDeltaEntry = {
          * Instagram Reels skip rate, 0 to 1
          */
         reelsSkipRate: number;
+        /**
+         * TikTok business lane: share of viewers who watched to the end, 0 to 1
+         */
+        completionRate: number;
+        /**
+         * TikTok business lane: profile views attributed to the post
+         */
+        profileViews: number;
     };
 };
 type AnalyticsDeltaResponse = {
@@ -7424,6 +7432,14 @@ type PostAnalytics = {
      * Instagram Reels only: percentage (0-100) of initial views that skipped the reel within its first 3 seconds, as reported by Meta. Meta labels the metric estimated and in development, so it can move between syncs. 0 for non-Reels media and other platforms. When a post is published to several accounts, the aggregate is weighted by views.
      */
     reelsSkipRate?: number;
+    /**
+     * TikTok accounts connected through the TikTok for Business app only: share of viewers who watched the video to the end, 0 to 1, as TikTok reports it (T+24-48h, only for posts active in the last 7 days). 0 for other platforms. When a post is published to several accounts, the aggregate is weighted by views.
+     */
+    completionRate?: number;
+    /**
+     * TikTok accounts connected through the TikTok for Business app only: profile views from users who reached the profile through this post (T+24-48h). 0 for other platforms.
+     */
+    profileViews?: number;
     /**
      * Instagram accounts connected with Facebook Login only: reposts of the media by other users, minus deleted reposts, on feed posts, reels and stories. Meta does not expose this metric for accounts connected with Instagram Login, so those always report 0. 0 for other platforms, including Threads, where reposts are counted in shares instead.
      */
@@ -12426,9 +12442,9 @@ type GetAnalyticsData = {
          */
         profileId?: string;
         /**
-         * Sort by date, engagement, or a specific metric. Instagram-only metrics (follows, reposts, reels_skip_rate, ig_reels_*) sort a null value as 0.
+         * Sort by date, engagement, or a specific metric. Platform-specific metrics (follows, reposts, reels_skip_rate, ig_reels_*, completion_rate, profile_views) sort a null value as 0.
          */
-        sortBy?: 'date' | 'engagement' | 'impressions' | 'reach' | 'likes' | 'comments' | 'shares' | 'saves' | 'clicks' | 'views' | 'follows' | 'ig_reels_avg_watch_time' | 'ig_reels_video_view_total_time' | 'reposts' | 'reels_skip_rate';
+        sortBy?: 'date' | 'engagement' | 'impressions' | 'reach' | 'likes' | 'comments' | 'shares' | 'saves' | 'clicks' | 'views' | 'follows' | 'ig_reels_avg_watch_time' | 'ig_reels_video_view_total_time' | 'reposts' | 'reels_skip_rate' | 'completion_rate' | 'profile_views';
         /**
          * Filter by post source: late (posted via Zernio API), external (synced from platform), all (default)
          */
@@ -26532,6 +26548,11 @@ type PurchasePhoneNumberData = {
          *
          */
         areaCode?: string;
+        /**
+         * One exact number to buy, in E.164, taken from GET /v1/phone-numbers/available. Hard constraint: when it is no longer available (bought by someone else, or WhatsApp's buy-time check rejects it) the purchase fails with 409 code PHONE_NUMBER_UNAVAILABLE instead of assigning another number; search again and pick another. Only for countries and types that activate instantly: a regulated one (202 kyc_required) returns 400 when phoneNumber is set.
+         *
+         */
+        phoneNumber?: string;
         /**
          * A phone number is the unit; WhatsApp is one optional feature. Pass false to buy a STANDALONE number (Calls/SMS only): provisioning skips the Meta pre-verify/OTP steps and the number activates immediately. Omitted defaults to the WhatsApp provisioning path. WhatsApp can be connected to a standalone number later from the connect flow.
          *
@@ -26598,7 +26619,7 @@ type PurchasePhoneNumberError = (unknown | {
     error?: string;
 } | {
     error?: string;
-    code?: 'PURCHASE_VELOCITY' | 'AREA_CODE_UNAVAILABLE';
+    code?: 'PURCHASE_VELOCITY' | 'AREA_CODE_UNAVAILABLE' | 'PHONE_NUMBER_UNAVAILABLE';
 });
 type ListPhoneNumberCountriesResponse = ({
     countries?: Array<{
@@ -26706,11 +26727,22 @@ type SearchAvailablePhoneNumbersResponse = ({
      */
     requireSms?: boolean;
     numbers?: Array<{
+        /**
+         * E.164. Pass it as `phoneNumber` on POST /v1/phone-numbers/purchase to buy this exact number.
+         */
         phoneNumber?: string;
         /**
          * Provider capability list for this number (e.g. voice, sms, mms).
          */
         features?: Array<(string)>;
+        /**
+         * Town or rate center the number belongs to, as the carrier names it (e.g. WACO).
+         */
+        locality?: string;
+        /**
+         * true when the carrier added this number because too few matched your filters, so it may be outside the requested prefix or locality.
+         */
+        bestEffort?: boolean;
     }>;
 });
 type SearchAvailablePhoneNumbersError = (unknown | {
@@ -26889,6 +26921,11 @@ type PurchaseWhatsAppPhoneNumberData = {
          *
          */
         country?: string;
+        /**
+         * One exact number to buy, in E.164, taken from GET /v1/phone-numbers/available. Fails with 409 code PHONE_NUMBER_UNAVAILABLE when it is no longer available.
+         *
+         */
+        phoneNumber?: string;
         /**
          * Optional idempotency key. Send the same value when retrying a purchase: if a number was already bought under this key, the API returns { status: "already_purchased", numberId, phoneNumber } instead of provisioning a second number. Generate a fresh key for each genuinely new purchase.
          *
@@ -26932,7 +26969,7 @@ type PurchaseWhatsAppPhoneNumberError = (unknown | {
     error?: string;
 } | {
     error?: string;
-    code?: 'PURCHASE_VELOCITY' | 'AREA_CODE_UNAVAILABLE';
+    code?: 'PURCHASE_VELOCITY' | 'AREA_CODE_UNAVAILABLE' | 'PHONE_NUMBER_UNAVAILABLE';
 });
 type ListWhatsAppNumberCountriesResponse = ({
     countries?: Array<{
@@ -26979,6 +27016,8 @@ type SearchAvailableWhatsAppNumbersResponse = ({
     numberType?: string;
     numbers?: Array<{
         phoneNumber?: string;
+        locality?: string;
+        bestEffort?: boolean;
     }>;
 });
 type SearchAvailableWhatsAppNumbersError = (unknown | {

package/dist/index.d.ts

@@ -2951,6 +2951,14 @@ type AnalyticsDeltaEntry = {
          * Instagram Reels skip rate, 0 to 1
          */
         reelsSkipRate: number;
+        /**
+         * TikTok business lane: share of viewers who watched to the end, 0 to 1
+         */
+        completionRate: number;
+        /**
+         * TikTok business lane: profile views attributed to the post
+         */
+        profileViews: number;
     };
 };
 type AnalyticsDeltaResponse = {
@@ -7424,6 +7432,14 @@ type PostAnalytics = {
      * Instagram Reels only: percentage (0-100) of initial views that skipped the reel within its first 3 seconds, as reported by Meta. Meta labels the metric estimated and in development, so it can move between syncs. 0 for non-Reels media and other platforms. When a post is published to several accounts, the aggregate is weighted by views.
      */
     reelsSkipRate?: number;
+    /**
+     * TikTok accounts connected through the TikTok for Business app only: share of viewers who watched the video to the end, 0 to 1, as TikTok reports it (T+24-48h, only for posts active in the last 7 days). 0 for other platforms. When a post is published to several accounts, the aggregate is weighted by views.
+     */
+    completionRate?: number;
+    /**
+     * TikTok accounts connected through the TikTok for Business app only: profile views from users who reached the profile through this post (T+24-48h). 0 for other platforms.
+     */
+    profileViews?: number;
     /**
      * Instagram accounts connected with Facebook Login only: reposts of the media by other users, minus deleted reposts, on feed posts, reels and stories. Meta does not expose this metric for accounts connected with Instagram Login, so those always report 0. 0 for other platforms, including Threads, where reposts are counted in shares instead.
      */
@@ -12426,9 +12442,9 @@ type GetAnalyticsData = {
          */
         profileId?: string;
         /**
-         * Sort by date, engagement, or a specific metric. Instagram-only metrics (follows, reposts, reels_skip_rate, ig_reels_*) sort a null value as 0.
+         * Sort by date, engagement, or a specific metric. Platform-specific metrics (follows, reposts, reels_skip_rate, ig_reels_*, completion_rate, profile_views) sort a null value as 0.
          */
-        sortBy?: 'date' | 'engagement' | 'impressions' | 'reach' | 'likes' | 'comments' | 'shares' | 'saves' | 'clicks' | 'views' | 'follows' | 'ig_reels_avg_watch_time' | 'ig_reels_video_view_total_time' | 'reposts' | 'reels_skip_rate';
+        sortBy?: 'date' | 'engagement' | 'impressions' | 'reach' | 'likes' | 'comments' | 'shares' | 'saves' | 'clicks' | 'views' | 'follows' | 'ig_reels_avg_watch_time' | 'ig_reels_video_view_total_time' | 'reposts' | 'reels_skip_rate' | 'completion_rate' | 'profile_views';
         /**
          * Filter by post source: late (posted via Zernio API), external (synced from platform), all (default)
          */
@@ -26532,6 +26548,11 @@ type PurchasePhoneNumberData = {
          *
          */
         areaCode?: string;
+        /**
+         * One exact number to buy, in E.164, taken from GET /v1/phone-numbers/available. Hard constraint: when it is no longer available (bought by someone else, or WhatsApp's buy-time check rejects it) the purchase fails with 409 code PHONE_NUMBER_UNAVAILABLE instead of assigning another number; search again and pick another. Only for countries and types that activate instantly: a regulated one (202 kyc_required) returns 400 when phoneNumber is set.
+         *
+         */
+        phoneNumber?: string;
         /**
          * A phone number is the unit; WhatsApp is one optional feature. Pass false to buy a STANDALONE number (Calls/SMS only): provisioning skips the Meta pre-verify/OTP steps and the number activates immediately. Omitted defaults to the WhatsApp provisioning path. WhatsApp can be connected to a standalone number later from the connect flow.
          *
@@ -26598,7 +26619,7 @@ type PurchasePhoneNumberError = (unknown | {
     error?: string;
 } | {
     error?: string;
-    code?: 'PURCHASE_VELOCITY' | 'AREA_CODE_UNAVAILABLE';
+    code?: 'PURCHASE_VELOCITY' | 'AREA_CODE_UNAVAILABLE' | 'PHONE_NUMBER_UNAVAILABLE';
 });
 type ListPhoneNumberCountriesResponse = ({
     countries?: Array<{
@@ -26706,11 +26727,22 @@ type SearchAvailablePhoneNumbersResponse = ({
      */
     requireSms?: boolean;
     numbers?: Array<{
+        /**
+         * E.164. Pass it as `phoneNumber` on POST /v1/phone-numbers/purchase to buy this exact number.
+         */
         phoneNumber?: string;
         /**
          * Provider capability list for this number (e.g. voice, sms, mms).
          */
         features?: Array<(string)>;
+        /**
+         * Town or rate center the number belongs to, as the carrier names it (e.g. WACO).
+         */
+        locality?: string;
+        /**
+         * true when the carrier added this number because too few matched your filters, so it may be outside the requested prefix or locality.
+         */
+        bestEffort?: boolean;
     }>;
 });
 type SearchAvailablePhoneNumbersError = (unknown | {
@@ -26889,6 +26921,11 @@ type PurchaseWhatsAppPhoneNumberData = {
          *
          */
         country?: string;
+        /**
+         * One exact number to buy, in E.164, taken from GET /v1/phone-numbers/available. Fails with 409 code PHONE_NUMBER_UNAVAILABLE when it is no longer available.
+         *
+         */
+        phoneNumber?: string;
         /**
          * Optional idempotency key. Send the same value when retrying a purchase: if a number was already bought under this key, the API returns { status: "already_purchased", numberId, phoneNumber } instead of provisioning a second number. Generate a fresh key for each genuinely new purchase.
          *
@@ -26932,7 +26969,7 @@ type PurchaseWhatsAppPhoneNumberError = (unknown | {
     error?: string;
 } | {
     error?: string;
-    code?: 'PURCHASE_VELOCITY' | 'AREA_CODE_UNAVAILABLE';
+    code?: 'PURCHASE_VELOCITY' | 'AREA_CODE_UNAVAILABLE' | 'PHONE_NUMBER_UNAVAILABLE';
 });
 type ListWhatsAppNumberCountriesResponse = ({
     countries?: Array<{
@@ -26979,6 +27016,8 @@ type SearchAvailableWhatsAppNumbersResponse = ({
     numberType?: string;
     numbers?: Array<{
         phoneNumber?: string;
+        locality?: string;
+        bestEffort?: boolean;
     }>;
 });
 type SearchAvailableWhatsAppNumbersError = (unknown | {

package/dist/index.js

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

package/src/generated/sdk.gen.ts

@@ -5797,8 +5797,9 @@ export const releasePhoneNumber = <ThrowOnError extends boolean = false>(options
 
 /**
  * Purchase phone number
- * Payment-first: you do not pick a specific number, the system provisions one and
- * auto-assigns it. With usage-based billing active and a payment method on file, the
+ * Payment-first: the system provisions a number and auto-assigns it, unless you pass
+ * `phoneNumber` to buy one exact number from `GET /v1/phone-numbers/available`. With
+ * usage-based billing active and a payment method on file, the
  * number provisions inline and bills per month on your usage-based invoice (there is
  * no checkout redirect). No payment method on file returns `402 PAYMENT_REQUIRED`;
  * a regulated country returns `202` with `status: "kyc_required"` and a `kycUrl`.
@@ -5840,7 +5841,9 @@ export const listPhoneNumberCountries = <ThrowOnError extends boolean = false>(o
  * country (default US). Optional filters narrow the results. The country
  * must be offerable (see GET /v1/phone-numbers/countries). Voice
  * capability is always required; pass `sms=true` to only see numbers that
- * can also text (SMS support is per-number, not per-country).
+ * can also text (SMS support is per-number, not per-country). Numbers a
+ * purchase would refuse are left out, and any result's `phoneNumber` can
+ * be bought exactly by passing it to POST /v1/phone-numbers/purchase.
  *
  */
 export const searchAvailablePhoneNumbers = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<SearchAvailablePhoneNumbersData, ThrowOnError>) => {
@@ -5895,8 +5898,9 @@ export const getWhatsAppPhoneNumbers = <ThrowOnError extends boolean = false>(op
  * Deprecated alias of `/v1/phone-numbers/purchase`; same contract. New
  * integrations should use that path.
  *
- * Payment-first: you do not pick a specific number, the system provisions one and
- * auto-assigns it. With usage-based billing active and a payment method on file, the
+ * Payment-first: the system provisions a number and auto-assigns it, unless you pass
+ * `phoneNumber` to buy one exact number from `GET /v1/phone-numbers/available`. With
+ * usage-based billing active and a payment method on file, the
  * number provisions inline and bills per month on your usage-based invoice (there is
  * no checkout redirect). No payment method on file returns `402 PAYMENT_REQUIRED`;
  * a regulated country returns `202` with `status: "kyc_required"` and a `kycUrl`.

package/src/generated/types.gen.ts

@@ -1407,6 +1407,14 @@ export type AnalyticsDeltaEntry = {
          * Instagram Reels skip rate, 0 to 1
          */
         reelsSkipRate: number;
+        /**
+         * TikTok business lane: share of viewers who watched to the end, 0 to 1
+         */
+        completionRate: number;
+        /**
+         * TikTok business lane: profile views attributed to the post
+         */
+        profileViews: number;
     };
 };
 
@@ -6082,6 +6090,14 @@ export type PostAnalytics = {
      * Instagram Reels only: percentage (0-100) of initial views that skipped the reel within its first 3 seconds, as reported by Meta. Meta labels the metric estimated and in development, so it can move between syncs. 0 for non-Reels media and other platforms. When a post is published to several accounts, the aggregate is weighted by views.
      */
     reelsSkipRate?: number;
+    /**
+     * TikTok accounts connected through the TikTok for Business app only: share of viewers who watched the video to the end, 0 to 1, as TikTok reports it (T+24-48h, only for posts active in the last 7 days). 0 for other platforms. When a post is published to several accounts, the aggregate is weighted by views.
+     */
+    completionRate?: number;
+    /**
+     * TikTok accounts connected through the TikTok for Business app only: profile views from users who reached the profile through this post (T+24-48h). 0 for other platforms.
+     */
+    profileViews?: number;
     /**
      * Instagram accounts connected with Facebook Login only: reposts of the media by other users, minus deleted reposts, on feed posts, reels and stories. Meta does not expose this metric for accounts connected with Instagram Login, so those always report 0. 0 for other platforms, including Threads, where reposts are counted in shares instead.
      */
@@ -11298,9 +11314,9 @@ export type GetAnalyticsData = {
          */
         profileId?: string;
         /**
-         * Sort by date, engagement, or a specific metric. Instagram-only metrics (follows, reposts, reels_skip_rate, ig_reels_*) sort a null value as 0.
+         * Sort by date, engagement, or a specific metric. Platform-specific metrics (follows, reposts, reels_skip_rate, ig_reels_*, completion_rate, profile_views) sort a null value as 0.
          */
-        sortBy?: 'date' | 'engagement' | 'impressions' | 'reach' | 'likes' | 'comments' | 'shares' | 'saves' | 'clicks' | 'views' | 'follows' | 'ig_reels_avg_watch_time' | 'ig_reels_video_view_total_time' | 'reposts' | 'reels_skip_rate';
+        sortBy?: 'date' | 'engagement' | 'impressions' | 'reach' | 'likes' | 'comments' | 'shares' | 'saves' | 'clicks' | 'views' | 'follows' | 'ig_reels_avg_watch_time' | 'ig_reels_video_view_total_time' | 'reposts' | 'reels_skip_rate' | 'completion_rate' | 'profile_views';
         /**
          * Filter by post source: late (posted via Zernio API), external (synced from platform), all (default)
          */
@@ -26388,6 +26404,11 @@ export type PurchasePhoneNumberData = {
          *
          */
         areaCode?: string;
+        /**
+         * One exact number to buy, in E.164, taken from GET /v1/phone-numbers/available. Hard constraint: when it is no longer available (bought by someone else, or WhatsApp's buy-time check rejects it) the purchase fails with 409 code PHONE_NUMBER_UNAVAILABLE instead of assigning another number; search again and pick another. Only for countries and types that activate instantly: a regulated one (202 kyc_required) returns 400 when phoneNumber is set.
+         *
+         */
+        phoneNumber?: string;
         /**
          * A phone number is the unit; WhatsApp is one optional feature. Pass false to buy a STANDALONE number (Calls/SMS only): provisioning skips the Meta pre-verify/OTP steps and the number activates immediately. Omitted defaults to the WhatsApp provisioning path. WhatsApp can be connected to a standalone number later from the connect flow.
          *
@@ -26456,7 +26477,7 @@ export type PurchasePhoneNumberError = (unknown | {
     error?: string;
 } | {
     error?: string;
-    code?: 'PURCHASE_VELOCITY' | 'AREA_CODE_UNAVAILABLE';
+    code?: 'PURCHASE_VELOCITY' | 'AREA_CODE_UNAVAILABLE' | 'PHONE_NUMBER_UNAVAILABLE';
 });
 
 export type ListPhoneNumberCountriesResponse = ({
@@ -26568,11 +26589,22 @@ export type SearchAvailablePhoneNumbersResponse = ({
      */
     requireSms?: boolean;
     numbers?: Array<{
+        /**
+         * E.164. Pass it as `phoneNumber` on POST /v1/phone-numbers/purchase to buy this exact number.
+         */
         phoneNumber?: string;
         /**
          * Provider capability list for this number (e.g. voice, sms, mms).
          */
         features?: Array<(string)>;
+        /**
+         * Town or rate center the number belongs to, as the carrier names it (e.g. WACO).
+         */
+        locality?: string;
+        /**
+         * true when the carrier added this number because too few matched your filters, so it may be outside the requested prefix or locality.
+         */
+        bestEffort?: boolean;
     }>;
 });
 
@@ -26759,6 +26791,11 @@ export type PurchaseWhatsAppPhoneNumberData = {
          *
          */
         country?: string;
+        /**
+         * One exact number to buy, in E.164, taken from GET /v1/phone-numbers/available. Fails with 409 code PHONE_NUMBER_UNAVAILABLE when it is no longer available.
+         *
+         */
+        phoneNumber?: string;
         /**
          * Optional idempotency key. Send the same value when retrying a purchase: if a number was already bought under this key, the API returns { status: "already_purchased", numberId, phoneNumber } instead of provisioning a second number. Generate a fresh key for each genuinely new purchase.
          *
@@ -26804,7 +26841,7 @@ export type PurchaseWhatsAppPhoneNumberError = (unknown | {
     error?: string;
 } | {
     error?: string;
-    code?: 'PURCHASE_VELOCITY' | 'AREA_CODE_UNAVAILABLE';
+    code?: 'PURCHASE_VELOCITY' | 'AREA_CODE_UNAVAILABLE' | 'PHONE_NUMBER_UNAVAILABLE';
 });
 
 export type ListWhatsAppNumberCountriesResponse = ({
@@ -26855,6 +26892,8 @@ export type SearchAvailableWhatsAppNumbersResponse = ({
     numberType?: string;
     numbers?: Array<{
         phoneNumber?: string;
+        locality?: string;
+        bestEffort?: boolean;
     }>;
 });