late-sdk 0.0.531 → 0.0.533

data/lib/zernio-sdk/api/ads_api.rb

@@ -305,6 +305,83 @@ module Zernio
       return data, status_code, headers
     end
 
+    # Cancel a Reach & Frequency reservation (Meta)
+    # Releases a RESERVATION's locked price and inventory. Unreserved predictions expire on their own.
+    # @param prediction_id [String] 
+    # @param account_id [String] 
+    # @param ad_account_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def cancel_rf_reservation(prediction_id, account_id, ad_account_id, opts = {})
+      cancel_rf_reservation_with_http_info(prediction_id, account_id, ad_account_id, opts)
+      nil
+    end
+
+    # Cancel a Reach & Frequency reservation (Meta)
+    # Releases a RESERVATION's locked price and inventory. Unreserved predictions expire on their own.
+    # @param prediction_id [String] 
+    # @param account_id [String] 
+    # @param ad_account_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def cancel_rf_reservation_with_http_info(prediction_id, account_id, ad_account_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AdsApi.cancel_rf_reservation ...'
+      end
+      # verify the required parameter 'prediction_id' is set
+      if @api_client.config.client_side_validation && prediction_id.nil?
+        fail ArgumentError, "Missing the required parameter 'prediction_id' when calling AdsApi.cancel_rf_reservation"
+      end
+      # verify the required parameter 'account_id' is set
+      if @api_client.config.client_side_validation && account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'account_id' when calling AdsApi.cancel_rf_reservation"
+      end
+      # verify the required parameter 'ad_account_id' is set
+      if @api_client.config.client_side_validation && ad_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdsApi.cancel_rf_reservation"
+      end
+      # resource path
+      local_var_path = '/v1/ads/rf-predictions/{predictionId}'.sub('{' + 'predictionId' + '}', CGI.escape(prediction_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'accountId'] = account_id
+      query_params[:'adAccountId'] = ad_account_id
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AdsApi.cancel_rf_reservation",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AdsApi#cancel_rf_reservation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # 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. 
     # @param create_ad_insights_report_request [CreateAdInsightsReportRequest] 
@@ -719,6 +796,74 @@ module Zernio
       return data, status_code, headers
     end
 
+    # 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 [CreateRfPredictionRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateRfPrediction201Response]
+    def create_rf_prediction(create_rf_prediction_request, opts = {})
+      data, _status_code, _headers = create_rf_prediction_with_http_info(create_rf_prediction_request, opts)
+      data
+    end
+
+    # Create a Reach &amp; Frequency prediction (Meta)
+    # Creates an R&amp;F prediction — a QUOTE, nothing is bought and no ad entities are created. Provide a date range plus exactly one of &#x60;budgetAmount&#x60; (Meta predicts reach) or &#x60;reach&#x60; (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 &#x60;buyingType: \&quot;RESERVED\&quot;&#x60;.  Reservation campaigns reject automatic placements, so omitted &#x60;placements&#x60; 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 [CreateRfPredictionRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateRfPrediction201Response, Integer, Hash)>] CreateRfPrediction201Response data, response status code and response headers
+    def create_rf_prediction_with_http_info(create_rf_prediction_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AdsApi.create_rf_prediction ...'
+      end
+      # verify the required parameter 'create_rf_prediction_request' is set
+      if @api_client.config.client_side_validation && create_rf_prediction_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_rf_prediction_request' when calling AdsApi.create_rf_prediction"
+      end
+      # resource path
+      local_var_path = '/v1/ads/rf-predictions'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_rf_prediction_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateRfPrediction201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AdsApi.create_rf_prediction",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AdsApi#create_rf_prediction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # 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.
     # @param create_standalone_ad_request [CreateStandaloneAdRequest] 
@@ -2407,6 +2552,81 @@ module Zernio
       return data, status_code, headers
     end
 
+    # Read a Reach & Frequency prediction (Meta)
+    # @param prediction_id [String] 
+    # @param account_id [String] 
+    # @param ad_account_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateRfPrediction201Response]
+    def get_rf_prediction(prediction_id, account_id, ad_account_id, opts = {})
+      data, _status_code, _headers = get_rf_prediction_with_http_info(prediction_id, account_id, ad_account_id, opts)
+      data
+    end
+
+    # Read a Reach &amp; Frequency prediction (Meta)
+    # @param prediction_id [String] 
+    # @param account_id [String] 
+    # @param ad_account_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateRfPrediction201Response, Integer, Hash)>] CreateRfPrediction201Response data, response status code and response headers
+    def get_rf_prediction_with_http_info(prediction_id, account_id, ad_account_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AdsApi.get_rf_prediction ...'
+      end
+      # verify the required parameter 'prediction_id' is set
+      if @api_client.config.client_side_validation && prediction_id.nil?
+        fail ArgumentError, "Missing the required parameter 'prediction_id' when calling AdsApi.get_rf_prediction"
+      end
+      # verify the required parameter 'account_id' is set
+      if @api_client.config.client_side_validation && account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'account_id' when calling AdsApi.get_rf_prediction"
+      end
+      # verify the required parameter 'ad_account_id' is set
+      if @api_client.config.client_side_validation && ad_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdsApi.get_rf_prediction"
+      end
+      # resource path
+      local_var_path = '/v1/ads/rf-predictions/{predictionId}'.sub('{' + 'predictionId' + '}', CGI.escape(prediction_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'accountId'] = account_id
+      query_params[:'adAccountId'] = ad_account_id
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateRfPrediction201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AdsApi.get_rf_prediction",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AdsApi#get_rf_prediction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # 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. 
     # @param account_id [String] Social account ID
@@ -3564,6 +3784,80 @@ module Zernio
       return data, status_code, headers
     end
 
+    # 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 [String] 
+    # @param reserve_rf_prediction_request [ReserveRfPredictionRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [ReserveRfPrediction201Response]
+    def reserve_rf_prediction(prediction_id, reserve_rf_prediction_request, opts = {})
+      data, _status_code, _headers = reserve_rf_prediction_with_http_info(prediction_id, reserve_rf_prediction_request, opts)
+      data
+    end
+
+    # Reserve a Reach &amp; Frequency prediction (Meta)
+    # Locks the quoted price + inventory until the returned &#x60;expiresAt&#x60; and mints a NEW prediction id — pass that RESERVED id (not the original) as &#x60;rfPredictionId&#x60; on POST /v1/ads/create. Release an unused reservation via DELETE. Meta only.
+    # @param prediction_id [String] 
+    # @param reserve_rf_prediction_request [ReserveRfPredictionRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ReserveRfPrediction201Response, Integer, Hash)>] ReserveRfPrediction201Response data, response status code and response headers
+    def reserve_rf_prediction_with_http_info(prediction_id, reserve_rf_prediction_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AdsApi.reserve_rf_prediction ...'
+      end
+      # verify the required parameter 'prediction_id' is set
+      if @api_client.config.client_side_validation && prediction_id.nil?
+        fail ArgumentError, "Missing the required parameter 'prediction_id' when calling AdsApi.reserve_rf_prediction"
+      end
+      # verify the required parameter 'reserve_rf_prediction_request' is set
+      if @api_client.config.client_side_validation && reserve_rf_prediction_request.nil?
+        fail ArgumentError, "Missing the required parameter 'reserve_rf_prediction_request' when calling AdsApi.reserve_rf_prediction"
+      end
+      # resource path
+      local_var_path = '/v1/ads/rf-predictions/{predictionId}/reserve'.sub('{' + 'predictionId' + '}', CGI.escape(prediction_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(reserve_rf_prediction_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ReserveRfPrediction201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AdsApi.reserve_rf_prediction",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AdsApi#reserve_rf_prediction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # 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`. 
     # @param q [String] Search query

data/lib/zernio-sdk/api/phone_numbers_api.rb

@@ -290,7 +290,7 @@ module Zernio
     end
 
     # 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 [CreatePhoneNumberPortInRequest] 
     # @param [Hash] opts the optional parameters
     # @return [CreatePhoneNumberPortIn201Response]
@@ -300,7 +300,7 @@ module Zernio
     end
 
     # 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 [CreatePhoneNumberPortInRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(CreatePhoneNumberPortIn201Response, Integer, Hash)>] CreatePhoneNumberPortIn201Response data, response status code and response headers
@@ -491,6 +491,148 @@ module Zernio
       return data, status_code, headers
     end
 
+    # 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 [String] Porting order ID (from the port-in list).
+    # @param [Hash] opts the optional parameters
+    # @return [GetPhoneNumberPortInOrderRequirements200Response]
+    def get_phone_number_port_in_order_requirements(id, opts = {})
+      data, _status_code, _headers = get_phone_number_port_in_order_requirements_with_http_info(id, opts)
+      data
+    end
+
+    # A port-in order&#39;s pending requirements
+    # The live requirements on an EXISTING porting order: which are filled, which are still pending, and which bounced on review (&#x60;requirement-info-exception&#x60;). 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 [String] Porting order ID (from the port-in list).
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetPhoneNumberPortInOrderRequirements200Response, Integer, Hash)>] GetPhoneNumberPortInOrderRequirements200Response data, response status code and response headers
+    def get_phone_number_port_in_order_requirements_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PhoneNumbersApi.get_phone_number_port_in_order_requirements ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling PhoneNumbersApi.get_phone_number_port_in_order_requirements"
+      end
+      # resource path
+      local_var_path = '/v1/phone-numbers/port-in/{id}/requirements'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetPhoneNumberPortInOrderRequirements200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"PhoneNumbersApi.get_phone_number_port_in_order_requirements",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PhoneNumbersApi#get_phone_number_port_in_order_requirements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 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 [String] 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&#39;s phoneNumberType — requirements differ by type. (default to 'local')
+    # @return [GetPhoneNumberPortInRequirements200Response]
+    def get_phone_number_port_in_requirements(country, opts = {})
+      data, _status_code, _headers = get_phone_number_port_in_requirements_with_http_info(country, opts)
+      data
+    end
+
+    # 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&#39;s &#x60;countryCode&#x60; and &#x60;phoneNumberType&#x60;), render the fields, and pass the collected values as the create request&#39;s &#x60;requirements&#x60;. US/CA return an empty list. 
+    # @param country [String] 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&#39;s phoneNumberType — requirements differ by type. (default to 'local')
+    # @return [Array<(GetPhoneNumberPortInRequirements200Response, Integer, Hash)>] GetPhoneNumberPortInRequirements200Response data, response status code and response headers
+    def get_phone_number_port_in_requirements_with_http_info(country, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PhoneNumbersApi.get_phone_number_port_in_requirements ...'
+      end
+      # verify the required parameter 'country' is set
+      if @api_client.config.client_side_validation && country.nil?
+        fail ArgumentError, "Missing the required parameter 'country' when calling PhoneNumbersApi.get_phone_number_port_in_requirements"
+      end
+      if @api_client.config.client_side_validation && country.to_s.length > 2
+        fail ArgumentError, 'invalid value for "country" when calling PhoneNumbersApi.get_phone_number_port_in_requirements, the character length must be smaller than or equal to 2.'
+      end
+
+      if @api_client.config.client_side_validation && country.to_s.length < 2
+        fail ArgumentError, 'invalid value for "country" when calling PhoneNumbersApi.get_phone_number_port_in_requirements, the character length must be greater than or equal to 2.'
+      end
+
+      allowable_values = ["local", "mobile", "national", "toll_free"]
+      if @api_client.config.client_side_validation && opts[:'number_type'] && !allowable_values.include?(opts[:'number_type'])
+        fail ArgumentError, "invalid value for \"number_type\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/v1/phone-numbers/port-in/requirements'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'country'] = country
+      query_params[:'numberType'] = opts[:'number_type'] if !opts[:'number_type'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetPhoneNumberPortInRequirements200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"PhoneNumbersApi.get_phone_number_port_in_requirements",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PhoneNumbersApi#get_phone_number_port_in_requirements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # 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. 
     # @param id [String] Phone number record ID.
@@ -1234,10 +1376,10 @@ module Zernio
     end
 
     # 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 [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 &#39;loa&#39;, &#39;invoice&#39;, or any short slug for requirement documents. Informational; used for the stored filename.
     # @return [UploadPhoneNumberPortInDocument200Response]
     def upload_phone_number_port_in_document(file, opts = {})
       data, _status_code, _headers = upload_phone_number_port_in_document_with_http_info(file, opts)
@@ -1245,10 +1387,10 @@ module Zernio
     end
 
     # Upload a porting document
-    # Upload ONE porting document (the signed LOA or a recent carrier invoice) and get back its &#x60;documentId&#x60;, which the port-in create request takes as &#x60;loaDocumentId&#x60; / &#x60;invoiceDocumentId&#x60;. PDF, JPEG, or PNG, 10MB max. 
+    # Upload ONE porting document and get back its &#x60;documentId&#x60;. For the signed LOA / carrier invoice the id goes to &#x60;loaDocumentId&#x60; / &#x60;invoiceDocumentId&#x60;; for a country-specific document requirement (international ports) it becomes that requirement&#39;s &#x60;fieldValue&#x60;. 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 [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 &#39;loa&#39;, &#39;invoice&#39;, or any short slug for requirement documents. Informational; used for the stored filename.
     # @return [Array<(UploadPhoneNumberPortInDocument200Response, Integer, Hash)>] UploadPhoneNumberPortInDocument200Response data, response status code and response headers
     def upload_phone_number_port_in_document_with_http_info(file, opts = {})
       if @api_client.config.debugging
@@ -1258,10 +1400,6 @@ module Zernio
       if @api_client.config.client_side_validation && file.nil?
         fail ArgumentError, "Missing the required parameter 'file' when calling PhoneNumbersApi.upload_phone_number_port_in_document"
       end
-      allowable_values = ["loa", "invoice"]
-      if @api_client.config.client_side_validation && opts[:'kind'] && !allowable_values.include?(opts[:'kind'])
-        fail ArgumentError, "invalid value for \"kind\", must be one of #{allowable_values}"
-      end
       # resource path
       local_var_path = '/v1/phone-numbers/port-in/documents'
 

data/lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb

@@ -22,9 +22,15 @@ module Zernio
     # Qualifies for the carrier's accelerated FastPort lane.
     attr_accessor :fast_portable
 
-    # 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.
     attr_accessor :line_type
 
+    # ISO country of the number — pass it to GET /v1/phone-numbers/port-in/requirements for international numbers.
+    attr_accessor :country_code
+
+    # Carrier number-type classification (local, mobile, national, toll_free…) — the numberType for the requirements endpoint.
+    attr_accessor :phone_number_type
+
     # Carrier reason when not portable; null when portable.
     attr_accessor :not_portable_reason
 
@@ -35,6 +41,8 @@ module Zernio
         :'portable' => :'portable',
         :'fast_portable' => :'fastPortable',
         :'line_type' => :'lineType',
+        :'country_code' => :'countryCode',
+        :'phone_number_type' => :'phoneNumberType',
         :'not_portable_reason' => :'notPortableReason'
       }
     end
@@ -56,6 +64,8 @@ module Zernio
         :'portable' => :'Boolean',
         :'fast_portable' => :'Boolean',
         :'line_type' => :'String',
+        :'country_code' => :'String',
+        :'phone_number_type' => :'String',
         :'not_portable_reason' => :'String'
       }
     end
@@ -64,6 +74,8 @@ module Zernio
     def self.openapi_nullable
       Set.new([
         :'line_type',
+        :'country_code',
+        :'phone_number_type',
         :'not_portable_reason'
       ])
     end
@@ -100,6 +112,14 @@ module Zernio
         self.line_type = attributes[:'line_type']
       end
 
+      if attributes.key?(:'country_code')
+        self.country_code = attributes[:'country_code']
+      end
+
+      if attributes.key?(:'phone_number_type')
+        self.phone_number_type = attributes[:'phone_number_type']
+      end
+
       if attributes.key?(:'not_portable_reason')
         self.not_portable_reason = attributes[:'not_portable_reason']
       end
@@ -129,6 +149,8 @@ module Zernio
           portable == o.portable &&
           fast_portable == o.fast_portable &&
           line_type == o.line_type &&
+          country_code == o.country_code &&
+          phone_number_type == o.phone_number_type &&
           not_portable_reason == o.not_portable_reason
     end
 
@@ -141,7 +163,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [phone_number, portable, fast_portable, line_type, not_portable_reason].hash
+      [phone_number, portable, fast_portable, line_type, country_code, phone_number_type, not_portable_reason].hash
     end
 
     # Builds the object from hash