@getlatedev/node 0.2.390 → 0.2.392

package/src/generated/types.gen.ts

@@ -3910,6 +3910,43 @@ export type ReviewWebhookReview = {
  */
 export type platform4 = 'googlebusiness';
 
+/**
+ * A Meta Reach & Frequency prediction. Money values in whole units of the ad account currency.
+ */
+export type RfPrediction = {
+    predictionId?: string;
+    /**
+     * ready | pending | failed:<meta code>
+     */
+    status?: string;
+    /**
+     * Quoted (or provided) lifetime budget for the window.
+     */
+    budget?: (number) | null;
+    /**
+     * Predicted (or requested) unique reach.
+     */
+    reach?: (number) | null;
+    impressions?: (number) | null;
+    /**
+     * Meta's allowed lower bound for this spec.
+     */
+    minBudget?: (number) | null;
+    maxBudget?: (number) | null;
+    minReach?: (number) | null;
+    maxReach?: (number) | null;
+    frequencyCap?: (number) | null;
+    /**
+     * Unix seconds; the reserved window the R&F ad set will run on.
+     */
+    startTime?: (number) | null;
+    stopTime?: (number) | null;
+    /**
+     * When the reservation's locked price expires (set after reserving).
+     */
+    expiresAt?: (string) | null;
+};
+
 /**
  * An ad account a tracking tag is shared with (Meta `shared_accounts` edge).
  */
@@ -19673,21 +19710,32 @@ export type CreatePhoneNumberPortInData = {
              */
             accountNumber: string;
             /**
-             * Transfer PIN. Required for mobile numbers (wireless carriers reject PIN-less ports). Forwarded to the carrier, never stored.
+             * Transfer PIN. Required for US/CA mobile numbers (wireless carriers reject PIN-less ports). Forwarded to the carrier, never stored. International porting codes (e.g. the UK PAC) go through `requirements` instead.
              */
             pinPasscode?: string;
+            /**
+             * Company tax id on the carrier account (EU ports, e.g. Spanish CIF).
+             */
+            taxIdentifier?: string;
+            /**
+             * Business registration id on the carrier account (EU ports).
+             */
+            businessIdentifier?: string;
             streetAddress: string;
             extendedAddress?: string;
             locality: string;
             /**
-             * 2-letter US state / CA province code (full names are accepted and normalized).
+             * Region. Required for US/CA as the 2-letter state/province code (full names are accepted and normalized); optional elsewhere.
              */
-            administrativeArea: string;
+            administrativeArea?: string;
             /**
-             * US ZIP (5 digits) or Canadian postal code, matching countryCode.
+             * Postal code. Validated as a US ZIP / Canadian postal code for US/CA; free-form elsewhere.
              */
             postalCode: string;
-            countryCode: 'US' | 'CA';
+            /**
+             * Service-address country (a supported port-in country).
+             */
+            countryCode: 'US' | 'CA' | 'GB' | 'ES' | 'DE' | 'FR' | 'NL' | 'AU';
         };
         /**
          * Document id from POST /v1/phone-numbers/port-in/documents (kind=loa).
@@ -19698,7 +19746,7 @@ export type CreatePhoneNumberPortInData = {
          */
         invoiceDocumentId: string;
         /**
-         * Requested port date; the carrier confirms the actual FOC later. Defaults to one week out (shifted off weekends) when omitted.
+         * Requested port date; the carrier confirms the actual FOC later. US/CA default is one week out (shifted off weekends); international orders are scheduled into the carrier's next allowed porting window at or after this date.
          */
         focDatetimeRequested?: string;
         customerReference?: string;
@@ -19706,6 +19754,19 @@ export type CreatePhoneNumberPortInData = {
          * Whether the losing account ports all its numbers (full) or keeps some (partial).
          */
         portType?: 'full' | 'partial';
+        /**
+         * Country-specific requirement values for international ports (from GET /v1/phone-numbers/port-in/requirements). Not needed for US/CA. The LOA and invoice requirements are satisfied automatically by loaDocumentId/invoiceDocumentId, and address-type requirements by the endUser service address.
+         */
+        requirements?: Array<{
+            /**
+             * The requirement's id, from the requirements endpoint.
+             */
+            requirementTypeId: string;
+            /**
+             * Text value, ISO datetime, or a documentId from POST /v1/phone-numbers/port-in/documents, per the requirement's kind.
+             */
+            fieldValue: string;
+        }>;
     };
 };
 
@@ -19729,7 +19790,7 @@ export type CreatePhoneNumberPortInResponse = ({
     }>;
 });
 
-export type CreatePhoneNumberPortInError = ({
+export type CreatePhoneNumberPortInError = (ErrorResponse | {
     error?: string;
 } | unknown);
 
@@ -19774,9 +19835,17 @@ export type CheckPhoneNumberPortabilityResponse = ({
          */
         fastPortable?: boolean;
         /**
-         * Line type when known (mobile, landline, voip…). A mobile number requires the transfer PIN at submit.
+         * Line type when known (mobile, landline, voip…). A US/CA mobile number requires the transfer PIN at submit.
          */
         lineType?: (string) | null;
+        /**
+         * ISO country of the number — pass it to GET /v1/phone-numbers/port-in/requirements for international numbers.
+         */
+        countryCode?: (string) | null;
+        /**
+         * Carrier number-type classification (local, mobile, national, toll_free…) — the numberType for the requirements endpoint.
+         */
+        phoneNumberType?: (string) | null;
         /**
          * Carrier reason when not portable; null when portable.
          */
@@ -19795,9 +19864,9 @@ export type UploadPhoneNumberPortInDocumentData = {
          */
         file: (Blob | File);
         /**
-         * Informational; used for the stored filename.
+         * 'loa', 'invoice', or any short slug for requirement documents. Informational; used for the stored filename.
          */
-        kind?: 'loa' | 'invoice';
+        kind?: string;
     };
 };
 
@@ -19809,6 +19878,79 @@ export type UploadPhoneNumberPortInDocumentError = (unknown | {
     error?: string;
 });
 
+export type GetPhoneNumberPortInRequirementsData = {
+    query: {
+        /**
+         * ISO country of the numbers being ported (a supported port-in country).
+         */
+        country: string;
+        /**
+         * The portability check's phoneNumberType — requirements differ by type.
+         */
+        numberType?: 'local' | 'mobile' | 'national' | 'toll_free';
+    };
+};
+
+export type GetPhoneNumberPortInRequirementsResponse = ({
+    country?: string;
+    numberType?: string;
+    /**
+     * false when the combination includes a step that can't be completed through the API (e.g. an in-person identity verification) — porting it needs support.
+     */
+    supported?: boolean;
+    fields?: Array<{
+        /**
+         * Pass back as requirements[].requirementTypeId.
+         */
+        requirementId?: string;
+        label?: string;
+        /**
+         * text/date take a string value; file takes a documentId from the documents endpoint; address is satisfied automatically from the end-user service address.
+         */
+        kind?: 'text' | 'date' | 'address' | 'file' | 'action';
+        description?: string;
+        example?: string;
+        /**
+         * When present, the value must be one of these.
+         */
+        acceptableValues?: Array<(string)>;
+    }>;
+});
+
+export type GetPhoneNumberPortInRequirementsError = (ErrorResponse | {
+    error?: string;
+} | unknown);
+
+export type GetPhoneNumberPortInOrderRequirementsData = {
+    path: {
+        /**
+         * Porting order ID (from the port-in list).
+         */
+        id: string;
+    };
+};
+
+export type GetPhoneNumberPortInOrderRequirementsResponse = ({
+    country?: string;
+    requirements?: Array<{
+        requirementId?: string;
+        label?: string;
+        kind?: 'text' | 'date' | 'address' | 'file' | 'action';
+        description?: string;
+        example?: string;
+        acceptableValues?: Array<(string)>;
+        /**
+         * requirement-info-pending | requirement-info-under-review | requirement-info-exception | approved
+         */
+        status?: string;
+        filled?: boolean;
+    }>;
+});
+
+export type GetPhoneNumberPortInOrderRequirementsError = (ErrorResponse | {
+    error?: string;
+} | unknown);
+
 export type CancelPhoneNumberPortInData = {
     path: {
         /**
@@ -24790,6 +24932,113 @@ export type GetAdsActivityLogError = (unknown | {
     error?: string;
 });
 
+export type CreateRfPredictionData = {
+    body: {
+        /**
+         * Zernio SocialAccount id (posting or ads variant).
+         */
+        accountId: string;
+        /**
+         * Meta ad account id (act_<n>).
+         */
+        adAccountId: string;
+        /**
+         * Whole currency units. Exactly one of budgetAmount / reach.
+         */
+        budgetAmount?: number;
+        /**
+         * Target unique reach. Exactly one of budgetAmount / reach.
+         */
+        reach?: number;
+        /**
+         * Campaign window start (must be in the future).
+         */
+        startDate: string;
+        endDate: string;
+        /**
+         * Max impressions per person over the window.
+         */
+        frequencyCap?: number;
+        /**
+         * Canonical camelCase TargetingSpec (same shape as /v1/ads/create's `targeting`). Defaults to countries: [US].
+         */
+        targeting?: {
+            [key: string]: unknown;
+        };
+        /**
+         * Meta placements object (same shape as /v1/ads/create's `placements`).
+         */
+        placements?: {
+            [key: string]: unknown;
+        };
+    };
+};
+
+export type CreateRfPredictionResponse = ({
+    adAccountId?: string;
+    currency?: string;
+    prediction?: RfPrediction;
+});
+
+export type CreateRfPredictionError = (unknown | {
+    error?: string;
+});
+
+export type GetRfPredictionData = {
+    path: {
+        predictionId: string;
+    };
+    query: {
+        accountId: string;
+        adAccountId: string;
+    };
+};
+
+export type GetRfPredictionResponse = ({
+    adAccountId?: string;
+    currency?: string;
+    prediction?: RfPrediction;
+});
+
+export type GetRfPredictionError = (unknown | {
+    error?: string;
+});
+
+export type CancelRfReservationData = {
+    path: {
+        predictionId: string;
+    };
+    query: {
+        accountId: string;
+        adAccountId: string;
+    };
+};
+
+export type CancelRfReservationResponse = (unknown);
+
+export type CancelRfReservationError = (unknown | {
+    error?: string;
+});
+
+export type ReserveRfPredictionData = {
+    body: {
+        accountId: string;
+        adAccountId: string;
+    };
+    path: {
+        predictionId: string;
+    };
+};
+
+export type ReserveRfPredictionResponse = ({
+    adAccountId?: string;
+    prediction?: RfPrediction;
+});
+
+export type ReserveRfPredictionError = (unknown | {
+    error?: string;
+});
+
 export type ListAdStudiesData = {
     query: {
         /**
@@ -25299,6 +25548,14 @@ export type CreateStandaloneAdData = {
          * Meta only. Explicit ad-set `billing_event`. Defaults to `IMPRESSIONS`. Forwarded verbatim to Meta, which validates compatibility with the optimization goal.
          */
         billingEvent?: string;
+        /**
+         * Meta only. RESERVED = Reach & Frequency: requires `rfPredictionId` (a RESERVED prediction from /v1/ads/rf-predictions + /reserve). Budget, schedule and pricing come from the reservation, so budgetAmount/budgetType are not required and bid fields are ignored. Only the plain single-ad shape (no creatives[], adSetId, existingCampaignId or dynamicCreative).
+         */
+        buyingType?: 'AUCTION' | 'RESERVED';
+        /**
+         * Meta only. The RESERVED prediction id the R&F ad set runs on (reserving mints a new id — pass that one). Requires buyingType RESERVED.
+         */
+        rfPredictionId?: string;
         /**
          * Required on legacy + multi-creative shapes. Inherited on attach.
          */