late-sdk 0.0.899 → 0.0.901

data/docs/CreateStandaloneAdRequestPromotedObject.md

@@ -1,38 +0,0 @@
-# Zernio::CreateStandaloneAdRequestPromotedObject
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **pixel_id** | **String** | Pixel ID. **Meta:** Facebook Pixel ID, required for `goal: conversions`. Requires `customEventType` alongside it; Meta rejects any promoted_object carrying `pixel_id` without `custom_event_type` (error_subcode 1885014), even when `customConversionId` is also present. **TikTok:** TikTok Pixel ID, required for `goal: conversions`. To discover the pixels an ad account can use, call `GET /v1/accounts/{accountId}/tracking-tags?adAccountId=act_...` (each entry carries `kind` and `ownerAdAccountId`), or `GET /v1/accounts/{accountId}/conversion-destinations`. Note this is a different resource from `GET /v1/ads/{adId}/tracking-tags`, which reads an ad's click-URL params (`url_tags`), not pixels.  | [optional] |
-| **custom_event_type** | **String** | The event the campaign/ad group optimises against.  **Meta:** standard event like `PURCHASE`, `LEAD`, `COMPLETE_REGISTRATION`, `ADD_TO_CART`. Uppercased internally so callers can pass any case. Required for `goal: conversions`.  **TikTok:** an `optimization_event` code (UPPER_SNAKE, not Meta's vocabulary and not PascalCase), OR the exact event name shown in TikTok Events Manager (auto-resolved to its code). Must be one of the event types your TikTok Pixel tracks; custom events are not optimizable. Current taxonomy: `SHOPPING` (Purchase), `ON_WEB_CART` (Add to Cart), `INITIATE_ORDER` (Initiate Checkout), `FORM` (Lead), `ON_WEB_REGISTER` (Complete Registration), `ON_WEB_DETAIL` (View Content). `ON_WEB_ORDER` is deprecated. On rejection the error lists the event types your pixel actually tracks. Optional for `goal: conversions`.  | [optional] |
-| **custom_event_str** | **String** | Meta only. Pixel custom-event name to optimise against (Meta's `custom_event_str`), exactly as it appears in Events Manager and in your CAPI payloads (case-sensitive, not uppercased). Requires `customEventType: OTHER`, and `OTHER` requires this field (400 either way). The same as picking a custom event in Ads Manager's conversion-event dropdown. For rule-based Custom Conversions use `customConversionId` instead.  | [optional] |
-| **page_id** | **String** | Facebook Page ID. Used by `goal: lead_generation`. Auto-filled from the connected Page when omitted.  | [optional] |
-| **application_id** | **String** | App ID. Required for `goal: app_promotion`. | [optional] |
-| **object_store_url** | **String** | App Store / Play Store listing URL. Required for `goal: app_promotion`. | [optional] |
-| **custom_conversion_id** | **String** | Custom Conversion ID, when optimising against one instead of a standard event. Accepted alone by this API, without `pixelId` or `customEventType`. If `pixelId` is also sent, `customEventType` is still required on the promoted_object (Meta rejects `pixel_id` without `custom_event_type`, error_subcode 1885014).  | [optional] |
-| **product_catalog_id** | **String** | Optional catalog ID. If supplied with productSetId, the set must belong to this catalog. A catalog ID cannot replace productSetId. | [optional] |
-| **product_set_id** | **String** | Meta product SET ID from GET /v1/ads/catalogs/{catalogId}/product-sets. Zernio checks that the token can read the set and its product_catalog before creation. A catalog ID or inaccessible set returns a precise 400 naming promotedObject.productSetId. A mismatch with productCatalogId names promotedObject.productCatalogId. | [optional] |
-| **offline_conversion_data_set_id** | **String** | Meta only. Offline event set (dataset) to optimise toward. Post-merger these are datasets: the id is the dataset id (for pixel-backed datasets, the pixel id). | [optional] |
-| **whatsapp_phone_number** | **String** | Meta only. WhatsApp number on messaging-destination ad sets. | [optional] |
-
-## Example
-
-```ruby
-require 'zernio-sdk'
-
-instance = Zernio::CreateStandaloneAdRequestPromotedObject.new(
-  pixel_id: null,
-  custom_event_type: null,
-  custom_event_str: null,
-  page_id: null,
-  application_id: null,
-  object_store_url: null,
-  custom_conversion_id: null,
-  product_catalog_id: null,
-  product_set_id: null,
-  offline_conversion_data_set_id: null,
-  whatsapp_phone_number: null
-)
-```
-

data/docs/CreateStandaloneAdRequestTracking.md

@@ -1,20 +0,0 @@
-# Zernio::CreateStandaloneAdRequestTracking
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **pixel_id** | **String** | Meta Pixel ID to attach for offsite-conversion measurement. | [optional] |
-| **url_tags** | [**Array<UpdateAdTrackingTagsRequestUrlTagsInner>**](UpdateAdTrackingTagsRequestUrlTagsInner.md) | Click-URL params appended to the ad's destination as `url_tags` (e.g. utm_source). Meta dynamic macros ({{ad.id}}, {{campaign.id}}, {{placement}}, ...) are sent through unescaped so Meta expands them; every other character is percent-encoded. | [optional] |
-
-## Example
-
-```ruby
-require 'zernio-sdk'
-
-instance = Zernio::CreateStandaloneAdRequestTracking.new(
-  pixel_id: null,
-  url_tags: null
-)
-```
-

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

@@ -1,249 +0,0 @@
-=begin
-#Zernio API
-
-#API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api  Versioning and deprecation: all endpoints are versioned in the URL path (current version: /v1). Breaking changes only ship in a new path version; existing versions keep working. Deprecated operations are marked 'deprecated: true' in this spec and announced in the changelog (https://zernio.com/changelog) before removal.  Errors: every 4xx/5xx response is application/json with a machine-readable 'code' and a human-readable 'error' message (see the ErrorResponse schema). 
-
-The version of the OpenAPI document: 1.0.4
-Contact: support@zernio.com
-Generated by: https://openapi-generator.tech
-Generator version: 7.19.0
-
-=end
-
-require 'date'
-require 'time'
-
-module Zernio
-  # What the ad optimises against. Behaviour depends on the platform.  **Meta**: forwarded to the ad set's `promoted_object` (snake-cased). Required for goals whose ad-set optimization_goal points at a specific event/page/app (without it Meta rejects the ad-set create with `error_subcode: 1815430` \"Please select a promoted object for your ad set\"):   - `goal: conversions` / `lead_conversion` (OFFSITE_CONVERSIONS): requires `pixelId` + `customEventType`, or `customConversionId` when optimising against a Custom Conversion (the conversion carries its own event definition). For a pixel CUSTOM event (one you named yourself in CAPI/Events Manager), send `customEventType: OTHER` + `customEventStr` with the event name.   - `goal: app_promotion` (APP_INSTALLS): requires `applicationId` + `objectStoreUrl`   - `goal: lead_generation` (LEAD_GENERATION): `pageId` is auto-filled from the connected Page when omitted  Other Meta goals (engagement, traffic, awareness, video_views) ignore this field.  **TikTok**: used by `goal: conversions` and the Smart+ goals (`smartPlus: true`).   - `pixelId` maps to the ad group's `pixel_id`. Required: a TikTok website-conversion     ad group without a pixel is rejected with `40002: Please select a pixel`.   - `customEventType` maps to the ad group's `optimization_event` (the pixel event to     optimise for). Optional on the regular conversions flow, required on Smart+.     See the `customEventType` field below for the valid TikTok codes.   - `applicationId` (Smart+ `goal: app_promotion` only) maps to the ad group's `app_id`:     the App ID of an app registered on the TikTok Ads account (Assets → Events →     App Events). Install optimization needs the app's MMP tracking configured.  The remaining `promotedObject.*` fields are Meta-only. Platforms other than Meta and TikTok ignore `promotedObject` entirely. 
-  class CreateStandaloneAdRequestPromotedObject < ApiModelBase
-    # Pixel ID. **Meta:** Facebook Pixel ID, required for `goal: conversions`. Requires `customEventType` alongside it; Meta rejects any promoted_object carrying `pixel_id` without `custom_event_type` (error_subcode 1885014), even when `customConversionId` is also present. **TikTok:** TikTok Pixel ID, required for `goal: conversions`. To discover the pixels an ad account can use, call `GET /v1/accounts/{accountId}/tracking-tags?adAccountId=act_...` (each entry carries `kind` and `ownerAdAccountId`), or `GET /v1/accounts/{accountId}/conversion-destinations`. Note this is a different resource from `GET /v1/ads/{adId}/tracking-tags`, which reads an ad's click-URL params (`url_tags`), not pixels. 
-    attr_accessor :pixel_id
-
-    # The event the campaign/ad group optimises against.  **Meta:** standard event like `PURCHASE`, `LEAD`, `COMPLETE_REGISTRATION`, `ADD_TO_CART`. Uppercased internally so callers can pass any case. Required for `goal: conversions`.  **TikTok:** an `optimization_event` code (UPPER_SNAKE, not Meta's vocabulary and not PascalCase), OR the exact event name shown in TikTok Events Manager (auto-resolved to its code). Must be one of the event types your TikTok Pixel tracks; custom events are not optimizable. Current taxonomy: `SHOPPING` (Purchase), `ON_WEB_CART` (Add to Cart), `INITIATE_ORDER` (Initiate Checkout), `FORM` (Lead), `ON_WEB_REGISTER` (Complete Registration), `ON_WEB_DETAIL` (View Content). `ON_WEB_ORDER` is deprecated. On rejection the error lists the event types your pixel actually tracks. Optional for `goal: conversions`. 
-    attr_accessor :custom_event_type
-
-    # Meta only. Pixel custom-event name to optimise against (Meta's `custom_event_str`), exactly as it appears in Events Manager and in your CAPI payloads (case-sensitive, not uppercased). Requires `customEventType: OTHER`, and `OTHER` requires this field (400 either way). The same as picking a custom event in Ads Manager's conversion-event dropdown. For rule-based Custom Conversions use `customConversionId` instead. 
-    attr_accessor :custom_event_str
-
-    # Facebook Page ID. Used by `goal: lead_generation`. Auto-filled from the connected Page when omitted. 
-    attr_accessor :page_id
-
-    # App ID. Required for `goal: app_promotion`.
-    attr_accessor :application_id
-
-    # App Store / Play Store listing URL. Required for `goal: app_promotion`.
-    attr_accessor :object_store_url
-
-    # Custom Conversion ID, when optimising against one instead of a standard event. Accepted alone by this API, without `pixelId` or `customEventType`. If `pixelId` is also sent, `customEventType` is still required on the promoted_object (Meta rejects `pixel_id` without `custom_event_type`, error_subcode 1885014). 
-    attr_accessor :custom_conversion_id
-
-    # Optional catalog ID. If supplied with productSetId, the set must belong to this catalog. A catalog ID cannot replace productSetId.
-    attr_accessor :product_catalog_id
-
-    # Meta product SET ID from GET /v1/ads/catalogs/{catalogId}/product-sets. Zernio checks that the token can read the set and its product_catalog before creation. A catalog ID or inaccessible set returns a precise 400 naming promotedObject.productSetId. A mismatch with productCatalogId names promotedObject.productCatalogId.
-    attr_accessor :product_set_id
-
-    # Meta only. Offline event set (dataset) to optimise toward. Post-merger these are datasets: the id is the dataset id (for pixel-backed datasets, the pixel id).
-    attr_accessor :offline_conversion_data_set_id
-
-    # Meta only. WhatsApp number on messaging-destination ad sets.
-    attr_accessor :whatsapp_phone_number
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'pixel_id' => :'pixelId',
-        :'custom_event_type' => :'customEventType',
-        :'custom_event_str' => :'customEventStr',
-        :'page_id' => :'pageId',
-        :'application_id' => :'applicationId',
-        :'object_store_url' => :'objectStoreUrl',
-        :'custom_conversion_id' => :'customConversionId',
-        :'product_catalog_id' => :'productCatalogId',
-        :'product_set_id' => :'productSetId',
-        :'offline_conversion_data_set_id' => :'offlineConversionDataSetId',
-        :'whatsapp_phone_number' => :'whatsappPhoneNumber'
-      }
-    end
-
-    # Returns attribute mapping this model knows about
-    def self.acceptable_attribute_map
-      attribute_map
-    end
-
-    # Returns all the JSON keys this model knows about
-    def self.acceptable_attributes
-      acceptable_attribute_map.values
-    end
-
-    # Attribute type mapping.
-    def self.openapi_types
-      {
-        :'pixel_id' => :'String',
-        :'custom_event_type' => :'String',
-        :'custom_event_str' => :'String',
-        :'page_id' => :'String',
-        :'application_id' => :'String',
-        :'object_store_url' => :'String',
-        :'custom_conversion_id' => :'String',
-        :'product_catalog_id' => :'String',
-        :'product_set_id' => :'String',
-        :'offline_conversion_data_set_id' => :'String',
-        :'whatsapp_phone_number' => :'String'
-      }
-    end
-
-    # List of attributes with nullable: true
-    def self.openapi_nullable
-      Set.new([
-      ])
-    end
-
-    # Initializes the object
-    # @param [Hash] attributes Model attributes in the form of hash
-    def initialize(attributes = {})
-      if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::CreateStandaloneAdRequestPromotedObject` initialize method"
-      end
-
-      # check to see if the attribute exists and convert string to symbol for hash key
-      acceptable_attribute_map = self.class.acceptable_attribute_map
-      attributes = attributes.each_with_object({}) { |(k, v), h|
-        if (!acceptable_attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::CreateStandaloneAdRequestPromotedObject`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
-        end
-        h[k.to_sym] = v
-      }
-
-      if attributes.key?(:'pixel_id')
-        self.pixel_id = attributes[:'pixel_id']
-      end
-
-      if attributes.key?(:'custom_event_type')
-        self.custom_event_type = attributes[:'custom_event_type']
-      end
-
-      if attributes.key?(:'custom_event_str')
-        self.custom_event_str = attributes[:'custom_event_str']
-      end
-
-      if attributes.key?(:'page_id')
-        self.page_id = attributes[:'page_id']
-      end
-
-      if attributes.key?(:'application_id')
-        self.application_id = attributes[:'application_id']
-      end
-
-      if attributes.key?(:'object_store_url')
-        self.object_store_url = attributes[:'object_store_url']
-      end
-
-      if attributes.key?(:'custom_conversion_id')
-        self.custom_conversion_id = attributes[:'custom_conversion_id']
-      end
-
-      if attributes.key?(:'product_catalog_id')
-        self.product_catalog_id = attributes[:'product_catalog_id']
-      end
-
-      if attributes.key?(:'product_set_id')
-        self.product_set_id = attributes[:'product_set_id']
-      end
-
-      if attributes.key?(:'offline_conversion_data_set_id')
-        self.offline_conversion_data_set_id = attributes[:'offline_conversion_data_set_id']
-      end
-
-      if attributes.key?(:'whatsapp_phone_number')
-        self.whatsapp_phone_number = attributes[:'whatsapp_phone_number']
-      end
-    end
-
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    def list_invalid_properties
-      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
-      invalid_properties = Array.new
-      invalid_properties
-    end
-
-    # Check to see if the all the properties in the model are valid
-    # @return true if the model is valid
-    def valid?
-      warn '[DEPRECATED] the `valid?` method is obsolete'
-      true
-    end
-
-    # Checks equality by comparing each attribute.
-    # @param [Object] Object to be compared
-    def ==(o)
-      return true if self.equal?(o)
-      self.class == o.class &&
-          pixel_id == o.pixel_id &&
-          custom_event_type == o.custom_event_type &&
-          custom_event_str == o.custom_event_str &&
-          page_id == o.page_id &&
-          application_id == o.application_id &&
-          object_store_url == o.object_store_url &&
-          custom_conversion_id == o.custom_conversion_id &&
-          product_catalog_id == o.product_catalog_id &&
-          product_set_id == o.product_set_id &&
-          offline_conversion_data_set_id == o.offline_conversion_data_set_id &&
-          whatsapp_phone_number == o.whatsapp_phone_number
-    end
-
-    # @see the `==` method
-    # @param [Object] Object to be compared
-    def eql?(o)
-      self == o
-    end
-
-    # Calculates hash code according to all attributes.
-    # @return [Integer] Hash code
-    def hash
-      [pixel_id, custom_event_type, custom_event_str, page_id, application_id, object_store_url, custom_conversion_id, product_catalog_id, product_set_id, offline_conversion_data_set_id, whatsapp_phone_number].hash
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def self.build_from_hash(attributes)
-      return nil unless attributes.is_a?(Hash)
-      attributes = attributes.transform_keys(&:to_sym)
-      transformed_hash = {}
-      openapi_types.each_pair do |key, type|
-        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
-          transformed_hash["#{key}"] = nil
-        elsif type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the attribute
-          # is documented as an array but the input is not
-          if attributes[attribute_map[key]].is_a?(Array)
-            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
-          end
-        elsif !attributes[attribute_map[key]].nil?
-          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
-        end
-      end
-      new(transformed_hash)
-    end
-
-    # Returns the object in the form of hash
-    # @return [Hash] Returns the object in the form of hash
-    def to_hash
-      hash = {}
-      self.class.attribute_map.each_pair do |attr, param|
-        value = self.send(attr)
-        if value.nil?
-          is_nullable = self.class.openapi_nullable.include?(attr)
-          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
-        end
-
-        hash[param] = _to_hash(value)
-      end
-      hash
-    end
-
-  end
-
-end