zernio-sdk 0.0.536 → 0.0.537

data/docs/CreateAdCampaign201Response.md

@@ -0,0 +1,24 @@
+# Zernio::CreateAdCampaign201Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ad_account_id** | **String** |  | [optional] |
+| **campaign_id** | **String** | Platform id of the new campaign | [optional] |
+| **objective** | **String** | Resolved ODAX objective (e.g. OUTCOME_SALES). | [optional] |
+| **status** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::CreateAdCampaign201Response.new(
+  ad_account_id: null,
+  campaign_id: null,
+  objective: null,
+  status: null
+)
+```
+

data/docs/CreateAdCampaignRequest.md

@@ -0,0 +1,32 @@
+# Zernio::CreateAdCampaignRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token. |  |
+| **ad_account_id** | **String** | Meta ad account id (act_<n>). |  |
+| **name** | **String** |  |  |
+| **goal** | **String** | Mapped to the ODAX objective (same mapping as POST /v1/ads/create). |  |
+| **special_ad_categories** | **Array<String>** |  | [optional] |
+| **budget_amount** | **Float** | Campaign-level (CBO) budget in whole currency units. Requires budgetType. | [optional] |
+| **budget_type** | **String** |  | [optional] |
+| **status** | **String** |  | [optional][default to 'PAUSED'] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::CreateAdCampaignRequest.new(
+  account_id: null,
+  ad_account_id: null,
+  name: null,
+  goal: null,
+  special_ad_categories: null,
+  budget_amount: null,
+  budget_type: null,
+  status: null
+)
+```
+

data/docs/CreateAdCreative201Response.md

@@ -0,0 +1,20 @@
+# Zernio::CreateAdCreative201Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ad_account_id** | **String** |  | [optional] |
+| **creative_id** | **String** | Platform creative id, reusable via existingCreativeId. | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::CreateAdCreative201Response.new(
+  ad_account_id: null,
+  creative_id: null
+)
+```
+

data/docs/CreateAdCreativeRequest.md

@@ -0,0 +1,38 @@
+# Zernio::CreateAdCreativeRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token and Page. |  |
+| **ad_account_id** | **String** | Meta ad account id (act_<n>). |  |
+| **headline** | **String** |  |  |
+| **body** | **String** | Primary text |  |
+| **description** | **String** | Link description below the headline; omitted = Meta scrapes the destination's OG description. | [optional] |
+| **call_to_action** | **String** | CTA type (same whitelist as POST /v1/ads/create). | [optional][default to 'LEARN_MORE'] |
+| **link_url** | **String** |  |  |
+| **image_url** | **String** | Publicly reachable image; uploaded to the account's library server-side. | [optional] |
+| **image_hash** | **String** | Existing library image hash (POST /v1/ads/images or GET /v1/ads/images). | [optional] |
+| **carousel_cards** | [**Array<CreateAdCreativeRequestCarouselCardsInner>**](CreateAdCreativeRequestCarouselCardsInner.md) |  | [optional] |
+| **url_tags** | **String** | Appended to every outbound URL (e.g. utm_source=fb). | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::CreateAdCreativeRequest.new(
+  account_id: null,
+  ad_account_id: null,
+  headline: null,
+  body: null,
+  description: null,
+  call_to_action: null,
+  link_url: null,
+  image_url: null,
+  image_hash: null,
+  carousel_cards: null,
+  url_tags: null
+)
+```
+

data/docs/CreateAdCreativeRequestCarouselCardsInner.md

@@ -0,0 +1,26 @@
+# Zernio::CreateAdCreativeRequestCarouselCardsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **image_url** | **String** |  |  |
+| **link_url** | **String** |  |  |
+| **headline** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **call_to_action** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::CreateAdCreativeRequestCarouselCardsInner.new(
+  image_url: null,
+  link_url: null,
+  headline: null,
+  description: null,
+  call_to_action: null
+)
+```
+

data/docs/DeleteAdCreative200Response.md

@@ -0,0 +1,20 @@
+# Zernio::DeleteAdCreative200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **creative_id** | **String** |  | [optional] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::DeleteAdCreative200Response.new(
+  creative_id: null,
+  message: null
+)
+```
+

data/docs/DuplicateAd200Response.md

@@ -0,0 +1,22 @@
+# Zernio::DuplicateAd200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **copied_ad_id** | **String** | Platform ID of the new ad | [optional] |
+| **discovery** | **String** |  | [optional] |
+| **raw** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::DuplicateAd200Response.new(
+  copied_ad_id: null,
+  discovery: null,
+  raw: null
+)
+```
+

data/docs/DuplicateAdRequest.md

@@ -0,0 +1,28 @@
+# Zernio::DuplicateAdRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ad_set_id** | **String** | Destination platform ad set id (defaults to the source's ad set) | [optional] |
+| **status_option** | **String** |  | [optional][default to 'PAUSED'] |
+| **rename_strategy** | **String** |  | [optional] |
+| **rename_prefix** | **String** |  | [optional] |
+| **rename_suffix** | **String** |  | [optional] |
+| **sync_after** | **Boolean** |  | [optional][default to true] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::DuplicateAdRequest.new(
+  ad_set_id: null,
+  status_option: null,
+  rename_strategy: null,
+  rename_prefix: null,
+  rename_suffix: null,
+  sync_after: null
+)
+```
+

data/docs/DuplicateAdSet200Response.md

@@ -0,0 +1,22 @@
+# Zernio::DuplicateAdSet200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **copied_ad_set_id** | **String** | Platform ID of the new ad set | [optional] |
+| **discovery** | **String** |  | [optional] |
+| **raw** | **Object** | Meta's native copy response (includes ad_object_ids for child copies) | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::DuplicateAdSet200Response.new(
+  copied_ad_set_id: null,
+  discovery: null,
+  raw: null
+)
+```
+

data/docs/DuplicateAdSetRequest.md

@@ -0,0 +1,36 @@
+# Zernio::DuplicateAdSetRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **platform** | **String** |  |  |
+| **campaign_id** | **String** | Destination platform campaign id (defaults to the source's campaign) | [optional] |
+| **deep_copy** | **Boolean** | Copy child ads + creatives | [optional][default to true] |
+| **status_option** | **String** |  | [optional][default to 'PAUSED'] |
+| **start_time** | **Time** | Reschedule the copy's start time | [optional] |
+| **end_time** | **Time** |  | [optional] |
+| **rename_strategy** | **String** |  | [optional] |
+| **rename_prefix** | **String** |  | [optional] |
+| **rename_suffix** | **String** |  | [optional] |
+| **sync_after** | **Boolean** |  | [optional][default to true] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::DuplicateAdSetRequest.new(
+  platform: null,
+  campaign_id: null,
+  deep_copy: null,
+  status_option: null,
+  start_time: null,
+  end_time: null,
+  rename_strategy: null,
+  rename_prefix: null,
+  rename_suffix: null,
+  sync_after: null
+)
+```
+

data/docs/GetAdCreative200Response.md

@@ -0,0 +1,18 @@
+# Zernio::GetAdCreative200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **creative** | **Object** | Raw Meta creative node | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::GetAdCreative200Response.new(
+  creative: null
+)
+```
+

data/docs/ListAdCreatives200Response.md

@@ -0,0 +1,22 @@
+# Zernio::ListAdCreatives200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ad_account_id** | **String** |  | [optional] |
+| **data** | **Array<Object>** |  | [optional] |
+| **paging** | [**QueryAdInsights200ResponsePaging**](QueryAdInsights200ResponsePaging.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::ListAdCreatives200Response.new(
+  ad_account_id: null,
+  data: null,
+  paging: null
+)
+```
+

data/docs/ListAdImages200Response.md

@@ -0,0 +1,22 @@
+# Zernio::ListAdImages200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ad_account_id** | **String** |  | [optional] |
+| **data** | **Array<Object>** |  | [optional] |
+| **paging** | [**QueryAdInsights200ResponsePaging**](QueryAdInsights200ResponsePaging.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::ListAdImages200Response.new(
+  ad_account_id: null,
+  data: null,
+  paging: null
+)
+```
+

data/docs/ListAdLabels200Response.md

@@ -0,0 +1,22 @@
+# Zernio::ListAdLabels200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ad_account_id** | **String** |  | [optional] |
+| **data** | **Array<Object>** |  | [optional] |
+| **paging** | [**QueryAdInsights200ResponsePaging**](QueryAdInsights200ResponsePaging.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::ListAdLabels200Response.new(
+  ad_account_id: null,
+  data: null,
+  paging: null
+)
+```
+

data/docs/ListHighDemandPeriods200Response.md

@@ -0,0 +1,22 @@
+# Zernio::ListHighDemandPeriods200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object_id** | **String** | The campaign / ad set id the schedules belong to. | [optional] |
+| **data** | **Array<Object>** |  | [optional] |
+| **paging** | [**QueryAdInsights200ResponsePaging**](QueryAdInsights200ResponsePaging.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::ListHighDemandPeriods200Response.new(
+  object_id: null,
+  data: null,
+  paging: null
+)
+```
+

data/docs/UpdateAdCreative200Response.md

@@ -0,0 +1,22 @@
+# Zernio::UpdateAdCreative200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **creative_id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::UpdateAdCreative200Response.new(
+  creative_id: null,
+  name: null,
+  message: null
+)
+```
+

data/docs/UpdateAdCreativeRequest.md

@@ -0,0 +1,20 @@
+# Zernio::UpdateAdCreativeRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token. |  |
+| **name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::UpdateAdCreativeRequest.new(
+  account_id: null,
+  name: null
+)
+```
+

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

@@ -372,8 +372,8 @@ module Zernio
       return data, status_code, headers
     end
 
-    # Update saved targeting audience
-    # Update a `saved_targeting` audience's name, description, or spec. Only `saved_targeting` audiences are updatable (they exist only on Zernio); uploaded/derived audiences return 422, delete and recreate those instead. `spec` replaces the stored spec wholesale (no merge). Ads already created from this audience are unaffected, they snapshot the targeting at creation. 
+    # Update an audience
+    # Update an audience. `saved_targeting` audiences accept `name`, `description`, and `spec` (full replacement, no merge, Zernio-only, no platform call). Platform audiences (uploaded/website/lookalike) accept `name` and `description` only, updated on the platform first and then mirrored locally; their rules are immutable, so `spec` returns 400 for them. Platform audience updates are Meta-only for now (other platforms return 501). Ads already created from a saved_targeting audience are unaffected, they snapshot the targeting at creation. 
     # @param audience_id [String] 
     # @param update_ad_audience_request [UpdateAdAudienceRequest] 
     # @param [Hash] opts the optional parameters
@@ -383,8 +383,8 @@ module Zernio
       data
     end
 
-    # Update saved targeting audience
-    # Update a `saved_targeting` audience's name, description, or spec. Only `saved_targeting` audiences are updatable (they exist only on Zernio); uploaded/derived audiences return 422, delete and recreate those instead. `spec` replaces the stored spec wholesale (no merge). Ads already created from this audience are unaffected, they snapshot the targeting at creation. 
+    # Update an audience
+    # Update an audience. `saved_targeting` audiences accept `name`, `description`, and `spec` (full replacement, no merge, Zernio-only, no platform call). Platform audiences (uploaded/website/lookalike) accept `name` and `description` only, updated on the platform first and then mirrored locally; their rules are immutable, so `spec` returns 400 for them. Platform audience updates are Meta-only for now (other platforms return 501). Ads already created from a saved_targeting audience are unaffected, they snapshot the targeting at creation. 
     # @param audience_id [String] 
     # @param update_ad_audience_request [UpdateAdAudienceRequest] 
     # @param [Hash] opts the optional parameters

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

@@ -87,6 +87,74 @@ module Zernio
       return data, status_code, headers
     end
 
+    # Create a standalone campaign (Meta)
+    # Creates a campaign WITHOUT its first ad set / ad (the ODAX shell only). Ad sets join it later via `existingCampaignId` on the create endpoints. A budget here is campaign-level (CBO) by definition; omit it for ABO (each ad set carries its own budget). Created `PAUSED` unless `status: ACTIVE`. The campaign materializes in `/v1/ads/tree` via the next sync discovery pass. Meta only.
+    # @param create_ad_campaign_request [CreateAdCampaignRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateAdCampaign201Response]
+    def create_ad_campaign(create_ad_campaign_request, opts = {})
+      data, _status_code, _headers = create_ad_campaign_with_http_info(create_ad_campaign_request, opts)
+      data
+    end
+
+    # Create a standalone campaign (Meta)
+    # Creates a campaign WITHOUT its first ad set / ad (the ODAX shell only). Ad sets join it later via `existingCampaignId` on the create endpoints. A budget here is campaign-level (CBO) by definition; omit it for ABO (each ad set carries its own budget). Created `PAUSED` unless `status: ACTIVE`. The campaign materializes in `/v1/ads/tree` via the next sync discovery pass. Meta only.
+    # @param create_ad_campaign_request [CreateAdCampaignRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateAdCampaign201Response, Integer, Hash)>] CreateAdCampaign201Response data, response status code and response headers
+    def create_ad_campaign_with_http_info(create_ad_campaign_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AdCampaignsApi.create_ad_campaign ...'
+      end
+      # verify the required parameter 'create_ad_campaign_request' is set
+      if @api_client.config.client_side_validation && create_ad_campaign_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_ad_campaign_request' when calling AdCampaignsApi.create_ad_campaign"
+      end
+      # resource path
+      local_var_path = '/v1/ads/campaigns'
+
+      # 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_ad_campaign_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateAdCampaign201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AdCampaignsApi.create_ad_campaign",
+        :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: AdCampaignsApi#create_ad_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Delete a campaign
     # Deletes the whole campaign on the platform, cascading to its ad sets and ads. Locally, all Ad documents for this campaign are marked `status: cancelled`.  Meta-only for now. Other platforms return 501 Not Implemented — fall back to DELETE /v1/ads/{adId} per ad in the meantime. 
     # @param campaign_id [String] Platform campaign ID
@@ -235,6 +303,80 @@ module Zernio
       return data, status_code, headers
     end
 
+    # Duplicate an ad set (Meta)
+    # Duplicates an ad set, including its ads and creatives by default (`deepCopy: true`), via Meta's native `POST /{adset-id}/copies`. The copy is created paused so callers can review before launching. `campaignId` retargets the copy into another campaign; omitted = the source's own campaign. The new hierarchy materializes asynchronously — sync discovery is triggered automatically (`syncAfter: false` to skip). Meta only.
+    # @param ad_set_id [String] Source platform ad set ID
+    # @param duplicate_ad_set_request [DuplicateAdSetRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [DuplicateAdSet200Response]
+    def duplicate_ad_set(ad_set_id, duplicate_ad_set_request, opts = {})
+      data, _status_code, _headers = duplicate_ad_set_with_http_info(ad_set_id, duplicate_ad_set_request, opts)
+      data
+    end
+
+    # Duplicate an ad set (Meta)
+    # Duplicates an ad set, including its ads and creatives by default (&#x60;deepCopy: true&#x60;), via Meta&#39;s native &#x60;POST /{adset-id}/copies&#x60;. The copy is created paused so callers can review before launching. &#x60;campaignId&#x60; retargets the copy into another campaign; omitted &#x3D; the source&#39;s own campaign. The new hierarchy materializes asynchronously — sync discovery is triggered automatically (&#x60;syncAfter: false&#x60; to skip). Meta only.
+    # @param ad_set_id [String] Source platform ad set ID
+    # @param duplicate_ad_set_request [DuplicateAdSetRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DuplicateAdSet200Response, Integer, Hash)>] DuplicateAdSet200Response data, response status code and response headers
+    def duplicate_ad_set_with_http_info(ad_set_id, duplicate_ad_set_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AdCampaignsApi.duplicate_ad_set ...'
+      end
+      # verify the required parameter 'ad_set_id' is set
+      if @api_client.config.client_side_validation && ad_set_id.nil?
+        fail ArgumentError, "Missing the required parameter 'ad_set_id' when calling AdCampaignsApi.duplicate_ad_set"
+      end
+      # verify the required parameter 'duplicate_ad_set_request' is set
+      if @api_client.config.client_side_validation && duplicate_ad_set_request.nil?
+        fail ArgumentError, "Missing the required parameter 'duplicate_ad_set_request' when calling AdCampaignsApi.duplicate_ad_set"
+      end
+      # resource path
+      local_var_path = '/v1/ads/ad-sets/{adSetId}/duplicate'.sub('{' + 'adSetId' + '}', CGI.escape(ad_set_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(duplicate_ad_set_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'DuplicateAdSet200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AdCampaignsApi.duplicate_ad_set",
+        :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: AdCampaignsApi#duplicate_ad_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Live ad-set details incl. learning phase (Meta)
     # 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. Meta only.
     # @param ad_set_id [String] Meta ad set id (platformAdSetId).