late-sdk 0.0.894 → 0.0.896

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

@@ -40,9 +40,12 @@ module Zernio
     # Meta only. Instagram identity the ad runs AS (creative.instagram_user_id), overriding the account linked to the Page. Live-verified against a Page-post creative.
     attr_accessor :instagram_account_id
 
-    # Meta only. Ad-set destination_type: where the click LANDS, as opposed to instagramAccountId which is who the ad runs as. Lead ads force ON_AD and ignore this.
+    # Meta only. Ad-set destination_type: where the click LANDS, as opposed to instagramAccountId which is who the ad runs as. Messaging destinations imply their matching CTA and require goal engagement. Lead ads use ON_AD; combining an instant form with a messaging destination is rejected.
     attr_accessor :destination_type
 
+    # Meta WhatsApp only. E.164 number already paired with the Page. Omit to use the default pairing. Requires WHATSAPP destinationType or WHATSAPP_MESSAGE callToAction.
+    attr_accessor :whatsapp_phone_number
+
     # ISO 4217 currency code matching the ad account's currency. Meta only. Optional: Zernio resolves it from the ad account when omitted. The value selects the minor-unit exponent Zernio converts budget/bid amounts by before calling Meta (most currencies are cents; zero-decimal currencies like JPY/KRW are sent as-is).
     attr_accessor :currency
 
@@ -78,10 +81,10 @@ module Zernio
     # Meta only. Beneficiary/payer entity IDs for regionalRegulatedCategories. Values are numeric IDs from Meta verification. Keys vary by category (e.g. universal_beneficiary / universal_payer for BRAZIL_REGULATION and THAILAND_UNIVERSAL). If omitted, Meta uses Ads Manager defaults when configured.
     attr_accessor :regional_regulation_identities
 
-    # Destination URL for the CTA button. Send it together with `callToAction`.  **Meta**: adds a top-level `call_to_action` to the post-reference creative. This is what gives a `traffic` boost a clickable destination without replacing the creative and losing the post's social proof. Ignored when `leadGenFormId` is set, which supplies its own destination. Live-verified against a Page-post creative.  **TikTok**: maps to `landing_page_url` on the Spark Ad creative (`AdcreateCreatives.landing_page_url`); Spark Ads have no clickable destination without it.  Ignored on LinkedIn / Pinterest / X / Google, which infer the destination from the boosted post. 
+    # Website URL for non-messaging CTA buttons. Send it with `callToAction`. Omit for messaging boosts.  **Meta**: adds a top-level `call_to_action` to the post-reference creative. This is what gives a `traffic` boost a clickable destination without replacing the creative and losing the post's social proof. Ignored when `leadGenFormId` is set, which supplies its own destination. Live-verified against a Page-post creative.  **TikTok**: maps to `landing_page_url` on the Spark Ad creative (`AdcreateCreatives.landing_page_url`); Spark Ads have no clickable destination without it.  Ignored on LinkedIn / Pinterest / X / Google, which infer the destination from the boosted post. 
     attr_accessor :link_url
 
-    # CTA button label. Send it together with `linkUrl`: a CTA without a destination produces a button that goes nowhere, so sending one alone is a 400.  **Meta**: the CTA enum of POST /v1/ads/create plus `VIEW_INSTAGRAM_PROFILE`, which is accepted on boost only. For that value `linkUrl` is typically the Instagram profile URL.  **TikTok**: pass-through to `call_to_action` on the Spark Ad creative; the platform validates the value. See TikTok's \"Enumeration - Call-to-Action\". 
+    # CTA button label. Non-messaging CTAs require `linkUrl`. WHATSAPP_MESSAGE, MESSAGE_PAGE, and INSTAGRAM_MESSAGE do not require a URL and reject linkUrl.  **Meta**: the CTA enum of POST /v1/ads/create plus `VIEW_INSTAGRAM_PROFILE`, `WHATSAPP_MESSAGE`, `MESSAGE_PAGE`, and `INSTAGRAM_MESSAGE`. VIEW_INSTAGRAM_PROFILE requires linkUrl; the messaging CTAs select their destination automatically.  **TikTok**: pass-through to `call_to_action` on the Spark Ad creative; the platform validates the value. See TikTok's \"Enumeration - Call-to-Action\". 
     attr_accessor :call_to_action
 
     # TikTok-only. Spark Code (creator's `auth_code`) authorizing cross-creator Spark Ads: the advertiser can boost a video owned by a DIFFERENT TikTok account. Without this, boosts are limited to videos owned by the same account running the ads (same-BC creators only). The creator generates the code in their TikTok app's Promote settings and shares it with the advertiser. Maps to `auth_code` on the creative entry of /v2/ad/create/. 
@@ -99,7 +102,7 @@ module Zernio
     # Meta, TikTok, and LinkedIn. Publish state of the created entities. Omitted or ACTIVE publishes live (default); PAUSED creates them paused so you can review before they spend. On LinkedIn the whole campaign group, campaign, and creative hierarchy stays PAUSED (intendedStatus PAUSED on each).
     attr_accessor :status
 
-    # Meta only. Explicit ad-set `optimization_goal` override. When omitted, defaults to the value derived from `goal`. The value must be compatible with the objective Meta derives from `goal`, not with the objective used by `POST /v1/ads/create` for the same `goal` name: boost maps `goal: \"engagement\"` to objective `OUTCOME_AWARENESS`, which accepts `REACH`, `IMPRESSIONS`, `AD_RECALL_LIFT`, or THRUPLAY-class values, and rejects `POST_ENGAGEMENT` (that value is only valid under `OUTCOME_ENGAGEMENT`, which create uses for the same goal name). 
+    # Meta only. Explicit ad-set `optimization_goal` override. When omitted, defaults to the value derived from `goal`. Messaging boosts always use CONVERSATIONS and reject another optimizationGoal. Otherwise the value must be compatible with the objective Meta derives from `goal`, not with the objective used by `POST /v1/ads/create` for the same `goal` name: boost maps `goal: \"engagement\"` to objective `OUTCOME_AWARENESS`, which accepts `REACH`, `IMPRESSIONS`, `AD_RECALL_LIFT`, or THRUPLAY-class values, and rejects `POST_ENGAGEMENT` (that value is only valid under `OUTCOME_ENGAGEMENT`, which create uses for the same goal name). 
     attr_accessor :optimization_goal
 
     class EnumAttributeValidator
@@ -137,6 +140,7 @@ module Zernio
         :'budget' => :'budget',
         :'instagram_account_id' => :'instagramAccountId',
         :'destination_type' => :'destinationType',
+        :'whatsapp_phone_number' => :'whatsappPhoneNumber',
         :'currency' => :'currency',
         :'schedule' => :'schedule',
         :'targeting' => :'targeting',
@@ -184,6 +188,7 @@ module Zernio
         :'budget' => :'BoostPostRequestBudget',
         :'instagram_account_id' => :'String',
         :'destination_type' => :'String',
+        :'whatsapp_phone_number' => :'String',
         :'currency' => :'String',
         :'schedule' => :'BoostPostRequestSchedule',
         :'targeting' => :'BoostPostRequestTargeting',
@@ -278,6 +283,10 @@ module Zernio
         self.destination_type = attributes[:'destination_type']
       end
 
+      if attributes.key?(:'whatsapp_phone_number')
+        self.whatsapp_phone_number = attributes[:'whatsapp_phone_number']
+      end
+
       if attributes.key?(:'currency')
         self.currency = attributes[:'currency']
       end
@@ -398,6 +407,11 @@ module Zernio
         invalid_properties.push('invalid value for "goal", goal cannot be nil.')
       end
 
+      pattern = Regexp.new(/^\+[1-9]\d{6,14}$/)
+      if !@whatsapp_phone_number.nil? && @whatsapp_phone_number !~ pattern
+        invalid_properties.push("invalid value for \"whatsapp_phone_number\", must conform to the pattern #{pattern}.")
+      end
+
       if !@currency.nil? && @currency.to_s.length > 3
         invalid_properties.push('invalid value for "currency", the character length must be smaller than or equal to 3.')
       end
@@ -428,8 +442,9 @@ module Zernio
       return false if @goal.nil?
       goal_validator = EnumAttributeValidator.new('String', ["engagement", "traffic", "awareness", "video_views", "lead_generation", "conversions", "app_promotion"])
       return false unless goal_validator.valid?(@goal)
-      destination_type_validator = EnumAttributeValidator.new('String', ["INSTAGRAM_PROFILE", "WEBSITE", "ON_AD", "MESSENGER", "WHATSAPP"])
+      destination_type_validator = EnumAttributeValidator.new('String', ["INSTAGRAM_PROFILE", "WEBSITE", "ON_AD", "MESSENGER", "WHATSAPP", "INSTAGRAM_DIRECT"])
       return false unless destination_type_validator.valid?(@destination_type)
+      return false if !@whatsapp_phone_number.nil? && @whatsapp_phone_number !~ Regexp.new(/^\+[1-9]\d{6,14}$/)
       return false if !@currency.nil? && @currency.to_s.length > 3
       return false if !@currency.nil? && @currency.to_s.length < 3
       return false if !@dsa_beneficiary.nil? && @dsa_beneficiary.to_s.length > 100
@@ -486,13 +501,28 @@ module Zernio
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] destination_type Object to be assigned
     def destination_type=(destination_type)
-      validator = EnumAttributeValidator.new('String', ["INSTAGRAM_PROFILE", "WEBSITE", "ON_AD", "MESSENGER", "WHATSAPP"])
+      validator = EnumAttributeValidator.new('String', ["INSTAGRAM_PROFILE", "WEBSITE", "ON_AD", "MESSENGER", "WHATSAPP", "INSTAGRAM_DIRECT"])
       unless validator.valid?(destination_type)
         fail ArgumentError, "invalid value for \"destination_type\", must be one of #{validator.allowable_values}."
       end
       @destination_type = destination_type
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] whatsapp_phone_number Value to be assigned
+    def whatsapp_phone_number=(whatsapp_phone_number)
+      if whatsapp_phone_number.nil?
+        fail ArgumentError, 'whatsapp_phone_number cannot be nil'
+      end
+
+      pattern = Regexp.new(/^\+[1-9]\d{6,14}$/)
+      if whatsapp_phone_number !~ pattern
+        fail ArgumentError, "invalid value for \"whatsapp_phone_number\", must conform to the pattern #{pattern}."
+      end
+
+      @whatsapp_phone_number = whatsapp_phone_number
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] currency Value to be assigned
     def currency=(currency)
@@ -564,6 +594,7 @@ module Zernio
           budget == o.budget &&
           instagram_account_id == o.instagram_account_id &&
           destination_type == o.destination_type &&
+          whatsapp_phone_number == o.whatsapp_phone_number &&
           currency == o.currency &&
           schedule == o.schedule &&
           targeting == o.targeting &&
@@ -596,7 +627,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [post_id, platform_post_id, account_id, ad_account_id, name, goal, ad_set_id, budget, instagram_account_id, destination_type, currency, schedule, targeting, raw_targeting, bid_strategy, bid_amount, roas_average_floor, platform_specific_data, tracking, special_ad_categories, special_ad_category_country, regional_regulated_categories, regional_regulation_identities, link_url, call_to_action, spark_auth_code, dsa_beneficiary, dsa_payor, lead_gen_form_id, status, optimization_goal].hash
+      [post_id, platform_post_id, account_id, ad_account_id, name, goal, ad_set_id, budget, instagram_account_id, destination_type, whatsapp_phone_number, currency, schedule, targeting, raw_targeting, bid_strategy, bid_amount, roas_average_floor, platform_specific_data, tracking, special_ad_categories, special_ad_category_country, regional_regulated_categories, regional_regulation_identities, link_url, call_to_action, spark_auth_code, dsa_beneficiary, dsa_payor, lead_gen_form_id, status, optimization_goal].hash
     end
 
     # Builds the object from hash

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

@@ -17,6 +17,8 @@ module Zernio
   class CampaignAnalyticsResponseAnalytics < ApiModelBase
     attr_accessor :summary
 
+    attr_accessor :impression_share_cache
+
     attr_accessor :daily
 
     attr_accessor :breakdowns
@@ -25,6 +27,7 @@ module Zernio
     def self.attribute_map
       {
         :'summary' => :'summary',
+        :'impression_share_cache' => :'impressionShareCache',
         :'daily' => :'daily',
         :'breakdowns' => :'breakdowns'
       }
@@ -43,7 +46,8 @@ module Zernio
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'summary' => :'AdMetrics',
+        :'summary' => :'CampaignAnalyticsResponseAnalyticsSummary',
+        :'impression_share_cache' => :'CampaignAnalyticsResponseAnalyticsImpressionShareCache',
         :'daily' => :'Array<CampaignAnalyticsResponseAnalyticsDailyInner>',
         :'breakdowns' => :'Hash<String, Array<Object>>'
       }
@@ -75,6 +79,10 @@ module Zernio
         self.summary = attributes[:'summary']
       end
 
+      if attributes.key?(:'impression_share_cache')
+        self.impression_share_cache = attributes[:'impression_share_cache']
+      end
+
       if attributes.key?(:'daily')
         if (value = attributes[:'daily']).is_a?(Array)
           self.daily = value
@@ -109,6 +117,7 @@ module Zernio
       return true if self.equal?(o)
       self.class == o.class &&
           summary == o.summary &&
+          impression_share_cache == o.impression_share_cache &&
           daily == o.daily &&
           breakdowns == o.breakdowns
     end
@@ -122,7 +131,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [summary, daily, breakdowns].hash
+      [summary, impression_share_cache, daily, breakdowns].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,158 @@
+=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
+  # Google only. Cache status of the single date-range impression-share query.
+  class CampaignAnalyticsResponseAnalyticsImpressionShareCache < ApiModelBase
+    attr_accessor :cached_at
+
+    attr_accessor :stale
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'cached_at' => :'cachedAt',
+        :'stale' => :'stale'
+      }
+    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
+      {
+        :'cached_at' => :'Time',
+        :'stale' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'cached_at',
+      ])
+    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::CampaignAnalyticsResponseAnalyticsImpressionShareCache` 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::CampaignAnalyticsResponseAnalyticsImpressionShareCache`. 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?(:'cached_at')
+        self.cached_at = attributes[:'cached_at']
+      end
+
+      if attributes.key?(:'stale')
+        self.stale = attributes[:'stale']
+      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 &&
+          cached_at == o.cached_at &&
+          stale == o.stale
+    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
+      [cached_at, stale].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