late-sdk 0.0.531 → 0.0.533

data/openapi.yaml

@@ -605,6 +605,23 @@ components:
                   effective_account_limit: 2000
                   current_account_count: 2000
   schemas:
+    RfPrediction:
+      type: object
+      description: A Meta Reach & Frequency prediction. Money values in whole units of the ad account currency.
+      properties:
+        predictionId: { type: string }
+        status: { type: string, description: "ready | pending | failed:<meta code>" }
+        budget: { type: [number, "null"], description: "Quoted (or provided) lifetime budget for the window." }
+        reach: { type: [integer, "null"], description: "Predicted (or requested) unique reach." }
+        impressions: { type: [integer, "null"] }
+        minBudget: { type: [number, "null"], description: "Meta's allowed lower bound for this spec." }
+        maxBudget: { type: [number, "null"] }
+        minReach: { type: [integer, "null"] }
+        maxReach: { type: [integer, "null"] }
+        frequencyCap: { type: [integer, "null"] }
+        startTime: { type: [integer, "null"], description: "Unix seconds; the reserved window the R&F ad set will run on." }
+        stopTime: { type: [integer, "null"] }
+        expiresAt: { type: [string, "null"], description: "When the reservation's locked price expires (set after reserving)." }
     CtwaAdRequestBody:
       type: object
       required: [accountId, adAccountId, name, budgetAmount, budgetType]
@@ -28184,10 +28201,18 @@ paths:
 
         Run the portability check (POST /v1/phone-numbers/port-in/check) and
         upload the two documents (POST /v1/phone-numbers/port-in/documents)
-        first. The carrier may split the numbers into several orders (by
-        country, number type, losing carrier); `orders` carries per-order
-        results, and a partial failure still returns 201 with the failed
-        orders' `error` set (they stay as cancellable drafts).
+        first — uploaded documents must be attached to an order within 30
+        minutes or the carrier deletes them, so upload right before this call.
+        The carrier may split the numbers into several orders (by country,
+        number type, losing carrier); `orders` carries per-order results, and a
+        partial failure still returns 201 with the failed orders' `error` set
+        (they stay as cancellable drafts).
+
+        Non-US/CA numbers additionally need the country-specific values from
+        GET /v1/phone-numbers/port-in/requirements, passed via `requirements`,
+        and must be submitted one country per request. When required
+        information is still missing after submission, the order is kept as a
+        resumable draft whose `error` / `declineReason` names the gaps.
       security:
         - bearerAuth: []
       requestBody:
@@ -28211,24 +28236,42 @@ paths:
                     losing carrier matches every field against its records and rejects the
                     whole port on a mismatch — enter values exactly as they appear on the
                     carrier bill.
-                  required: [entityName, authPersonName, accountNumber, streetAddress, locality, administrativeArea, postalCode, countryCode]
+                  required: [entityName, authPersonName, accountNumber, streetAddress, locality, postalCode, countryCode]
                   properties:
                     entityName: { type: string, description: "Account holder / business name, as on the carrier account." }
                     authPersonName: { type: string, description: "Full name (first + last) of the person authorizing the port — must match the LOA signature." }
                     billingPhoneNumber: { type: string, description: "Phone number on the losing carrier's bill. Defaults to the ported number itself on single-number orders. Validated as a real phone number when present." }
                     accountNumber: { type: string, description: "Account number with the losing carrier — required (carriers reject ports without it; on prepaid mobile plans it is often the phone number itself)." }
-                    pinPasscode: { type: string, description: "Transfer PIN. Required for mobile numbers (wireless carriers reject PIN-less ports). Forwarded to the carrier, never stored." }
+                    pinPasscode: { type: string, description: "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." }
+                    taxIdentifier: { type: string, maxLength: 50, description: "Company tax id on the carrier account (EU ports, e.g. Spanish CIF)." }
+                    businessIdentifier: { type: string, maxLength: 50, description: "Business registration id on the carrier account (EU ports)." }
                     streetAddress: { type: string }
                     extendedAddress: { type: string }
                     locality: { type: string }
-                    administrativeArea: { type: string, description: "2-letter US state / CA province code (full names are accepted and normalized)." }
-                    postalCode: { type: string, description: "US ZIP (5 digits) or Canadian postal code, matching countryCode." }
-                    countryCode: { type: string, minLength: 2, maxLength: 2, enum: [US, CA] }
+                    administrativeArea: { type: string, description: "Region. Required for US/CA as the 2-letter state/province code (full names are accepted and normalized); optional elsewhere." }
+                    postalCode: { type: string, description: "Postal code. Validated as a US ZIP / Canadian postal code for US/CA; free-form elsewhere." }
+                    countryCode: { type: string, minLength: 2, maxLength: 2, enum: [US, CA, GB, ES, DE, FR, NL, AU], description: "Service-address country (a supported port-in country)." }
                 loaDocumentId: { type: string, description: Document id from POST /v1/phone-numbers/port-in/documents (kind=loa). }
                 invoiceDocumentId: { type: string, description: Document id from POST /v1/phone-numbers/port-in/documents (kind=invoice). }
-                focDatetimeRequested: { type: string, format: date-time, description: "Requested port date; the carrier confirms the actual FOC later. Defaults to one week out (shifted off weekends) when omitted." }
+                focDatetimeRequested: { type: string, format: date-time, description: "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." }
                 customerReference: { type: string, maxLength: 100 }
                 portType: { type: string, enum: [full, partial], default: full, description: "Whether the losing account ports all its numbers (full) or keeps some (partial)." }
+                requirements:
+                  type: array
+                  maxItems: 30
+                  description: >-
+                    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.
+                  items:
+                    type: object
+                    required: [requirementTypeId, fieldValue]
+                    properties:
+                      requirementTypeId: { type: string, description: "The requirement's id, from the requirements endpoint." }
+                      fieldValue: { type: string, maxLength: 1000, description: "Text value, ISO datetime, or a documentId from POST /v1/phone-numbers/port-in/documents, per the requirement's kind." }
       responses:
         '201':
           description: Port submitted. Top-level fields mirror the first successfully submitted order; per-order truth (including failures) is in `orders`.
@@ -28251,9 +28294,10 @@ paths:
                         status: { type: string }
                         phoneNumbers: { type: array, items: { type: string } }
                         error: { type: string, description: Present when this split order failed to submit (it stays as a cancellable draft). }
+        '400': { $ref: '#/components/responses/BadRequest' }
         '401': { $ref: '#/components/responses/Unauthorized' }
         '409': { description: "A number is already provisioned, or already in an in-flight port" }
-        '422': { description: "A number is not portable (reason included), or every split order failed to submit" }
+        '422': { description: "A number is not portable (reason included), numbers span multiple non-US/CA countries, or every split order failed to submit" }
     get:
       operationId: listPhoneNumberPortIns
       tags: [Phone Numbers]
@@ -28331,7 +28375,9 @@ paths:
                         phoneNumber: { type: string }
                         portable: { type: boolean }
                         fastPortable: { type: boolean, description: Qualifies for the carrier's accelerated FastPort lane. }
-                        lineType: { type: [string, "null"], description: "Line type when known (mobile, landline, voip…). A mobile number requires the transfer PIN at submit." }
+                        lineType: { type: [string, "null"], description: "Line type when known (mobile, landline, voip…). A US/CA mobile number requires the transfer PIN at submit." }
+                        countryCode: { type: [string, "null"], description: "ISO country of the number — pass it to GET /v1/phone-numbers/port-in/requirements for international numbers." }
+                        phoneNumberType: { type: [string, "null"], description: "Carrier number-type classification (local, mobile, national, toll_free…) — the numberType for the requirements endpoint." }
                         notPortableReason: { type: [string, "null"], description: Carrier reason when not portable; null when portable. }
         '401': { $ref: '#/components/responses/Unauthorized' }
 
@@ -28341,9 +28387,13 @@ paths:
       tags: [Phone Numbers]
       summary: Upload a porting document
       description: |
-        Upload ONE porting document (the signed LOA or a recent carrier invoice)
-        and get back its `documentId`, which the port-in create request takes as
-        `loaDocumentId` / `invoiceDocumentId`. PDF, JPEG, or PNG, 10MB max.
+        Upload ONE porting document and get back its `documentId`. For the
+        signed LOA / carrier invoice the id goes to `loaDocumentId` /
+        `invoiceDocumentId`; for a country-specific document requirement
+        (international ports) it becomes that requirement's `fieldValue`.
+        Requirement documents are normalized to PDF automatically (regulators
+        reject raw images). PDF, JPEG, or PNG, 10MB max. Uploads must be
+        attached to an order within 30 minutes or the carrier deletes them.
       security:
         - bearerAuth: []
       requestBody:
@@ -28355,7 +28405,7 @@ paths:
               required: [file]
               properties:
                 file: { type: string, format: binary, description: "The document (PDF/JPEG/PNG, 10MB max)." }
-                kind: { type: string, enum: [loa, invoice], description: Informational; used for the stored filename. }
+                kind: { type: string, description: "'loa', 'invoice', or any short slug for requirement documents. Informational; used for the stored filename." }
       responses:
         '200':
           description: Document uploaded.
@@ -28368,6 +28418,90 @@ paths:
         '400': { description: "Missing file, file too large, or unsupported type" }
         '401': { $ref: '#/components/responses/Unauthorized' }
 
+  /v1/phone-numbers/port-in/requirements:
+    get:
+      operationId: getPhoneNumberPortInRequirements
+      tags: [Phone Numbers]
+      summary: Country porting requirements
+      description: |
+        The country-specific information a port-in needs BEYOND the LOA,
+        invoice, and account/address details — e.g. an ID copy, proof of
+        address, a tax id, or a porting code. Call it after the portability
+        check (which returns each number's `countryCode` and
+        `phoneNumberType`), render the fields, and pass the collected values as
+        the create request's `requirements`. US/CA return an empty list.
+      security:
+        - bearerAuth: []
+      parameters:
+        - { name: country, in: query, required: true, schema: { type: string, minLength: 2, maxLength: 2 }, description: "ISO country of the numbers being ported (a supported port-in country)." }
+        - { name: numberType, in: query, required: false, schema: { type: string, enum: [local, mobile, national, toll_free], default: local }, description: "The portability check's phoneNumberType — requirements differ by type." }
+      responses:
+        '200':
+          description: Requirement fields for the country/type combination.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  country: { type: string }
+                  numberType: { type: string }
+                  supported: { type: boolean, description: "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." }
+                  fields:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        requirementId: { type: string, description: "Pass back as requirements[].requirementTypeId." }
+                        label: { type: string }
+                        kind: { type: string, enum: [text, date, address, file, action], description: "text/date take a string value; file takes a documentId from the documents endpoint; address is satisfied automatically from the end-user service address." }
+                        description: { type: string }
+                        example: { type: string }
+                        acceptableValues: { type: array, items: { type: string }, description: "When present, the value must be one of these." }
+        '400': { $ref: '#/components/responses/BadRequest' }
+        '401': { $ref: '#/components/responses/Unauthorized' }
+        '422': { description: "Country not supported for port-in" }
+
+  /v1/phone-numbers/port-in/{id}/requirements:
+    get:
+      operationId: getPhoneNumberPortInOrderRequirements
+      tags: [Phone Numbers]
+      summary: A port-in order's pending requirements
+      description: |
+        The live requirements on an EXISTING porting order: which are filled,
+        which are still pending, and which bounced on review
+        (`requirement-info-exception`). Use it to fix and resubmit a rejected
+        international port. Same field shape as the country-level requirements
+        endpoint, plus per-requirement status.
+      security:
+        - bearerAuth: []
+      parameters:
+        - { name: id, in: path, required: true, schema: { type: string }, description: Porting order ID (from the port-in list). }
+      responses:
+        '200':
+          description: The order's requirements with statuses.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  country: { type: string }
+                  requirements:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        requirementId: { type: string }
+                        label: { type: string }
+                        kind: { type: string, enum: [text, date, address, file, action] }
+                        description: { type: string }
+                        example: { type: string }
+                        acceptableValues: { type: array, items: { type: string } }
+                        status: { type: string, description: "requirement-info-pending | requirement-info-under-review | requirement-info-exception | approved" }
+                        filled: { type: boolean }
+        '400': { $ref: '#/components/responses/BadRequest' }
+        '401': { $ref: '#/components/responses/Unauthorized' }
+        '404': { description: Porting order not found }
+
   /v1/phone-numbers/port-in/{id}:
     delete:
       operationId: cancelPhoneNumberPortIn
@@ -34182,6 +34316,137 @@ paths:
         '401': { $ref: '#/components/responses/Unauthorized' }
         '501': { description: Only supported on Meta (facebook/instagram) }
 
+  /v1/ads/rf-predictions:
+    post:
+      operationId: createRfPrediction
+      tags: [Ads]
+      summary: Create a Reach & Frequency prediction (Meta)
+      description: |-
+        Creates an R&F prediction — a QUOTE, nothing is bought and no ad entities are created.
+        Provide a date range plus exactly one of `budgetAmount` (Meta predicts reach) or `reach`
+        (Meta predicts the budget). The response carries the estimate and its allowed bounds
+        (min/max budget and reach). Predictions expire on their own; to buy, reserve one via
+        POST /v1/ads/rf-predictions/{predictionId}/reserve and pass the RESERVED id to
+        POST /v1/ads/create with `buyingType: "RESERVED"`.
+
+        Reservation campaigns reject automatic placements, so omitted `placements` default to
+        Facebook feed (+ Instagram stream when a linked IG professional account resolves);
+        Instagram placements require that IG account. Meta only.
+      security:
+        - bearerAuth: []
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [accountId, adAccountId, startDate, endDate]
+              properties:
+                accountId: { type: string, description: "Zernio SocialAccount id (posting or ads variant)." }
+                adAccountId: { type: string, description: "Meta ad account id (act_<n>)." }
+                budgetAmount: { type: number, description: "Whole currency units. Exactly one of budgetAmount / reach." }
+                reach: { type: integer, description: "Target unique reach. Exactly one of budgetAmount / reach." }
+                startDate: { type: string, format: date-time, description: "Campaign window start (must be in the future)." }
+                endDate: { type: string, format: date-time }
+                frequencyCap: { type: integer, minimum: 1, maximum: 90, description: "Max impressions per person over the window." }
+                targeting: { type: object, description: "Canonical camelCase TargetingSpec (same shape as /v1/ads/create's `targeting`). Defaults to countries: [US]." }
+                placements: { type: object, description: "Meta placements object (same shape as /v1/ads/create's `placements`)." }
+      responses:
+        '201':
+          description: Prediction created (usually ready within seconds)
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  adAccountId: { type: string }
+                  currency: { type: string }
+                  prediction: { $ref: '#/components/schemas/RfPrediction' }
+        '400': { description: "Invalid input, or Meta rejected the prediction — message carries Meta's error" }
+        '401': { $ref: '#/components/responses/Unauthorized' }
+        '422': { description: "No Facebook Page resolved for the account" }
+        '501': { description: Only supported on Meta (facebook/instagram) }
+
+  /v1/ads/rf-predictions/{predictionId}:
+    get:
+      operationId: getRfPrediction
+      tags: [Ads]
+      summary: Read a Reach & Frequency prediction (Meta)
+      security:
+        - bearerAuth: []
+      parameters:
+        - { name: predictionId, in: path, required: true, schema: { type: string } }
+        - { name: accountId, in: query, required: true, schema: { type: string } }
+        - { name: adAccountId, in: query, required: true, schema: { type: string } }
+      responses:
+        '200':
+          description: Prediction status and estimates
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  adAccountId: { type: string }
+                  currency: { type: string }
+                  prediction: { $ref: '#/components/schemas/RfPrediction' }
+        '400': { description: Invalid input }
+        '401': { $ref: '#/components/responses/Unauthorized' }
+        '501': { description: Only supported on Meta (facebook/instagram) }
+    delete:
+      operationId: cancelRfReservation
+      tags: [Ads]
+      summary: Cancel a Reach & Frequency reservation (Meta)
+      description: Releases a RESERVATION's locked price and inventory. Unreserved predictions expire on their own.
+      security:
+        - bearerAuth: []
+      parameters:
+        - { name: predictionId, in: path, required: true, schema: { type: string } }
+        - { name: accountId, in: query, required: true, schema: { type: string } }
+        - { name: adAccountId, in: query, required: true, schema: { type: string } }
+      responses:
+        '200':
+          description: Reservation cancelled
+        '400': { description: "Invalid input, or Meta rejected the cancel" }
+        '401': { $ref: '#/components/responses/Unauthorized' }
+        '501': { description: Only supported on Meta (facebook/instagram) }
+
+  /v1/ads/rf-predictions/{predictionId}/reserve:
+    post:
+      operationId: reserveRfPrediction
+      tags: [Ads]
+      summary: Reserve a Reach & Frequency prediction (Meta)
+      description: |-
+        Locks the quoted price + inventory until the returned `expiresAt` and mints a NEW
+        prediction id — pass that RESERVED id (not the original) as `rfPredictionId` on
+        POST /v1/ads/create. Release an unused reservation via DELETE. Meta only.
+      security:
+        - bearerAuth: []
+      parameters:
+        - { name: predictionId, in: path, required: true, schema: { type: string } }
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [accountId, adAccountId]
+              properties:
+                accountId: { type: string }
+                adAccountId: { type: string }
+      responses:
+        '201':
+          description: Reserved; `prediction.predictionId` is the new RESERVED id
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  adAccountId: { type: string }
+                  prediction: { $ref: '#/components/schemas/RfPrediction' }
+        '400': { description: "Invalid input, or Meta rejected the reserve" }
+        '401': { $ref: '#/components/responses/Unauthorized' }
+        '501': { description: Only supported on Meta (facebook/instagram) }
+
   /v1/ads/studies:
     get:
       operationId: listAdStudies
@@ -34734,6 +34999,8 @@ paths:
                     - For `lead_generation` or `conversions` on LinkedIn, or to promote an existing post, use POST /v1/ads/boost.
                 optimizationGoal: { type: string, description: "Meta only. Explicit ad-set `optimization_goal` (e.g. `LANDING_PAGE_VIEWS`, `LINK_CLICKS`, `REACH`, `IMPRESSIONS`, `OFFSITE_CONVERSIONS`, `THRUPLAY`, `LEAD_GENERATION`). Overrides the default derived from `goal` (e.g. `traffic` defaults to `LINK_CLICKS`). Forwarded verbatim to Meta, which validates compatibility with the campaign objective and rejects incompatible combinations." }
                 billingEvent: { type: string, description: "Meta only. Explicit ad-set `billing_event`. Defaults to `IMPRESSIONS`. Forwarded verbatim to Meta, which validates compatibility with the optimization goal." }
+                buyingType: { type: string, enum: [AUCTION, RESERVED], description: "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)." }
+                rfPredictionId: { type: string, description: "Meta only. The RESERVED prediction id the R&F ad set runs on (reserving mints a new id — pass that one). Requires buyingType RESERVED." }
                 budgetAmount: { type: number, description: "Required on legacy + multi-creative shapes. Inherited on attach." }
                 budgetType: { type: string, enum: [daily, lifetime], description: "Required on legacy + multi-creative shapes. Inherited on attach." }
                 status:

data/spec/api/ads_api_spec.rb

@@ -83,6 +83,20 @@ describe 'AdsApi' do
     end
   end
 
+  # unit tests for cancel_rf_reservation
+  # Cancel a Reach & Frequency reservation (Meta)
+  # Releases a RESERVATION's locked price and inventory. Unreserved predictions expire on their own.
+  # @param prediction_id 
+  # @param account_id 
+  # @param ad_account_id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'cancel_rf_reservation test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for create_ad_insights_report
   # Submit an async insights report run (Meta)
   # Submits an asynchronous Meta insights report. Same query surface as GET /v1/ads/insights, but in the JSON body; Meta processes the report server-side, which is the right choice for long ranges or large accounts where the sync query is slow or rate-limited. Returns a `reportRunId` to poll via GET /v1/ads/insights/reports/{reportRunId}. Meta only. 
@@ -156,6 +170,18 @@ describe 'AdsApi' do
     end
   end
 
+  # unit tests for create_rf_prediction
+  # Create a Reach & Frequency prediction (Meta)
+  # Creates an R&F prediction — a QUOTE, nothing is bought and no ad entities are created. Provide a date range plus exactly one of `budgetAmount` (Meta predicts reach) or `reach` (Meta predicts the budget). The response carries the estimate and its allowed bounds (min/max budget and reach). Predictions expire on their own; to buy, reserve one via POST /v1/ads/rf-predictions/{predictionId}/reserve and pass the RESERVED id to POST /v1/ads/create with `buyingType: \"RESERVED\"`.  Reservation campaigns reject automatic placements, so omitted `placements` default to Facebook feed (+ Instagram stream when a linked IG professional account resolves); Instagram placements require that IG account. Meta only.
+  # @param create_rf_prediction_request 
+  # @param [Hash] opts the optional parameters
+  # @return [CreateRfPrediction201Response]
+  describe 'create_rf_prediction test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for create_standalone_ad
   # Create standalone ad
   # Creates a paid ad with custom creative across Meta, Google Ads, Pinterest, TikTok, X/Twitter, and LinkedIn. Supports three mutually-exclusive request shapes selected by the body, a legacy single-creative shape (all platforms, default), a Meta-only multi-creative shape via the creatives array (one ad set with N ads sharing budget and targeting), and a Meta-only attach shape via adSetId (adds one new ad to an existing ad set). Per-platform required fields, budget minimums, and video-ad rules are documented on each property below. LinkedIn creates a Single Image or Single Video Ad backed by a Direct Sponsored Content \"dark post\" authored by a Company Page (see `organizationId`); supported goals are engagement, traffic, awareness, and video_views (video ads use the `video` field; video_views requires a video), and traffic ads require `linkUrl`.  **Idempotency:** this endpoint is not idempotent at the platform level (a blind retry creates a second campaign/ad set/ad). Send an `Idempotency-Key` header to make retries safe: the first request with a given key creates the ad and we store the response; a retry with the same key replays that exact response (with `Idempotent-Replayed: true`) instead of creating duplicates. Reusing a key with a different body returns 422; a key whose first request is still in flight returns 409 (retry after a short backoff). Keys are scoped to your credential and expire after 24h.
@@ -467,6 +493,19 @@ describe 'AdsApi' do
     end
   end
 
+  # unit tests for get_rf_prediction
+  # Read a Reach & Frequency prediction (Meta)
+  # @param prediction_id 
+  # @param account_id 
+  # @param ad_account_id 
+  # @param [Hash] opts the optional parameters
+  # @return [CreateRfPrediction201Response]
+  describe 'get_rf_prediction test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for list_ad_accounts
   # List ad accounts
   # Returns the platform ad accounts available for the given social account (e.g. Meta ad accounts, TikTok advertiser IDs, Google Ads customer IDs).  For TikTok agencies: enumerates every advertiser under every Business Center the token can read (paginated server-side), then chunks the lookup against TikTok's `/advertiser/info/` endpoint (which has a per-call cap of ≤100 IDs). Solo advertisers without a BC fall back to the OAuth-time `advertiser_ids` list. Cached for 1h on the SocialAccount; lazy-refreshed on first call after expiry. 
@@ -687,6 +726,19 @@ describe 'AdsApi' do
     end
   end
 
+  # unit tests for reserve_rf_prediction
+  # Reserve a Reach & Frequency prediction (Meta)
+  # Locks the quoted price + inventory until the returned `expiresAt` and mints a NEW prediction id — pass that RESERVED id (not the original) as `rfPredictionId` on POST /v1/ads/create. Release an unused reservation via DELETE. Meta only.
+  # @param prediction_id 
+  # @param reserve_rf_prediction_request 
+  # @param [Hash] opts the optional parameters
+  # @return [ReserveRfPrediction201Response]
+  describe 'reserve_rf_prediction test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for search_ad_interests
   # Search targeting interests
   # Deprecated alias for `GET /v1/ads/targeting/search?dimension=interest`. Kept for backward compatibility, it returns the legacy `{ interests: [...] }` shape rather than the normalized `{ results: [...] }`. New integrations should use `GET /v1/ads/targeting/search` with `dimension=interest`. 

data/spec/api/phone_numbers_api_spec.rb

@@ -83,7 +83,7 @@ describe 'PhoneNumbersApi' do
 
   # unit tests for create_phone_number_port_in
   # Port numbers in
-  # Submit a port-in for one or more existing numbers from another carrier. Creates the carrier order(s), attaches the end-user (current account) info plus the LOA and invoice documents, and submits to the losing carrier. The transfer PIN is forwarded to the carrier and never stored. Ported numbers arrive voice-ready (and SMS-ready where the order supports messaging).  Run the portability check (POST /v1/phone-numbers/port-in/check) and upload the two documents (POST /v1/phone-numbers/port-in/documents) first. The carrier may split the numbers into several orders (by country, number type, losing carrier); `orders` carries per-order results, and a partial failure still returns 201 with the failed orders' `error` set (they stay as cancellable drafts). 
+  # Submit a port-in for one or more existing numbers from another carrier. Creates the carrier order(s), attaches the end-user (current account) info plus the LOA and invoice documents, and submits to the losing carrier. The transfer PIN is forwarded to the carrier and never stored. Ported numbers arrive voice-ready (and SMS-ready where the order supports messaging).  Run the portability check (POST /v1/phone-numbers/port-in/check) and upload the two documents (POST /v1/phone-numbers/port-in/documents) first — uploaded documents must be attached to an order within 30 minutes or the carrier deletes them, so upload right before this call. The carrier may split the numbers into several orders (by country, number type, losing carrier); `orders` carries per-order results, and a partial failure still returns 201 with the failed orders' `error` set (they stay as cancellable drafts).  Non-US/CA numbers additionally need the country-specific values from GET /v1/phone-numbers/port-in/requirements, passed via `requirements`, and must be submitted one country per request. When required information is still missing after submission, the order is kept as a resumable draft whose `error` / `declineReason` names the gaps. 
   # @param create_phone_number_port_in_request 
   # @param [Hash] opts the optional parameters
   # @return [CreatePhoneNumberPortIn201Response]
@@ -118,6 +118,31 @@ describe 'PhoneNumbersApi' do
     end
   end
 
+  # unit tests for get_phone_number_port_in_order_requirements
+  # A port-in order's pending requirements
+  # The live requirements on an EXISTING porting order: which are filled, which are still pending, and which bounced on review (`requirement-info-exception`). Use it to fix and resubmit a rejected international port. Same field shape as the country-level requirements endpoint, plus per-requirement status. 
+  # @param id Porting order ID (from the port-in list).
+  # @param [Hash] opts the optional parameters
+  # @return [GetPhoneNumberPortInOrderRequirements200Response]
+  describe 'get_phone_number_port_in_order_requirements test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_phone_number_port_in_requirements
+  # Country porting requirements
+  # The country-specific information a port-in needs BEYOND the LOA, invoice, and account/address details — e.g. an ID copy, proof of address, a tax id, or a porting code. Call it after the portability check (which returns each number's `countryCode` and `phoneNumberType`), render the fields, and pass the collected values as the create request's `requirements`. US/CA return an empty list. 
+  # @param country ISO country of the numbers being ported (a supported port-in country).
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :number_type The portability check's phoneNumberType — requirements differ by type.
+  # @return [GetPhoneNumberPortInRequirements200Response]
+  describe 'get_phone_number_port_in_requirements test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for get_phone_number_remediation
   # Get declined requirements
   # For a number in `regulatory_declined`, returns ONLY the requirements the reviewer flagged declined, as a form spec (same shape as the KYC form GET). The customer fixes just those — Telnyx supports correcting a declined requirement group and re-submitting it (no new number/group). Falls back to the full spec if the provider exposes no per-requirement flags. 
@@ -259,10 +284,10 @@ describe 'PhoneNumbersApi' do
 
   # unit tests for upload_phone_number_port_in_document
   # Upload a porting document
-  # Upload ONE porting document (the signed LOA or a recent carrier invoice) and get back its `documentId`, which the port-in create request takes as `loaDocumentId` / `invoiceDocumentId`. PDF, JPEG, or PNG, 10MB max. 
+  # Upload ONE porting document and get back its `documentId`. For the signed LOA / carrier invoice the id goes to `loaDocumentId` / `invoiceDocumentId`; for a country-specific document requirement (international ports) it becomes that requirement's `fieldValue`. Requirement documents are normalized to PDF automatically (regulators reject raw images). PDF, JPEG, or PNG, 10MB max. Uploads must be attached to an order within 30 minutes or the carrier deletes them. 
   # @param file The document (PDF/JPEG/PNG, 10MB max).
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :kind Informational; used for the stored filename.
+  # @option opts [String] :kind 'loa', 'invoice', or any short slug for requirement documents. Informational; used for the stored filename.
   # @return [UploadPhoneNumberPortInDocument200Response]
   describe 'upload_phone_number_port_in_document test' do
     it 'should work' do

data/spec/models/check_phone_number_portability200_response_results_inner_spec.rb

@@ -51,6 +51,18 @@ describe Zernio::CheckPhoneNumberPortability200ResponseResultsInner do
     end
   end
 
+  describe 'test attribute "country_code"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "phone_number_type"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "not_portable_reason"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

data/spec/models/create_phone_number_port_in_request_end_user_spec.rb

@@ -57,6 +57,18 @@ describe Zernio::CreatePhoneNumberPortInRequestEndUser do
     end
   end
 
+  describe 'test attribute "tax_identifier"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "business_identifier"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "street_address"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -90,7 +102,7 @@ describe Zernio::CreatePhoneNumberPortInRequestEndUser do
   describe 'test attribute "country_code"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["US", "CA"])
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["US", "CA", "GB", "ES", "DE", "FR", "NL", "AU"])
       # validator.allowable_values.each do |value|
       #   expect { instance.country_code = value }.not_to raise_error
       # end

data/spec/models/create_phone_number_port_in_request_requirements_inner_spec.rb

@@ -0,0 +1,42 @@
+=begin
+#Zernio API
+
+#API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api 
+
+The version of the OpenAPI document: 1.0.4
+Contact: support@zernio.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Zernio::CreatePhoneNumberPortInRequestRequirementsInner
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe Zernio::CreatePhoneNumberPortInRequestRequirementsInner do
+  #let(:instance) { Zernio::CreatePhoneNumberPortInRequestRequirementsInner.new }
+
+  describe 'test an instance of CreatePhoneNumberPortInRequestRequirementsInner' do
+    it 'should create an instance of CreatePhoneNumberPortInRequestRequirementsInner' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(Zernio::CreatePhoneNumberPortInRequestRequirementsInner)
+    end
+  end
+
+  describe 'test attribute "requirement_type_id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "field_value"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/create_phone_number_port_in_request_spec.rb

@@ -73,4 +73,10 @@ describe Zernio::CreatePhoneNumberPortInRequest do
     end
   end
 
+  describe 'test attribute "requirements"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
 end