@zernio/node 0.2.657 → 0.2.659

package/src/generated/types.gen.ts

@@ -4578,6 +4578,16 @@ export type ParameterIdempotencyKeyHeader = string;
  */
 export type ParameterPageParam = number;
 
+export type PhoneNumberStockWatch = {
+    id: string;
+    /**
+     * ISO 3166-1 alpha-2.
+     */
+    country: string;
+    countryName: string;
+    createdAt: string;
+};
+
 export type PinterestPlatformData = {
     /**
      * Pin title. Defaults to first line of content or "Pin". Must be ≤ 100 characters.
@@ -5933,6 +5943,31 @@ export type UploadTokenStatusResponse = {
     completedAt?: (string) | null;
 };
 
+export type UsageAttributionGroup = UsageAttributionSlice & {
+    /**
+     * Profile id or account id, per `groupBy`.
+     */
+    key: string;
+};
+
+export type UsageAttributionSlice = {
+    /**
+     * USD per product family.
+     */
+    byProduct?: {
+        accounts?: number;
+        numbers?: number;
+        calls?: number;
+        sms?: number;
+        verify?: number;
+        dlc?: number;
+        xApi?: number;
+        credits?: number;
+        other?: number;
+    };
+    totalUsd?: number;
+};
+
 /**
  * Billed spend by product family over a window, from Metronome's invoice
  * breakdown (the CHARGE view). Returned by `GET /v1/usage`.
@@ -5988,14 +6023,14 @@ export type UsageMetering = {
         quantity?: number;
     }>;
     /**
-     * Peak counts over the window (Metronome COUNT metrics + live active-number count).
+     * Peak counts over the window (Metronome COUNT metrics + live active-number count). Null when `profileId` / `accountId` is set.
      */
     peaks?: {
         accounts?: number;
         numbers?: number;
-    };
+    } | null;
     /**
-     * Billable call volumes over the window.
+     * Billable call volumes over the window. Null when `profileId` / `accountId` is set.
      */
     callUsage?: {
         whatsapp?: {
@@ -6006,7 +6041,7 @@ export type UsageMetering = {
             count?: number;
             minutes?: number;
         };
-    };
+    } | null;
     period?: {
         start?: string;
         end?: string;
@@ -6041,6 +6076,33 @@ export type UsageMetering = {
          */
         reverseCharge?: boolean;
     } | null;
+    /**
+     * Present with `groupBy`. The window's spend split per profile or account; `sum(groups) + unattributed` equals `totals` per product.
+     */
+    attribution?: {
+        groupBy?: 'profile' | 'account';
+        groups?: Array<UsageAttributionGroup>;
+        /**
+         * Spend no profile/account can claim: credits, 10DLC fees, Verify, and usage whose record no longer resolves to an account. Zero for a restricted principal.
+         */
+        unattributed?: UsageAttributionSlice;
+        /**
+         * The window totals; for a restricted principal, the sum of the visible groups.
+         */
+        totals?: UsageAttributionSlice;
+        /**
+         * True when the caller (profile-scoped API key or member) cannot see every profile: `groups` are filtered, `totals` sum them, `unattributed` is zero, and the top-level `days` / `totals` / `lineItems` are projected onto the visible groups with `peaks`, `callUsage` and `tax` null.
+         */
+        restricted?: boolean;
+    };
+    /**
+     * Present with `profileId` / `accountId`: echoes the group the payload was projected onto.
+     */
+    scope?: ({
+    profileId: string;
+} | {
+    accountId: string;
+});
 };
 
 export type granularity = 'day' | 'month' | 'total';
@@ -6050,6 +6112,8 @@ export type granularity = 'day' | 'month' | 'total';
  */
 export type source2 = 'cycle' | 'window';
 
+export type groupBy = 'profile' | 'account';
+
 /**
  * Plan and usage stats. The response shape depends on `billingSystem`:
  * * Stripe users (default): per-period counters like `usage.uploads` and
@@ -6370,7 +6434,7 @@ export type Webhook = {
     /**
      * Events subscribed to
      */
-    events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'conversation.started' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'referral.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.account.name_status_updated' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'verification.approved' | 'verification.failed')>;
+    events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'conversation.started' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'referral.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.account.name_status_updated' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'phone_number.stock_available' | 'verification.approved' | 'verification.failed')>;
     /**
      * Whether webhook delivery is enabled
      */
@@ -7990,6 +8054,42 @@ export type platform11 = 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 't
  */
 export type source3 = 'whatsapp_business_app' | 'cloud_api';
 
+/**
+ * Webhook payload for phone_number.stock_available events
+ */
+export type WebhookPayloadPhoneNumberStockAvailable = {
+    /**
+     * Stable webhook event ID
+     */
+    id: string;
+    event: 'phone_number.stock_available';
+    stock: {
+        /**
+         * ISO 3166-1 alpha-2 country code of the watched country.
+         */
+        country: string;
+        /**
+         * Number types deliverable at sweep time. Only types with stock are listed.
+         */
+        types: Array<{
+            /**
+             * local, mobile, national or toll_free.
+             */
+            numberType: string;
+            /**
+             * Deliverable numbers at sweep time; first come, first served.
+             */
+            availableCount: number;
+        }>;
+    };
+    /**
+     * 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.
+     */
+    timestamp: string;
+};
+
+export type event18 = 'phone_number.stock_available';
+
 /**
  * Webhook payload for post events
  */
@@ -8029,7 +8129,7 @@ export type WebhookPayloadPost = {
     timestamp: string;
 };
 
-export type event18 = 'post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled';
+export type event19 = 'post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled';
 
 /**
  * Webhook payload for the per-platform terminal events
@@ -8128,7 +8228,7 @@ export type WebhookPayloadPostPlatform = {
     timestamp: string;
 };
 
-export type event19 = 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved';
+export type event20 = 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved';
 
 /**
  * Terminal status this event fires on. Matches the event suffix.
@@ -8187,7 +8287,7 @@ export type WebhookPayloadReaction = {
     timestamp: string;
 };
 
-export type event20 = 'reaction.received';
+export type event21 = 'reaction.received';
 
 export type action = 'added' | 'removed';
 
@@ -8261,7 +8361,7 @@ export type WebhookPayloadReferral = {
     timestamp: string;
 };
 
-export type event21 = 'referral.received';
+export type event22 = 'referral.received';
 
 /**
  * Webhook payload for the review.new event (new review posted on a connected account).
@@ -8288,7 +8388,7 @@ export type WebhookPayloadReviewNew = {
     timestamp: string;
 };
 
-export type event22 = 'review.new';
+export type event23 = 'review.new';
 
 /**
  * Webhook payload for the review.updated event. Fired when the reviewer edits
@@ -8319,7 +8419,7 @@ export type WebhookPayloadReviewUpdated = {
     timestamp: string;
 };
 
-export type event23 = 'review.updated';
+export type event24 = 'review.updated';
 
 /**
  * Webhook payload for test deliveries
@@ -8340,7 +8440,7 @@ export type WebhookPayloadTest = {
     timestamp: string;
 };
 
-export type event24 = 'webhook.test';
+export type event25 = 'webhook.test';
 
 /**
  * Webhook payload for the `whatsapp.account.name_status_updated` event.
@@ -8389,7 +8489,7 @@ export type WebhookPayloadWhatsAppAccountNameStatusUpdated = {
     timestamp: string;
 };
 
-export type event25 = 'whatsapp.account.name_status_updated';
+export type event26 = 'whatsapp.account.name_status_updated';
 
 export type platform12 = 'whatsapp';
 
@@ -8460,7 +8560,7 @@ export type WebhookPayloadWhatsAppTemplateCategoryUpdated = {
     timestamp: string;
 };
 
-export type event26 = 'whatsapp.template.category_updated';
+export type event27 = 'whatsapp.template.category_updated';
 
 /**
  * `scheduled` is Meta's 24h advance notice of an upcoming
@@ -8537,7 +8637,7 @@ export type WebhookPayloadWhatsAppTemplateStatusUpdated = {
     timestamp: string;
 };
 
-export type event27 = 'whatsapp.template.status_updated';
+export type event28 = 'whatsapp.template.status_updated';
 
 /**
  * New status. Forwarded verbatim from Meta's `event` field.
@@ -11017,6 +11117,10 @@ export type GetXApiPricingError = ({
 
 export type GetUsageData = {
     query?: {
+        /**
+         * Metering mode (pair with `range`). Project the payload onto this account's attributed share. Mutually exclusive with `profileId`, and `groupBy` (if given) must be `account`; 404 when the account is not visible to the caller.
+         */
+        accountId?: string;
         /**
          * Inclusive start (UTC date). Required when `range=custom`.
          */
@@ -11028,6 +11132,14 @@ export type GetUsageData = {
          *
          */
         granularity?: 'day' | 'month' | 'total';
+        /**
+         * Metering mode. Adds `attribution`: the window's spend split per profile or per account (keys are ids; resolve names via `GET /v1/profiles` / `GET /v1/accounts`).
+         */
+        groupBy?: 'profile' | 'account';
+        /**
+         * Metering mode (pair with `range`). Project the payload onto this profile's attributed share. Mutually exclusive with `accountId`, and `groupBy` (if given) must be `profile`; 404 when the profile is not in your workspace (or outside a scoped key's profiles).
+         */
+        profileId?: string;
         /**
          * Window to report. `cycle` / `prev-cycle` resolve to the customer's
          * real billing-period bounds (falling back to a trailing 30 days when
@@ -17649,7 +17761,7 @@ export type CreateWebhookSettingsData = {
         /**
          * Events to subscribe to (at least one required)
          */
-        events: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'conversation.started' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'referral.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.account.name_status_updated' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'verification.approved' | 'verification.failed')>;
+        events: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'conversation.started' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'referral.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.account.name_status_updated' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'phone_number.stock_available' | 'verification.approved' | 'verification.failed')>;
         /**
          * Enable or disable webhook delivery. Defaults to `true` when omitted.
          */
@@ -17704,7 +17816,7 @@ export type UpdateWebhookSettingsData = {
         /**
          * Events to subscribe to. Must contain at least one event if provided.
          */
-        events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'conversation.started' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'referral.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.account.name_status_updated' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'verification.approved' | 'verification.failed')>;
+        events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'conversation.started' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'referral.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.account.name_status_updated' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'phone_number.stock_available' | 'verification.approved' | 'verification.failed')>;
         /**
          * Enable or disable webhook delivery
          */
@@ -25285,6 +25397,43 @@ export type DisableVoiceOnNumberError = ({
     error?: string;
 } | unknown);
 
+export type CreatePhoneNumberStockWatchData = {
+    body: {
+        /**
+         * ISO 3166-1 alpha-2 code of a country listed by GET /v1/phone-numbers/countries.
+         */
+        country: string;
+    };
+};
+
+export type CreatePhoneNumberStockWatchResponse = (PhoneNumberStockWatch);
+
+export type CreatePhoneNumberStockWatchError = (ErrorResponse | {
+    error?: string;
+} | unknown);
+
+export type ListPhoneNumberStockWatchesResponse = ({
+    watches?: Array<PhoneNumberStockWatch>;
+});
+
+export type ListPhoneNumberStockWatchesError = ({
+    error?: string;
+});
+
+export type DeletePhoneNumberStockWatchData = {
+    path: {
+        id: string;
+    };
+};
+
+export type DeletePhoneNumberStockWatchResponse = ({
+    deleted?: boolean;
+});
+
+export type DeletePhoneNumberStockWatchError = (ErrorResponse | {
+    error?: string;
+} | unknown);
+
 export type CreateSipTrunkData = {
     body: {
         /**