zernio-sdk 0.0.531 → 0.0.533

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eaa5f26849657a92627dca36e035af7aebc2f4a966c08b7d997ba4708c20ee89
-  data.tar.gz: d363d35b4b938148821659d8d51ea2860e0eae73f71c1acc078a7101c915305b
+  metadata.gz: 672e78e5f11272b5a89080eb85d5f6acf82bd6eedd406c7fc3b2a07f54e79adc
+  data.tar.gz: b82290e579ddb86b52baadd6ea2f517aaf57bb5cdd67c50df656cd5918388b4a
 SHA512:
-  metadata.gz: becc912c9e3733c3d2b0db5f32416a246da50d584735c75ee4f18465e59fc46932c6140474cea5a8fe9b00927110bd94d988a211c5c9696775481038ba07a01c
-  data.tar.gz: 294b76a7f76b4f716efb3b8e3c095166a39a9b4a0a7b59c3e0b67d9fff4c89ff1f71d7258765fbb4f398f9c0287fcc33d6fe4dd9e56789fb82e4fc9aa45f597c
+  metadata.gz: f48c0fdd733cf16ee7181d46dbbeefbf8802374397ebc4038c505e68f2afbf36688d636457dbfefe4130636db276da16efcab826761dbe27c2c3c538363f54d6
+  data.tar.gz: '0739f8bb10a105d90588605fc38a9777d90537fa35a44a54b393a68214d8dd42fc9972c5f22b62c1a62ba1707b5f5af4b68e0c85a3f22eff753c91f73d42f945'

data/README.md

@@ -111,12 +111,14 @@ Class | Method | HTTP request | Description
 *Zernio::AdsApi* | [**adjust_conversions**](docs/AdsApi.md#adjust_conversions) | **POST** /v1/ads/conversions/adjustments | Adjust uploaded conversions
 *Zernio::AdsApi* | [**archive_lead_form**](docs/AdsApi.md#archive_lead_form) | **DELETE** /v1/ads/lead-forms/{formId} | Archive a lead form
 *Zernio::AdsApi* | [**boost_post**](docs/AdsApi.md#boost_post) | **POST** /v1/ads/boost | Boost post as ad
+*Zernio::AdsApi* | [**cancel_rf_reservation**](docs/AdsApi.md#cancel_rf_reservation) | **DELETE** /v1/ads/rf-predictions/{predictionId} | Cancel a Reach & Frequency reservation (Meta)
 *Zernio::AdsApi* | [**create_ad_insights_report**](docs/AdsApi.md#create_ad_insights_report) | **POST** /v1/ads/insights/reports | Submit an async insights report run (Meta)
 *Zernio::AdsApi* | [**create_call_ad**](docs/AdsApi.md#create_call_ad) | **POST** /v1/ads/call | Create Click-to-Call ad
 *Zernio::AdsApi* | [**create_conversion_destination**](docs/AdsApi.md#create_conversion_destination) | **POST** /v1/accounts/{accountId}/conversion-destinations | Create a conversion destination
 *Zernio::AdsApi* | [**create_ctwa_ad**](docs/AdsApi.md#create_ctwa_ad) | **POST** /v1/ads/ctwa | Create Click-to-WhatsApp ad (deprecated)
 *Zernio::AdsApi* | [**create_lead_form**](docs/AdsApi.md#create_lead_form) | **POST** /v1/ads/lead-forms | Create a lead form
 *Zernio::AdsApi* | [**create_messaging_ad**](docs/AdsApi.md#create_messaging_ad) | **POST** /v1/ads/messaging | Create click-to-message ad (WhatsApp / Messenger / Instagram Direct)
+*Zernio::AdsApi* | [**create_rf_prediction**](docs/AdsApi.md#create_rf_prediction) | **POST** /v1/ads/rf-predictions | Create a Reach & Frequency prediction (Meta)
 *Zernio::AdsApi* | [**create_standalone_ad**](docs/AdsApi.md#create_standalone_ad) | **POST** /v1/ads/create | Create standalone ad
 *Zernio::AdsApi* | [**create_test_lead**](docs/AdsApi.md#create_test_lead) | **POST** /v1/ads/lead-forms/{formId}/test-leads | Create a test lead
 *Zernio::AdsApi* | [**delete_ad**](docs/AdsApi.md#delete_ad) | **DELETE** /v1/ads/{adId} | Cancel an ad
@@ -140,6 +142,7 @@ Class | Method | HTTP request | Description
 *Zernio::AdsApi* | [**get_lead_form**](docs/AdsApi.md#get_lead_form) | **GET** /v1/ads/lead-forms/{formId} | Get a lead form
 *Zernio::AdsApi* | [**get_linked_in_bid_pricing**](docs/AdsApi.md#get_linked_in_bid_pricing) | **POST** /v1/ads/targeting/bid-pricing | Suggested bid and budget bounds (LinkedIn)
 *Zernio::AdsApi* | [**get_linked_in_supply_forecast**](docs/AdsApi.md#get_linked_in_supply_forecast) | **POST** /v1/ads/targeting/supply-forecast | Impressions, clicks and spend forecast (LinkedIn)
+*Zernio::AdsApi* | [**get_rf_prediction**](docs/AdsApi.md#get_rf_prediction) | **GET** /v1/ads/rf-predictions/{predictionId} | Read a Reach & Frequency prediction (Meta)
 *Zernio::AdsApi* | [**list_ad_accounts**](docs/AdsApi.md#list_ad_accounts) | **GET** /v1/ads/accounts | List ad accounts
 *Zernio::AdsApi* | [**list_ad_catalog_product_sets**](docs/AdsApi.md#list_ad_catalog_product_sets) | **GET** /v1/ads/catalogs/{catalogId}/product-sets | List a catalog's product sets
 *Zernio::AdsApi* | [**list_ad_catalogs**](docs/AdsApi.md#list_ad_catalogs) | **GET** /v1/ads/catalogs | List Meta product catalogs
@@ -154,6 +157,7 @@ Class | Method | HTTP request | Description
 *Zernio::AdsApi* | [**list_whats_app_conversions**](docs/AdsApi.md#list_whats_app_conversions) | **GET** /v1/whatsapp/conversions | List conversion events
 *Zernio::AdsApi* | [**query_ad_insights**](docs/AdsApi.md#query_ad_insights) | **GET** /v1/ads/insights | Flexible live insights query (Meta)
 *Zernio::AdsApi* | [**remove_conversion_associations**](docs/AdsApi.md#remove_conversion_associations) | **DELETE** /v1/accounts/{accountId}/conversion-destinations/{destinationId}/associations | Remove associated campaigns
+*Zernio::AdsApi* | [**reserve_rf_prediction**](docs/AdsApi.md#reserve_rf_prediction) | **POST** /v1/ads/rf-predictions/{predictionId}/reserve | Reserve a Reach & Frequency prediction (Meta)
 *Zernio::AdsApi* | [**search_ad_interests**](docs/AdsApi.md#search_ad_interests) | **GET** /v1/ads/interests | Search targeting interests
 *Zernio::AdsApi* | [**search_ad_targeting**](docs/AdsApi.md#search_ad_targeting) | **GET** /v1/ads/targeting/search | Search targeting options
 *Zernio::AdsApi* | [**send_conversions**](docs/AdsApi.md#send_conversions) | **POST** /v1/ads/conversions | Send conversion events
@@ -354,6 +358,8 @@ Class | Method | HTTP request | Description
 *Zernio::PhoneNumbersApi* | [**create_phone_number_port_in**](docs/PhoneNumbersApi.md#create_phone_number_port_in) | **POST** /v1/phone-numbers/port-in | Port numbers in
 *Zernio::PhoneNumbersApi* | [**get_phone_number**](docs/PhoneNumbersApi.md#get_phone_number) | **GET** /v1/phone-numbers/{id} | Get phone number
 *Zernio::PhoneNumbersApi* | [**get_phone_number_kyc_form**](docs/PhoneNumbersApi.md#get_phone_number_kyc_form) | **GET** /v1/phone-numbers/kyc | Get KYC form spec
+*Zernio::PhoneNumbersApi* | [**get_phone_number_port_in_order_requirements**](docs/PhoneNumbersApi.md#get_phone_number_port_in_order_requirements) | **GET** /v1/phone-numbers/port-in/{id}/requirements | A port-in order's pending requirements
+*Zernio::PhoneNumbersApi* | [**get_phone_number_port_in_requirements**](docs/PhoneNumbersApi.md#get_phone_number_port_in_requirements) | **GET** /v1/phone-numbers/port-in/requirements | Country porting requirements
 *Zernio::PhoneNumbersApi* | [**get_phone_number_remediation**](docs/PhoneNumbersApi.md#get_phone_number_remediation) | **GET** /v1/phone-numbers/{id}/remediate | Get declined requirements
 *Zernio::PhoneNumbersApi* | [**list_phone_number_countries**](docs/PhoneNumbersApi.md#list_phone_number_countries) | **GET** /v1/phone-numbers/countries | List offerable number countries
 *Zernio::PhoneNumbersApi* | [**list_phone_number_port_ins**](docs/PhoneNumbersApi.md#list_phone_number_port_ins) | **GET** /v1/phone-numbers/port-in | List port-in orders
@@ -757,6 +763,7 @@ Class | Method | HTTP request | Description
  - [Zernio::CreatePhoneNumberPortIn201ResponseOrdersInner](docs/CreatePhoneNumberPortIn201ResponseOrdersInner.md)
  - [Zernio::CreatePhoneNumberPortInRequest](docs/CreatePhoneNumberPortInRequest.md)
  - [Zernio::CreatePhoneNumberPortInRequestEndUser](docs/CreatePhoneNumberPortInRequestEndUser.md)
+ - [Zernio::CreatePhoneNumberPortInRequestRequirementsInner](docs/CreatePhoneNumberPortInRequestRequirementsInner.md)
  - [Zernio::CreatePinterestBoard201Response](docs/CreatePinterestBoard201Response.md)
  - [Zernio::CreatePinterestBoard201ResponseBoard](docs/CreatePinterestBoard201ResponseBoard.md)
  - [Zernio::CreatePinterestBoardRequest](docs/CreatePinterestBoardRequest.md)
@@ -770,6 +777,8 @@ Class | Method | HTTP request | Description
  - [Zernio::CreateProfileRequest](docs/CreateProfileRequest.md)
  - [Zernio::CreateQueueSlot201Response](docs/CreateQueueSlot201Response.md)
  - [Zernio::CreateQueueSlotRequest](docs/CreateQueueSlotRequest.md)
+ - [Zernio::CreateRfPrediction201Response](docs/CreateRfPrediction201Response.md)
+ - [Zernio::CreateRfPredictionRequest](docs/CreateRfPredictionRequest.md)
  - [Zernio::CreateSequence200Response](docs/CreateSequence200Response.md)
  - [Zernio::CreateSequence200ResponseSequence](docs/CreateSequence200ResponseSequence.md)
  - [Zernio::CreateSequenceRequest](docs/CreateSequenceRequest.md)
@@ -1126,6 +1135,10 @@ Class | Method | HTTP request | Description
  - [Zernio::GetPhoneNumberKycForm200ResponseReusable](docs/GetPhoneNumberKycForm200ResponseReusable.md)
  - [Zernio::GetPhoneNumberKycForm200ResponseReusableDetailsInner](docs/GetPhoneNumberKycForm200ResponseReusableDetailsInner.md)
  - [Zernio::GetPhoneNumberKycForm200ResponseReusableOptionsInner](docs/GetPhoneNumberKycForm200ResponseReusableOptionsInner.md)
+ - [Zernio::GetPhoneNumberPortInOrderRequirements200Response](docs/GetPhoneNumberPortInOrderRequirements200Response.md)
+ - [Zernio::GetPhoneNumberPortInOrderRequirements200ResponseRequirementsInner](docs/GetPhoneNumberPortInOrderRequirements200ResponseRequirementsInner.md)
+ - [Zernio::GetPhoneNumberPortInRequirements200Response](docs/GetPhoneNumberPortInRequirements200Response.md)
+ - [Zernio::GetPhoneNumberPortInRequirements200ResponseFieldsInner](docs/GetPhoneNumberPortInRequirements200ResponseFieldsInner.md)
  - [Zernio::GetPhoneNumberRemediation200Response](docs/GetPhoneNumberRemediation200Response.md)
  - [Zernio::GetPinterestBoards200Response](docs/GetPinterestBoards200Response.md)
  - [Zernio::GetPinterestBoards200ResponseBoardsInner](docs/GetPinterestBoards200ResponseBoardsInner.md)
@@ -1521,6 +1534,8 @@ Class | Method | HTTP request | Description
  - [Zernio::ReplyToMention200Response](docs/ReplyToMention200Response.md)
  - [Zernio::ReplyToMentionRequest](docs/ReplyToMentionRequest.md)
  - [Zernio::ResendSmsRegistrationOtp200Response](docs/ResendSmsRegistrationOtp200Response.md)
+ - [Zernio::ReserveRfPrediction201Response](docs/ReserveRfPrediction201Response.md)
+ - [Zernio::ReserveRfPredictionRequest](docs/ReserveRfPredictionRequest.md)
  - [Zernio::RestoreWorkflowVersion200Response](docs/RestoreWorkflowVersion200Response.md)
  - [Zernio::RestoreWorkflowVersion200ResponseWorkflow](docs/RestoreWorkflowVersion200ResponseWorkflow.md)
  - [Zernio::RetweetPost200Response](docs/RetweetPost200Response.md)
@@ -1532,6 +1547,7 @@ Class | Method | HTTP request | Description
  - [Zernio::ReviewWebhookReview](docs/ReviewWebhookReview.md)
  - [Zernio::ReviewWebhookReviewReply](docs/ReviewWebhookReviewReply.md)
  - [Zernio::ReviewWebhookReviewReviewer](docs/ReviewWebhookReviewReviewer.md)
+ - [Zernio::RfPrediction](docs/RfPrediction.md)
  - [Zernio::SavedTargetingAudience](docs/SavedTargetingAudience.md)
  - [Zernio::ScheduleBroadcast200Response](docs/ScheduleBroadcast200Response.md)
  - [Zernio::ScheduleBroadcast200ResponseBroadcast](docs/ScheduleBroadcast200ResponseBroadcast.md)

data/docs/AdsApi.md

@@ -8,12 +8,14 @@ All URIs are relative to *https://zernio.com/api*
 | [**adjust_conversions**](AdsApi.md#adjust_conversions) | **POST** /v1/ads/conversions/adjustments | Adjust uploaded conversions |
 | [**archive_lead_form**](AdsApi.md#archive_lead_form) | **DELETE** /v1/ads/lead-forms/{formId} | Archive a lead form |
 | [**boost_post**](AdsApi.md#boost_post) | **POST** /v1/ads/boost | Boost post as ad |
+| [**cancel_rf_reservation**](AdsApi.md#cancel_rf_reservation) | **DELETE** /v1/ads/rf-predictions/{predictionId} | Cancel a Reach & Frequency reservation (Meta) |
 | [**create_ad_insights_report**](AdsApi.md#create_ad_insights_report) | **POST** /v1/ads/insights/reports | Submit an async insights report run (Meta) |
 | [**create_call_ad**](AdsApi.md#create_call_ad) | **POST** /v1/ads/call | Create Click-to-Call ad |
 | [**create_conversion_destination**](AdsApi.md#create_conversion_destination) | **POST** /v1/accounts/{accountId}/conversion-destinations | Create a conversion destination |
 | [**create_ctwa_ad**](AdsApi.md#create_ctwa_ad) | **POST** /v1/ads/ctwa | Create Click-to-WhatsApp ad (deprecated) |
 | [**create_lead_form**](AdsApi.md#create_lead_form) | **POST** /v1/ads/lead-forms | Create a lead form |
 | [**create_messaging_ad**](AdsApi.md#create_messaging_ad) | **POST** /v1/ads/messaging | Create click-to-message ad (WhatsApp / Messenger / Instagram Direct) |
+| [**create_rf_prediction**](AdsApi.md#create_rf_prediction) | **POST** /v1/ads/rf-predictions | Create a Reach & Frequency prediction (Meta) |
 | [**create_standalone_ad**](AdsApi.md#create_standalone_ad) | **POST** /v1/ads/create | Create standalone ad |
 | [**create_test_lead**](AdsApi.md#create_test_lead) | **POST** /v1/ads/lead-forms/{formId}/test-leads | Create a test lead |
 | [**delete_ad**](AdsApi.md#delete_ad) | **DELETE** /v1/ads/{adId} | Cancel an ad |
@@ -37,6 +39,7 @@ All URIs are relative to *https://zernio.com/api*
 | [**get_lead_form**](AdsApi.md#get_lead_form) | **GET** /v1/ads/lead-forms/{formId} | Get a lead form |
 | [**get_linked_in_bid_pricing**](AdsApi.md#get_linked_in_bid_pricing) | **POST** /v1/ads/targeting/bid-pricing | Suggested bid and budget bounds (LinkedIn) |
 | [**get_linked_in_supply_forecast**](AdsApi.md#get_linked_in_supply_forecast) | **POST** /v1/ads/targeting/supply-forecast | Impressions, clicks and spend forecast (LinkedIn) |
+| [**get_rf_prediction**](AdsApi.md#get_rf_prediction) | **GET** /v1/ads/rf-predictions/{predictionId} | Read a Reach & Frequency prediction (Meta) |
 | [**list_ad_accounts**](AdsApi.md#list_ad_accounts) | **GET** /v1/ads/accounts | List ad accounts |
 | [**list_ad_catalog_product_sets**](AdsApi.md#list_ad_catalog_product_sets) | **GET** /v1/ads/catalogs/{catalogId}/product-sets | List a catalog's product sets |
 | [**list_ad_catalogs**](AdsApi.md#list_ad_catalogs) | **GET** /v1/ads/catalogs | List Meta product catalogs |
@@ -51,6 +54,7 @@ All URIs are relative to *https://zernio.com/api*
 | [**list_whats_app_conversions**](AdsApi.md#list_whats_app_conversions) | **GET** /v1/whatsapp/conversions | List conversion events |
 | [**query_ad_insights**](AdsApi.md#query_ad_insights) | **GET** /v1/ads/insights | Flexible live insights query (Meta) |
 | [**remove_conversion_associations**](AdsApi.md#remove_conversion_associations) | **DELETE** /v1/accounts/{accountId}/conversion-destinations/{destinationId}/associations | Remove associated campaigns |
+| [**reserve_rf_prediction**](AdsApi.md#reserve_rf_prediction) | **POST** /v1/ads/rf-predictions/{predictionId}/reserve | Reserve a Reach & Frequency prediction (Meta) |
 | [**search_ad_interests**](AdsApi.md#search_ad_interests) | **GET** /v1/ads/interests | Search targeting interests |
 | [**search_ad_targeting**](AdsApi.md#search_ad_targeting) | **GET** /v1/ads/targeting/search | Search targeting options |
 | [**send_conversions**](AdsApi.md#send_conversions) | **POST** /v1/ads/conversions | Send conversion events |
@@ -345,6 +349,78 @@ end
 - **Accept**: application/json
 
 
+## cancel_rf_reservation
+
+> cancel_rf_reservation(prediction_id, account_id, ad_account_id)
+
+Cancel a Reach & Frequency reservation (Meta)
+
+Releases a RESERVATION's locked price and inventory. Unreserved predictions expire on their own.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zernio-sdk'
+# setup authorization
+Zernio.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Zernio::AdsApi.new
+prediction_id = 'prediction_id_example' # String | 
+account_id = 'account_id_example' # String | 
+ad_account_id = 'ad_account_id_example' # String | 
+
+begin
+  # Cancel a Reach & Frequency reservation (Meta)
+  api_instance.cancel_rf_reservation(prediction_id, account_id, ad_account_id)
+rescue Zernio::ApiError => e
+  puts "Error when calling AdsApi->cancel_rf_reservation: #{e}"
+end
+```
+
+#### Using the cancel_rf_reservation_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> cancel_rf_reservation_with_http_info(prediction_id, account_id, ad_account_id)
+
+```ruby
+begin
+  # Cancel a Reach & Frequency reservation (Meta)
+  data, status_code, headers = api_instance.cancel_rf_reservation_with_http_info(prediction_id, account_id, ad_account_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Zernio::ApiError => e
+  puts "Error when calling AdsApi->cancel_rf_reservation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **prediction_id** | **String** |  |  |
+| **account_id** | **String** |  |  |
+| **ad_account_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## create_ad_insights_report
 
 > <CreateAdInsightsReport202Response> create_ad_insights_report(create_ad_insights_report_request)
@@ -759,6 +835,75 @@ nil (empty response body)
 - **Accept**: application/json
 
 
+## create_rf_prediction
+
+> <CreateRfPrediction201Response> create_rf_prediction(create_rf_prediction_request)
+
+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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zernio-sdk'
+# setup authorization
+Zernio.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Zernio::AdsApi.new
+create_rf_prediction_request = Zernio::CreateRfPredictionRequest.new({account_id: 'account_id_example', ad_account_id: 'ad_account_id_example', start_date: Time.now, end_date: Time.now}) # CreateRfPredictionRequest | 
+
+begin
+  # Create a Reach & Frequency prediction (Meta)
+  result = api_instance.create_rf_prediction(create_rf_prediction_request)
+  p result
+rescue Zernio::ApiError => e
+  puts "Error when calling AdsApi->create_rf_prediction: #{e}"
+end
+```
+
+#### Using the create_rf_prediction_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateRfPrediction201Response>, Integer, Hash)> create_rf_prediction_with_http_info(create_rf_prediction_request)
+
+```ruby
+begin
+  # Create a Reach & Frequency prediction (Meta)
+  data, status_code, headers = api_instance.create_rf_prediction_with_http_info(create_rf_prediction_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateRfPrediction201Response>
+rescue Zernio::ApiError => e
+  puts "Error when calling AdsApi->create_rf_prediction_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_rf_prediction_request** | [**CreateRfPredictionRequest**](CreateRfPredictionRequest.md) |  |  |
+
+### Return type
+
+[**CreateRfPrediction201Response**](CreateRfPrediction201Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## create_standalone_ad
 
 > <CreateStandaloneAd201Response> create_standalone_ad(create_standalone_ad_request, opts)
@@ -2433,6 +2578,77 @@ end
 - **Accept**: application/json
 
 
+## get_rf_prediction
+
+> <CreateRfPrediction201Response> get_rf_prediction(prediction_id, account_id, ad_account_id)
+
+Read a Reach & Frequency prediction (Meta)
+
+### Examples
+
+```ruby
+require 'time'
+require 'zernio-sdk'
+# setup authorization
+Zernio.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Zernio::AdsApi.new
+prediction_id = 'prediction_id_example' # String | 
+account_id = 'account_id_example' # String | 
+ad_account_id = 'ad_account_id_example' # String | 
+
+begin
+  # Read a Reach & Frequency prediction (Meta)
+  result = api_instance.get_rf_prediction(prediction_id, account_id, ad_account_id)
+  p result
+rescue Zernio::ApiError => e
+  puts "Error when calling AdsApi->get_rf_prediction: #{e}"
+end
+```
+
+#### Using the get_rf_prediction_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateRfPrediction201Response>, Integer, Hash)> get_rf_prediction_with_http_info(prediction_id, account_id, ad_account_id)
+
+```ruby
+begin
+  # Read a Reach & Frequency prediction (Meta)
+  data, status_code, headers = api_instance.get_rf_prediction_with_http_info(prediction_id, account_id, ad_account_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateRfPrediction201Response>
+rescue Zernio::ApiError => e
+  puts "Error when calling AdsApi->get_rf_prediction_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **prediction_id** | **String** |  |  |
+| **account_id** | **String** |  |  |
+| **ad_account_id** | **String** |  |  |
+
+### Return type
+
+[**CreateRfPrediction201Response**](CreateRfPrediction201Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## list_ad_accounts
 
 > <ListAdAccounts200Response> list_ad_accounts(account_id, opts)
@@ -3519,6 +3735,77 @@ end
 - **Accept**: application/json
 
 
+## reserve_rf_prediction
+
+> <ReserveRfPrediction201Response> reserve_rf_prediction(prediction_id, reserve_rf_prediction_request)
+
+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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zernio-sdk'
+# setup authorization
+Zernio.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Zernio::AdsApi.new
+prediction_id = 'prediction_id_example' # String | 
+reserve_rf_prediction_request = Zernio::ReserveRfPredictionRequest.new({account_id: 'account_id_example', ad_account_id: 'ad_account_id_example'}) # ReserveRfPredictionRequest | 
+
+begin
+  # Reserve a Reach & Frequency prediction (Meta)
+  result = api_instance.reserve_rf_prediction(prediction_id, reserve_rf_prediction_request)
+  p result
+rescue Zernio::ApiError => e
+  puts "Error when calling AdsApi->reserve_rf_prediction: #{e}"
+end
+```
+
+#### Using the reserve_rf_prediction_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ReserveRfPrediction201Response>, Integer, Hash)> reserve_rf_prediction_with_http_info(prediction_id, reserve_rf_prediction_request)
+
+```ruby
+begin
+  # Reserve a Reach & Frequency prediction (Meta)
+  data, status_code, headers = api_instance.reserve_rf_prediction_with_http_info(prediction_id, reserve_rf_prediction_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ReserveRfPrediction201Response>
+rescue Zernio::ApiError => e
+  puts "Error when calling AdsApi->reserve_rf_prediction_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **prediction_id** | **String** |  |  |
+| **reserve_rf_prediction_request** | [**ReserveRfPredictionRequest**](ReserveRfPredictionRequest.md) |  |  |
+
+### Return type
+
+[**ReserveRfPrediction201Response**](ReserveRfPrediction201Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## search_ad_interests
 
 > <SearchAdInterests200Response> search_ad_interests(q, account_id)

data/docs/CheckPhoneNumberPortability200ResponseResultsInner.md

@@ -7,7 +7,9 @@
 | **phone_number** | **String** |  | [optional] |
 | **portable** | **Boolean** |  | [optional] |
 | **fast_portable** | **Boolean** | Qualifies for the carrier's accelerated FastPort lane. | [optional] |
-| **line_type** | **String** | Line type when known (mobile, landline, voip…). A mobile number requires the transfer PIN at submit. | [optional] |
+| **line_type** | **String** | Line type when known (mobile, landline, voip…). A US/CA mobile number requires the transfer PIN at submit. | [optional] |
+| **country_code** | **String** | ISO country of the number — pass it to GET /v1/phone-numbers/port-in/requirements for international numbers. | [optional] |
+| **phone_number_type** | **String** | Carrier number-type classification (local, mobile, national, toll_free…) — the numberType for the requirements endpoint. | [optional] |
 | **not_portable_reason** | **String** | Carrier reason when not portable; null when portable. | [optional] |
 
 ## Example
@@ -20,6 +22,8 @@ instance = Zernio::CheckPhoneNumberPortability200ResponseResultsInner.new(
   portable: null,
   fast_portable: null,
   line_type: null,
+  country_code: null,
+  phone_number_type: null,
   not_portable_reason: null
 )
 ```

data/docs/CreatePhoneNumberPortInRequest.md

@@ -8,9 +8,10 @@
 | **end_user** | [**CreatePhoneNumberPortInRequestEndUser**](CreatePhoneNumberPortInRequestEndUser.md) |  |  |
 | **loa_document_id** | **String** | Document id from POST /v1/phone-numbers/port-in/documents (kind=loa). |  |
 | **invoice_document_id** | **String** | Document id from POST /v1/phone-numbers/port-in/documents (kind=invoice). |  |
-| **foc_datetime_requested** | **Time** | Requested port date; the carrier confirms the actual FOC later. Defaults to one week out (shifted off weekends) when omitted. | [optional] |
+| **foc_datetime_requested** | **Time** | 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. | [optional] |
 | **customer_reference** | **String** |  | [optional] |
 | **port_type** | **String** | Whether the losing account ports all its numbers (full) or keeps some (partial). | [optional][default to 'full'] |
+| **requirements** | [**Array<CreatePhoneNumberPortInRequestRequirementsInner>**](CreatePhoneNumberPortInRequestRequirementsInner.md) | 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. | [optional] |
 
 ## Example
 
@@ -24,7 +25,8 @@ instance = Zernio::CreatePhoneNumberPortInRequest.new(
   invoice_document_id: null,
   foc_datetime_requested: null,
   customer_reference: null,
-  port_type: null
+  port_type: null,
+  requirements: null
 )
 ```
 

data/docs/CreatePhoneNumberPortInRequestEndUser.md

@@ -8,13 +8,15 @@
 | **auth_person_name** | **String** | Full name (first + last) of the person authorizing the port — must match the LOA signature. |  |
 | **billing_phone_number** | **String** | 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. | [optional] |
 | **account_number** | **String** | Account number with the losing carrier — required (carriers reject ports without it; on prepaid mobile plans it is often the phone number itself). |  |
-| **pin_passcode** | **String** | Transfer PIN. Required for mobile numbers (wireless carriers reject PIN-less ports). Forwarded to the carrier, never stored. | [optional] |
+| **pin_passcode** | **String** | 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. | [optional] |
+| **tax_identifier** | **String** | Company tax id on the carrier account (EU ports, e.g. Spanish CIF). | [optional] |
+| **business_identifier** | **String** | Business registration id on the carrier account (EU ports). | [optional] |
 | **street_address** | **String** |  |  |
 | **extended_address** | **String** |  | [optional] |
 | **locality** | **String** |  |  |
-| **administrative_area** | **String** | 2-letter US state / CA province code (full names are accepted and normalized). |  |
-| **postal_code** | **String** | US ZIP (5 digits) or Canadian postal code, matching countryCode. |  |
-| **country_code** | **String** |  |  |
+| **administrative_area** | **String** | Region. Required for US/CA as the 2-letter state/province code (full names are accepted and normalized); optional elsewhere. | [optional] |
+| **postal_code** | **String** | Postal code. Validated as a US ZIP / Canadian postal code for US/CA; free-form elsewhere. |  |
+| **country_code** | **String** | Service-address country (a supported port-in country). |  |
 
 ## Example
 
@@ -27,6 +29,8 @@ instance = Zernio::CreatePhoneNumberPortInRequestEndUser.new(
   billing_phone_number: null,
   account_number: null,
   pin_passcode: null,
+  tax_identifier: null,
+  business_identifier: null,
   street_address: null,
   extended_address: null,
   locality: null,

data/docs/CreatePhoneNumberPortInRequestRequirementsInner.md

@@ -0,0 +1,20 @@
+# Zernio::CreatePhoneNumberPortInRequestRequirementsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **requirement_type_id** | **String** | The requirement's id, from the requirements endpoint. |  |
+| **field_value** | **String** | Text value, ISO datetime, or a documentId from POST /v1/phone-numbers/port-in/documents, per the requirement's kind. |  |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::CreatePhoneNumberPortInRequestRequirementsInner.new(
+  requirement_type_id: null,
+  field_value: null
+)
+```
+

data/docs/CreateRfPrediction201Response.md

@@ -0,0 +1,22 @@
+# Zernio::CreateRfPrediction201Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ad_account_id** | **String** |  | [optional] |
+| **currency** | **String** |  | [optional] |
+| **prediction** | [**RfPrediction**](RfPrediction.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::CreateRfPrediction201Response.new(
+  ad_account_id: null,
+  currency: null,
+  prediction: null
+)
+```
+

data/docs/CreateRfPredictionRequest.md

@@ -0,0 +1,34 @@
+# Zernio::CreateRfPredictionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | Zernio SocialAccount id (posting or ads variant). |  |
+| **ad_account_id** | **String** | Meta ad account id (act_<n>). |  |
+| **budget_amount** | **Float** | Whole currency units. Exactly one of budgetAmount / reach. | [optional] |
+| **reach** | **Integer** | Target unique reach. Exactly one of budgetAmount / reach. | [optional] |
+| **start_date** | **Time** | Campaign window start (must be in the future). |  |
+| **end_date** | **Time** |  |  |
+| **frequency_cap** | **Integer** | Max impressions per person over the window. | [optional] |
+| **targeting** | **Object** | Canonical camelCase TargetingSpec (same shape as /v1/ads/create's `targeting`). Defaults to countries: [US]. | [optional] |
+| **placements** | **Object** | Meta placements object (same shape as /v1/ads/create's `placements`). | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::CreateRfPredictionRequest.new(
+  account_id: null,
+  ad_account_id: null,
+  budget_amount: null,
+  reach: null,
+  start_date: null,
+  end_date: null,
+  frequency_cap: null,
+  targeting: null,
+  placements: null
+)
+```
+

data/docs/CreateStandaloneAdRequest.md

@@ -14,6 +14,8 @@
 | **goal** | **String** | Required on legacy and multi-creative shapes; the attach shape inherits it from the ad set. Available goals vary by platform.  **Meta** - `conversions`: OUTCOME_SALES. Requires `promotedObject.pixelId` and `promotedObject.customEventType` with a commerce event such as PURCHASE or START_TRIAL. - `lead_conversion`: OUTCOME_LEADS optimizing website pixel leads. Same pixel and event fields, but with a leads-class event such as LEAD, SUBMIT_APPLICATION, SCHEDULE or CONTACT. Meta gates conversion events by objective, so leads-class events are rejected under `conversions`. - `lead_generation`: OUTCOME_LEADS with instant forms. Requires `leadGenFormId`. `promotedObject.pageId` is optional and auto-filled from the connected Page. - `app_promotion`: requires `promotedObject.applicationId` and `promotedObject.objectStoreUrl`. - `catalog_sales`: Advantage+ catalog ads, for example vehicle inventory. Requires `promotedObject.productSetId`, `promotedObject.pixelId` and `promotedObject.customEventType`. Builds a catalog TEMPLATE creative from the copy fields, which may carry template tags like {{product.name}} or {{vehicle.make}}. No imageUrl or video is sent; Meta renders the visuals per catalog item. Discover catalogs via GET /v1/ads/catalogs and product sets via GET /v1/ads/catalogs/{catalogId}/product-sets. Single shape only, no creatives[], adSetId, dynamicCreative or placementAssets.  **TikTok** - `conversions`: website-conversion ad group. Requires `promotedObject.pixelId`, your TikTok Pixel ID. Accepts an optional `promotedObject.customEventType` with a TikTok optimization_event code your pixel tracks (newer pixels use e.g. SHOPPING for purchase events; legacy pixels use ON_WEB_ORDER, INITIATE_ORDER, ON_WEB_REGISTER or FORM). To inherit pixel and event from an existing ad group, pass `adSetId` instead.  **LinkedIn** - `engagement`, `traffic`, `awareness` and `video_views` create standalone Direct Sponsored Content ads. `traffic` requires `linkUrl`; `video_views` requires `video`. - `job_applicants` requires a `platformSpecificData.jobs` creative. - For `lead_generation` or `conversions` on LinkedIn, or to promote an existing post, use POST /v1/ads/boost.  | [optional] |
 | **optimization_goal** | **String** | 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. | [optional] |
 | **billing_event** | **String** | Meta only. Explicit ad-set `billing_event`. Defaults to `IMPRESSIONS`. Forwarded verbatim to Meta, which validates compatibility with the optimization goal. | [optional] |
+| **buying_type** | **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). | [optional] |
+| **rf_prediction_id** | **String** | Meta only. The RESERVED prediction id the R&F ad set runs on (reserving mints a new id — pass that one). Requires buyingType RESERVED. | [optional] |
 | **budget_amount** | **Float** | Required on legacy + multi-creative shapes. Inherited on attach. | [optional] |
 | **budget_type** | **String** | Required on legacy + multi-creative shapes. Inherited on attach. | [optional] |
 | **status** | **String** | Meta and TikTok. Publish state of the created entities. Omitted or ACTIVE publishes live (default, back-compat); PAUSED creates them paused and skips activation, so you can review before they spend. On TikTok the whole campaign > ad group > ad hierarchy stays paused. | [optional] |
@@ -93,6 +95,8 @@ instance = Zernio::CreateStandaloneAdRequest.new(
   goal: null,
   optimization_goal: null,
   billing_event: null,
+  buying_type: null,
+  rf_prediction_id: null,
   budget_amount: null,
   budget_type: null,
   status: null,

data/docs/GetPhoneNumberPortInOrderRequirements200Response.md

@@ -0,0 +1,20 @@
+# Zernio::GetPhoneNumberPortInOrderRequirements200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **country** | **String** |  | [optional] |
+| **requirements** | [**Array<GetPhoneNumberPortInOrderRequirements200ResponseRequirementsInner>**](GetPhoneNumberPortInOrderRequirements200ResponseRequirementsInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::GetPhoneNumberPortInOrderRequirements200Response.new(
+  country: null,
+  requirements: null
+)
+```
+