late-sdk 0.0.909 → 0.0.910

data/docs/ReachAndFrequencyApi.md

@@ -4,17 +4,17 @@ All URIs are relative to *https://zernio.com/api*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**cancel_rf_reservation**](ReachAndFrequencyApi.md#cancel_rf_reservation) | **DELETE** /v1/ads/rf-predictions/{predictionId} | Cancel a Reach & Frequency reservation |
-| [**create_rf_prediction**](ReachAndFrequencyApi.md#create_rf_prediction) | **POST** /v1/ads/rf-predictions | Create a Reach & Frequency prediction |
-| [**get_rf_prediction**](ReachAndFrequencyApi.md#get_rf_prediction) | **GET** /v1/ads/rf-predictions/{predictionId} | Read a Reach & Frequency prediction |
-| [**reserve_rf_prediction**](ReachAndFrequencyApi.md#reserve_rf_prediction) | **POST** /v1/ads/rf-predictions/{predictionId}/reserve | Reserve a Reach & Frequency prediction |
+| [**cancel_rf_reservation**](ReachAndFrequencyApi.md#cancel_rf_reservation) | **DELETE** /v1/ads/rf-predictions/{predictionId} | Cancel reach-frequency booking |
+| [**create_rf_prediction**](ReachAndFrequencyApi.md#create_rf_prediction) | **POST** /v1/ads/rf-predictions | Create reach-frequency prediction |
+| [**get_rf_prediction**](ReachAndFrequencyApi.md#get_rf_prediction) | **GET** /v1/ads/rf-predictions/{predictionId} | Get reach-frequency prediction |
+| [**reserve_rf_prediction**](ReachAndFrequencyApi.md#reserve_rf_prediction) | **POST** /v1/ads/rf-predictions/{predictionId}/reserve | Reserve reach-frequency inventory |
 
 
 ## cancel_rf_reservation
 
 > cancel_rf_reservation(prediction_id, account_id, ad_account_id)
 
-Cancel a Reach & Frequency reservation
+Cancel reach-frequency booking
 
 Releases a RESERVATION's locked price and inventory. Unreserved predictions expire on their own.
 
@@ -35,7 +35,7 @@ account_id = 'account_id_example' # String |
 ad_account_id = 'ad_account_id_example' # String | 
 
 begin
-  # Cancel a Reach & Frequency reservation
+  # Cancel reach-frequency booking
   api_instance.cancel_rf_reservation(prediction_id, account_id, ad_account_id)
 rescue Zernio::ApiError => e
   puts "Error when calling ReachAndFrequencyApi->cancel_rf_reservation: #{e}"
@@ -50,7 +50,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
 
 ```ruby
 begin
-  # Cancel a Reach & Frequency reservation
+  # Cancel reach-frequency booking
   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 # => { ... }
@@ -86,7 +86,7 @@ nil (empty response body)
 
 > <CreateRfPrediction201Response> create_rf_prediction(create_rf_prediction_request)
 
-Create a Reach & Frequency prediction
+Create reach-frequency prediction
 
 Creates an R&F prediction. This is 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. Top-level `placements` wins; when it is omitted, `targeting.placements` is used; when neither is set, placements default to Facebook feed (+ Instagram stream when a linked IG professional account resolves). Instagram placements require that IG account.
 
@@ -105,7 +105,7 @@ api_instance = Zernio::ReachAndFrequencyApi.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
+  # Create reach-frequency prediction
   result = api_instance.create_rf_prediction(create_rf_prediction_request)
   p result
 rescue Zernio::ApiError => e
@@ -121,7 +121,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Create a Reach & Frequency prediction
+  # Create reach-frequency prediction
   data, status_code, headers = api_instance.create_rf_prediction_with_http_info(create_rf_prediction_request)
   p status_code # => 2xx
   p headers # => { ... }
@@ -155,7 +155,7 @@ end
 
 > <CreateRfPrediction201Response> get_rf_prediction(prediction_id, account_id, ad_account_id)
 
-Read a Reach & Frequency prediction
+Get reach-frequency prediction
 
 ### Examples
 
@@ -174,7 +174,7 @@ account_id = 'account_id_example' # String |
 ad_account_id = 'ad_account_id_example' # String | 
 
 begin
-  # Read a Reach & Frequency prediction
+  # Get reach-frequency prediction
   result = api_instance.get_rf_prediction(prediction_id, account_id, ad_account_id)
   p result
 rescue Zernio::ApiError => e
@@ -190,7 +190,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Read a Reach & Frequency prediction
+  # Get reach-frequency prediction
   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 # => { ... }
@@ -226,7 +226,7 @@ end
 
 > <ReserveRfPrediction201Response> reserve_rf_prediction(prediction_id, reserve_rf_prediction_request)
 
-Reserve a Reach & Frequency prediction
+Reserve reach-frequency inventory
 
 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.
 
@@ -246,7 +246,7 @@ 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
+  # Reserve reach-frequency inventory
   result = api_instance.reserve_rf_prediction(prediction_id, reserve_rf_prediction_request)
   p result
 rescue Zernio::ApiError => e
@@ -262,7 +262,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Reserve a Reach & Frequency prediction
+  # Reserve reach-frequency inventory
   data, status_code, headers = api_instance.reserve_rf_prediction_with_http_info(prediction_id, reserve_rf_prediction_request)
   p status_code # => 2xx
   p headers # => { ... }

data/docs/SetPartnershipAdPermission200Response.md

@@ -0,0 +1,18 @@
+# Zernio::SetPartnershipAdPermission200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **permission** | [**ListPartnershipAdPermissions200ResponsePermissionsInner**](ListPartnershipAdPermissions200ResponsePermissionsInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::SetPartnershipAdPermission200Response.new(
+  permission: null
+)
+```
+

data/docs/SetPartnershipAdPermissionRequest.md

@@ -0,0 +1,22 @@
+# Zernio::SetPartnershipAdPermissionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** |  |  |
+| **creator_username** | **String** |  |  |
+| **revoke** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::SetPartnershipAdPermissionRequest.new(
+  account_id: null,
+  creator_username: null,
+  revoke: null
+)
+```
+

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

@@ -359,7 +359,7 @@ module Zernio
       return data, status_code, headers
     end
 
-    # Create or reuse a custom conversion
+    # Create custom conversion
     # Provision the Meta custom conversion an ads flow optimises toward, and hand back the `customConversionId` for `promotedObject.customConversionId` on POST /v1/ads/create. Removes the manual \"create it in Ads Manager first\" step.  **Reuse is ours, not Meta's.** Meta's create is not idempotent, so a retried request would otherwise mint a duplicate carrying none of the original's optimisation history. A non-archived conversion with the same `name` on the same `pixelId` is returned instead of created, with `reused: true` and a 200 rather than a 201.  `rule` is forwarded verbatim in Meta's own grammar (e.g. `{\"url\": {\"i_contains\": \"thank-you\"}}`); Meta validates it and rejects a malformed one with \"A conversion rule is required at creation time\".
     # @param account_id [String] Meta ads SocialAccount id.
     # @param create_custom_conversion_request [CreateCustomConversionRequest] 
@@ -370,7 +370,7 @@ module Zernio
       data
     end
 
-    # Create or reuse a custom conversion
+    # Create custom conversion
     # Provision the Meta custom conversion an ads flow optimises toward, and hand back the `customConversionId` for `promotedObject.customConversionId` on POST /v1/ads/create. Removes the manual \"create it in Ads Manager first\" step.  **Reuse is ours, not Meta's.** Meta's create is not idempotent, so a retried request would otherwise mint a duplicate carrying none of the original's optimisation history. A non-archived conversion with the same `name` on the same `pixelId` is returned instead of created, with `reused: true` and a 200 rather than a 201.  `rule` is forwarded verbatim in Meta's own grammar (e.g. `{\"url\": {\"i_contains\": \"thank-you\"}}`); Meta validates it and rejects a malformed one with \"A conversion rule is required at creation time\".
     # @param account_id [String] Meta ads SocialAccount id.
     # @param create_custom_conversion_request [CreateCustomConversionRequest] 
@@ -1235,7 +1235,7 @@ module Zernio
       return data, status_code, headers
     end
 
-    # List DSA beneficiary/payor suggestions
+    # Get DSA recommendations
     # Returns Meta's suggested beneficiary/payor names for an ad account, derived by Meta from the account's recent activity. Useful for prefilling `dsaBeneficiary`/`dsaPayor` inputs, or the defaults sent to `PATCH /v1/ads/accounts`, in your own UI.  Meta returns a single flat list. Entries are not labeled as beneficiary or payor, and since these are legal disclosures Zernio never applies them automatically: let your user pick the right entity. The list may be empty for accounts with little activity. Meta accounts only. 
     # @param account_id [String] Account ID (metaads, or a facebook/instagram posting account)
     # @param ad_account_id [String] Meta ad account ID (act_...)
@@ -1246,7 +1246,7 @@ module Zernio
       data
     end
 
-    # List DSA beneficiary/payor suggestions
+    # Get DSA recommendations
     # Returns Meta's suggested beneficiary/payor names for an ad account, derived by Meta from the account's recent activity. Useful for prefilling `dsaBeneficiary`/`dsaPayor` inputs, or the defaults sent to `PATCH /v1/ads/accounts`, in your own UI.  Meta returns a single flat list. Entries are not labeled as beneficiary or payor, and since these are legal disclosures Zernio never applies them automatically: let your user pick the right entity. The list may be empty for accounts with little activity. Meta accounts only. 
     # @param account_id [String] Account ID (metaads, or a facebook/instagram posting account)
     # @param ad_account_id [String] Meta ad account ID (act_...)
@@ -2407,7 +2407,7 @@ module Zernio
       return data, status_code, headers
     end
 
-    # High demand periods / budget schedules
+    # List high-demand periods
     # Scheduled budget increases (Meta's budget-scheduling API). The Graph edge lives on the campaign and ad-set nodes only, so exactly one of `campaignId` / `adSetId` (platform ids) is required. Rows returned verbatim (budget_value, budget_value_type, time window, recurrence).
     # @param account_id [String] Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
     # @param [Hash] opts the optional parameters
@@ -2421,7 +2421,7 @@ module Zernio
       data
     end
 
-    # High demand periods / budget schedules
+    # List high-demand periods
     # Scheduled budget increases (Meta's budget-scheduling API). The Graph edge lives on the campaign and ad-set nodes only, so exactly one of `campaignId` / `adSetId` (platform ids) is required. Rows returned verbatim (budget_value, budget_value_type, time window, recurrence).
     # @param account_id [String] Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
     # @param [Hash] opts the optional parameters
@@ -2569,6 +2569,81 @@ module Zernio
       return data, status_code, headers
     end
 
+    # List TikTok ad pixels
+    # Lists pixels and their supported optimization events for a connected TikTok Ads account. The advertiser defaults to the first advertiser on the connection. Reconnect if Pixel Management permission has not been granted.
+    # @param account_id [String] Zernio SocialAccount ID.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :advertiser_id Advertiser belonging to this connection.
+    # @option opts [String] :code Filter by a Pixel Code.
+    # @return [ListTikTokAdPixels200Response]
+    def list_tik_tok_ad_pixels(account_id, opts = {})
+      data, _status_code, _headers = list_tik_tok_ad_pixels_with_http_info(account_id, opts)
+      data
+    end
+
+    # List TikTok ad pixels
+    # Lists pixels and their supported optimization events for a connected TikTok Ads account. The advertiser defaults to the first advertiser on the connection. Reconnect if Pixel Management permission has not been granted.
+    # @param account_id [String] Zernio SocialAccount ID.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :advertiser_id Advertiser belonging to this connection.
+    # @option opts [String] :code Filter by a Pixel Code.
+    # @return [Array<(ListTikTokAdPixels200Response, Integer, Hash)>] ListTikTokAdPixels200Response data, response status code and response headers
+    def list_tik_tok_ad_pixels_with_http_info(account_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AdAccountsApi.list_tik_tok_ad_pixels ...'
+      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 AdAccountsApi.list_tik_tok_ad_pixels"
+      end
+      pattern = Regexp.new(/^[a-fA-F0-9]{24}$/)
+      if @api_client.config.client_side_validation && account_id !~ pattern
+        fail ArgumentError, "invalid value for 'account_id' when calling AdAccountsApi.list_tik_tok_ad_pixels, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/v1/ads/pixels'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'accountId'] = account_id
+      query_params[:'advertiserId'] = opts[:'advertiser_id'] if !opts[:'advertiser_id'].nil?
+      query_params[:'code'] = opts[:'code'] if !opts[:'code'].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] || 'ListTikTokAdPixels200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AdAccountsApi.list_tik_tok_ad_pixels",
+        :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: AdAccountsApi#list_tik_tok_ad_pixels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List value rule sets
     # Lists the ad account's value rule sets (Meta's `/act_X/value_rule_set`). A value rule set adjusts the auction bid up or down for audience segments you value differently; attach one to an ad set with `valueRuleSetId` on `POST /v1/ads/create` or `PUT /v1/ads/ad-sets/{adSetId}`.  Rows are returned in the same camelCase shape the `PUT` body takes, ids included, so a set round-trips 1:1: **the update is a full replace, not a patch**, so you GET, mutate and send the whole thing back.  Limits: 6 rule sets per ad account, 10 rules per set, 4 criteria per rule.  **Rule order is semantic.** Rules are evaluated in array order and only the FIRST matching rule adjusts the bid for an overlapping audience. The order you send is the order that is stored and returned.  Eligibility: value rule sets apply only to ad sets on the `LOWEST_COST_WITHOUT_CAP` (auto-bid) or `COST_CAP` bid strategies. Meta rejects the rest server-side.
     # @param account_id [String] Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.

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

@@ -19,7 +19,7 @@ module Zernio
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Add Search keywords to an ad group
+    # Add Search ad-group keywords
     # Adds one or more keyword criteria to an existing Google Search ad group, without touching the keywords already there (unlike the whole-set diff on `PUT /v1/ads/{adId}`, `keywords`/`negativeKeywords` in `platformSpecificData`, which replaces the set). Set `negative: true` to add ad-group-level negatives instead of positive keywords. 
     # @param add_ad_keywords_request [AddAdKeywordsRequest] 
     # @param [Hash] opts the optional parameters
@@ -29,7 +29,7 @@ module Zernio
       data
     end
 
-    # Add Search keywords to an ad group
+    # Add Search ad-group keywords
     # Adds one or more keyword criteria to an existing Google Search ad group, without touching the keywords already there (unlike the whole-set diff on `PUT /v1/ads/{adId}`, `keywords`/`negativeKeywords` in `platformSpecificData`, which replaces the set). Set `negative: true` to add ad-group-level negatives instead of positive keywords. 
     # @param add_ad_keywords_request [AddAdKeywordsRequest] 
     # @param [Hash] opts the optional parameters
@@ -538,7 +538,7 @@ module Zernio
       return data, status_code, headers
     end
 
-    # Create a Google Ads portfolio bid strategy
+    # Create portfolio bid strategy
     # Creates a standalone bid strategy shared across campaigns. Attach it to a campaign with `portfolioBidStrategyId` on POST /v1/ads/create, PUT /v1/ads/campaigns/{campaignId}, or PUT /v1/ads/ad-sets/{adSetId}. Attaching a strategy aligned to a shared budget fails there with a 400 (Google's `BIDDING_STRATEGY_AND_BUDGET_MUST_BE_ALIGNED`); this is not retryable.
     # @param create_bid_strategy_request [CreateBidStrategyRequest] 
     # @param [Hash] opts the optional parameters
@@ -548,7 +548,7 @@ module Zernio
       data
     end
 
-    # Create a Google Ads portfolio bid strategy
+    # Create portfolio bid strategy
     # Creates a standalone bid strategy shared across campaigns. Attach it to a campaign with `portfolioBidStrategyId` on POST /v1/ads/create, PUT /v1/ads/campaigns/{campaignId}, or PUT /v1/ads/ad-sets/{adSetId}. Attaching a strategy aligned to a shared budget fails there with a 400 (Google's `BIDDING_STRATEGY_AND_BUDGET_MUST_BE_ALIGNED`); this is not retryable.
     # @param create_bid_strategy_request [CreateBidStrategyRequest] 
     # @param [Hash] opts the optional parameters
@@ -1186,7 +1186,7 @@ module Zernio
       return data, status_code, headers
     end
 
-    # Live ad-set details incl. learning phase
+    # Get live ad-set details
     # Reads the ad set live from Meta, returned verbatim. The default projection includes `learning_stage_info` (learning-phase status: LEARNING / SUCCESS / FAIL / WAIVING; Meta omits its `status` key on paused ad sets), delivery settings, budgets, schedule and targeting. `fields` is a raw-passthrough override; unknown fields return Meta's 400 verbatim.
     # @param ad_set_id [String] Meta ad set id (platformAdSetId).
     # @param account_id [String] Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
@@ -1198,7 +1198,7 @@ module Zernio
       data
     end
 
-    # Live ad-set details incl. learning phase
+    # Get live ad-set details
     # Reads the ad set live from Meta, returned verbatim. The default projection includes `learning_stage_info` (learning-phase status: LEARNING / SUCCESS / FAIL / WAIVING; Meta omits its `status` key on paused ad sets), delivery settings, budgets, schedule and targeting. `fields` is a raw-passthrough override; unknown fields return Meta's 400 verbatim.
     # @param ad_set_id [String] Meta ad set id (platformAdSetId).
     # @param account_id [String] Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
@@ -2158,7 +2158,7 @@ module Zernio
       return data, status_code, headers
     end
 
-    # List Google Ads portfolio bid strategies
+    # List portfolio bid strategies
     # Bidding strategy report: type, status, campaign count, clicks, cost, cost per conversion, impressions, average CPC and conversions over the date range (default last 30 days). Reads Google's `bidding_strategy` resource, cached for the quota window. Draws on the shared Google Ads operations budget. The response carries `cachedAt` and `stale`, set when a quota-exhausted call falls back to the last-good copy instead of a live read.
     # @param account_id [String] Google ads SocialAccount id.
     # @param [Hash] opts the optional parameters
@@ -2171,7 +2171,7 @@ module Zernio
       data
     end
 
-    # List Google Ads portfolio bid strategies
+    # List portfolio bid strategies
     # Bidding strategy report: type, status, campaign count, clicks, cost, cost per conversion, impressions, average CPC and conversions over the date range (default last 30 days). Reads Google's `bidding_strategy` resource, cached for the quota window. Draws on the shared Google Ads operations budget. The response carries `cachedAt` and `stale`, set when a quota-exhausted call falls back to the last-good copy instead of a live read.
     # @param account_id [String] Google ads SocialAccount id.
     # @param [Hash] opts the optional parameters
@@ -3503,7 +3503,7 @@ module Zernio
       return data, status_code, headers
     end
 
-    # Update a Google Ads portfolio bid strategy
+    # Update portfolio bid strategy
     # Renames or retargets a portfolio bid strategy. The strategy's status is output only on Google's side, so it cannot be changed here; remove a strategy in Google Ads. `type` is only needed alongside `targetCpa`/`targetRoas` to disambiguate the field Google writes to (TARGET_CPA and MAXIMIZE_CONVERSIONS both take a target CPA; TARGET_ROAS and MAXIMIZE_CONVERSION_VALUE both take a target ROAS); the strategy's family is otherwise immutable once created.
     # @param strategy_id [String] Numeric Google Ads bid strategy id.
     # @param update_bid_strategy_request [UpdateBidStrategyRequest] 
@@ -3514,7 +3514,7 @@ module Zernio
       data
     end
 
-    # Update a Google Ads portfolio bid strategy
+    # Update portfolio bid strategy
     # Renames or retargets a portfolio bid strategy. The strategy's status is output only on Google's side, so it cannot be changed here; remove a strategy in Google Ads. `type` is only needed alongside `targetCpa`/`targetRoas` to disambiguate the field Google writes to (TARGET_CPA and MAXIMIZE_CONVERSIONS both take a target CPA; TARGET_ROAS and MAXIMIZE_CONVERSION_VALUE both take a target ROAS); the strategy's family is otherwise immutable once created.
     # @param strategy_id [String] Numeric Google Ads bid strategy id.
     # @param update_bid_strategy_request [UpdateBidStrategyRequest] 

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

@@ -909,6 +909,224 @@ module Zernio
       return data, status_code, headers
     end
 
+    # List partnership ad content
+    # Private beta. Lists creator Instagram posts available to the advertiser for Partnership Ads. Supply creatorUsername or postUrl. Requires instagram_branded_content_ads_brand permission and an advertiser Instagram Business Account.
+    # @param account_id [String] Zernio SocialAccount ID.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :creator_username Creator username. Required unless postUrl is supplied.
+    # @option opts [String] :post_url Instagram post permalink. Required unless creatorUsername is supplied.
+    # @option opts [Boolean] :only_allowlisted Return only creators with account-level permission.
+    # @return [ListPartnershipAdContent200Response]
+    def list_partnership_ad_content(account_id, opts = {})
+      data, _status_code, _headers = list_partnership_ad_content_with_http_info(account_id, opts)
+      data
+    end
+
+    # List partnership ad content
+    # Private beta. Lists creator Instagram posts available to the advertiser for Partnership Ads. Supply creatorUsername or postUrl. Requires instagram_branded_content_ads_brand permission and an advertiser Instagram Business Account.
+    # @param account_id [String] Zernio SocialAccount ID.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :creator_username Creator username. Required unless postUrl is supplied.
+    # @option opts [String] :post_url Instagram post permalink. Required unless creatorUsername is supplied.
+    # @option opts [Boolean] :only_allowlisted Return only creators with account-level permission.
+    # @return [Array<(ListPartnershipAdContent200Response, Integer, Hash)>] ListPartnershipAdContent200Response data, response status code and response headers
+    def list_partnership_ad_content_with_http_info(account_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AdCreativesApi.list_partnership_ad_content ...'
+      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 AdCreativesApi.list_partnership_ad_content"
+      end
+      pattern = Regexp.new(/^[a-fA-F0-9]{24}$/)
+      if @api_client.config.client_side_validation && account_id !~ pattern
+        fail ArgumentError, "invalid value for 'account_id' when calling AdCreativesApi.list_partnership_ad_content, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/v1/ads/partnership-content'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'accountId'] = account_id
+      query_params[:'creatorUsername'] = opts[:'creator_username'] if !opts[:'creator_username'].nil?
+      query_params[:'postUrl'] = opts[:'post_url'] if !opts[:'post_url'].nil?
+      query_params[:'onlyAllowlisted'] = opts[:'only_allowlisted'] if !opts[:'only_allowlisted'].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] || 'ListPartnershipAdContent200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AdCreativesApi.list_partnership_ad_content",
+        :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: AdCreativesApi#list_partnership_ad_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List partnership permissions
+    # Private beta. Lists granted or pending creator permissions for the advertiser Instagram Business Account. Requires instagram_branded_content_ads_brand permission.
+    # @param account_id [String] Zernio SocialAccount ID.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :creator_username Filter by creator username.
+    # @return [ListPartnershipAdPermissions200Response]
+    def list_partnership_ad_permissions(account_id, opts = {})
+      data, _status_code, _headers = list_partnership_ad_permissions_with_http_info(account_id, opts)
+      data
+    end
+
+    # List partnership permissions
+    # Private beta. Lists granted or pending creator permissions for the advertiser Instagram Business Account. Requires instagram_branded_content_ads_brand permission.
+    # @param account_id [String] Zernio SocialAccount ID.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :creator_username Filter by creator username.
+    # @return [Array<(ListPartnershipAdPermissions200Response, Integer, Hash)>] ListPartnershipAdPermissions200Response data, response status code and response headers
+    def list_partnership_ad_permissions_with_http_info(account_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AdCreativesApi.list_partnership_ad_permissions ...'
+      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 AdCreativesApi.list_partnership_ad_permissions"
+      end
+      pattern = Regexp.new(/^[a-fA-F0-9]{24}$/)
+      if @api_client.config.client_side_validation && account_id !~ pattern
+        fail ArgumentError, "invalid value for 'account_id' when calling AdCreativesApi.list_partnership_ad_permissions, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/v1/ads/partnership-permissions'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'accountId'] = account_id
+      query_params[:'creatorUsername'] = opts[:'creator_username'] if !opts[:'creator_username'].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] || 'ListPartnershipAdPermissions200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AdCreativesApi.list_partnership_ad_permissions",
+        :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: AdCreativesApi#list_partnership_ad_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Set partnership permission
+    # Private beta. Requests permission from a creator or revokes it when revoke is true. Requests require the creator to approve in Instagram. Requires instagram_branded_content_ads_brand permission.
+    # @param set_partnership_ad_permission_request [SetPartnershipAdPermissionRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [SetPartnershipAdPermission200Response]
+    def set_partnership_ad_permission(set_partnership_ad_permission_request, opts = {})
+      data, _status_code, _headers = set_partnership_ad_permission_with_http_info(set_partnership_ad_permission_request, opts)
+      data
+    end
+
+    # Set partnership permission
+    # Private beta. Requests permission from a creator or revokes it when revoke is true. Requests require the creator to approve in Instagram. Requires instagram_branded_content_ads_brand permission.
+    # @param set_partnership_ad_permission_request [SetPartnershipAdPermissionRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SetPartnershipAdPermission200Response, Integer, Hash)>] SetPartnershipAdPermission200Response data, response status code and response headers
+    def set_partnership_ad_permission_with_http_info(set_partnership_ad_permission_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AdCreativesApi.set_partnership_ad_permission ...'
+      end
+      # verify the required parameter 'set_partnership_ad_permission_request' is set
+      if @api_client.config.client_side_validation && set_partnership_ad_permission_request.nil?
+        fail ArgumentError, "Missing the required parameter 'set_partnership_ad_permission_request' when calling AdCreativesApi.set_partnership_ad_permission"
+      end
+      # resource path
+      local_var_path = '/v1/ads/partnership-permissions'
+
+      # 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(set_partnership_ad_permission_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SetPartnershipAdPermission200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AdCreativesApi.set_partnership_ad_permission",
+        :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: AdCreativesApi#set_partnership_ad_permission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Rename a creative
     # Renames a creative. Creatives are immutable on Meta beyond `name`. For content changes create a new creative (POST /v1/ads/creatives) and swap it onto the ad (PUT /v1/ads/{adId} with `creative`).
     # @param creative_id [String] Platform creative id