zernio-sdk 0.0.543 → 0.0.545

data/docs/WhatsAppApi.md

@@ -20,6 +20,7 @@ All URIs are relative to *https://zernio.com/api*
 | [**get_whats_app_dataset**](WhatsAppApi.md#get_whats_app_dataset) | **GET** /v1/whatsapp/dataset | Get CTWA conversions dataset |
 | [**get_whats_app_display_name**](WhatsAppApi.md#get_whats_app_display_name) | **GET** /v1/whatsapp/business-profile/display-name | Get display name status |
 | [**get_whats_app_group_chat**](WhatsAppApi.md#get_whats_app_group_chat) | **GET** /v1/whatsapp/wa-groups/{groupId} | Get group info |
+| [**get_whats_app_media**](WhatsAppApi.md#get_whats_app_media) | **GET** /v1/whatsapp/media/{mediaId} | Download WhatsApp media |
 | [**get_whats_app_template**](WhatsAppApi.md#get_whats_app_template) | **GET** /v1/whatsapp/templates/{templateName} | Get template |
 | [**get_whats_app_templates**](WhatsAppApi.md#get_whats_app_templates) | **GET** /v1/whatsapp/templates | List templates |
 | [**get_whatsapp_business_username**](WhatsAppApi.md#get_whatsapp_business_username) | **GET** /v1/whatsapp/business-profile/username | Get business username |
@@ -1167,6 +1168,77 @@ end
 - **Accept**: application/json
 
 
+## get_whats_app_media
+
+> File get_whats_app_media(media_id, account_id)
+
+Download WhatsApp media
+
+Streams the binary for a WhatsApp attachment. This is the endpoint the `url` on a WhatsApp `attachments[]` entry points at, in both the `message.received` webhook and the List messages response.  **This is an authenticated endpoint, not a public link.** Send `Authorization: Bearer <your API key>` exactly as you would for any other call. Passing the URL straight to a browser, an LLM vision API, or a no-code \"download file\" step without the header returns `401`. This is the most common integration mistake on this endpoint, and it differs from Instagram, Facebook and Telegram, whose `attachments[].url` is a direct CDN link that needs no header.  **Fetch on receipt, not lazily.** WhatsApp media lives in Meta's media store, not ours, and it is removed after a limited retention window (currently 7 days, and Meta has been dropping some inbound media sooner). Once Meta drops it the media is unrecoverable and this endpoint answers `400` permanently, so retrying will never succeed. Download and store the bytes when the webhook arrives. 
+
+### 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::WhatsAppApi.new
+media_id = 'media_id_example' # String | The media id from `attachments[].payload.id`.
+account_id = 'account_id_example' # String | The WhatsApp account that received the media.
+
+begin
+  # Download WhatsApp media
+  result = api_instance.get_whats_app_media(media_id, account_id)
+  p result
+rescue Zernio::ApiError => e
+  puts "Error when calling WhatsAppApi->get_whats_app_media: #{e}"
+end
+```
+
+#### Using the get_whats_app_media_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(File, Integer, Hash)> get_whats_app_media_with_http_info(media_id, account_id)
+
+```ruby
+begin
+  # Download WhatsApp media
+  data, status_code, headers = api_instance.get_whats_app_media_with_http_info(media_id, account_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => File
+rescue Zernio::ApiError => e
+  puts "Error when calling WhatsAppApi->get_whats_app_media_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **media_id** | **String** | The media id from &#x60;attachments[].payload.id&#x60;. |  |
+| **account_id** | **String** | The WhatsApp account that received the media. |  |
+
+### Return type
+
+**File**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/octet-stream, application/json
+
+
 ## get_whats_app_template
 
 > <GetWhatsAppTemplate200Response> get_whats_app_template(template_name, account_id)

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).