late-sdk 0.0.899 → 0.0.901

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

@@ -16,6 +16,15 @@ require 'time'
 module Zernio
   # Platform-specific creative data. Fields vary by platform.
   class AdCreative < ApiModelBase
+    # Google RSA only. Replaces the complete headline list. No padding or truncation on update.
+    attr_accessor :headlines
+
+    # Google RSA only. Replaces the complete description list. No padding or truncation on update.
+    attr_accessor :descriptions
+
+    # Google RSA only. Replaces final URLs. Omitted lists stay unchanged.
+    attr_accessor :final_urls
+
     # Primary thumbnail/image URL
     attr_accessor :thumbnail_url
 
@@ -112,6 +121,9 @@ module Zernio
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'headlines' => :'headlines',
+        :'descriptions' => :'descriptions',
+        :'final_urls' => :'finalUrls',
         :'thumbnail_url' => :'thumbnailUrl',
         :'image_url' => :'imageUrl',
         :'video_id' => :'videoId',
@@ -153,6 +165,9 @@ module Zernio
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'headlines' => :'Array<GoogleRsaHeadline>',
+        :'descriptions' => :'Array<GoogleRsaDescription>',
+        :'final_urls' => :'Array<String>',
         :'thumbnail_url' => :'String',
         :'image_url' => :'String',
         :'video_id' => :'String',
@@ -214,6 +229,24 @@ module Zernio
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'headlines')
+        if (value = attributes[:'headlines']).is_a?(Array)
+          self.headlines = value
+        end
+      end
+
+      if attributes.key?(:'descriptions')
+        if (value = attributes[:'descriptions']).is_a?(Array)
+          self.descriptions = value
+        end
+      end
+
+      if attributes.key?(:'final_urls')
+        if (value = attributes[:'final_urls']).is_a?(Array)
+          self.final_urls = value
+        end
+      end
+
       if attributes.key?(:'thumbnail_url')
         self.thumbnail_url = attributes[:'thumbnail_url']
       end
@@ -324,6 +357,26 @@ module Zernio
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if !@headlines.nil? && @headlines.length > 15
+        invalid_properties.push('invalid value for "headlines", number of items must be less than or equal to 15.')
+      end
+
+      if !@headlines.nil? && @headlines.length < 3
+        invalid_properties.push('invalid value for "headlines", number of items must be greater than or equal to 3.')
+      end
+
+      if !@descriptions.nil? && @descriptions.length > 4
+        invalid_properties.push('invalid value for "descriptions", number of items must be less than or equal to 4.')
+      end
+
+      if !@descriptions.nil? && @descriptions.length < 2
+        invalid_properties.push('invalid value for "descriptions", number of items must be greater than or equal to 2.')
+      end
+
+      if !@final_urls.nil? && @final_urls.length < 1
+        invalid_properties.push('invalid value for "final_urls", number of items must be greater than or equal to 1.')
+      end
+
       invalid_properties
     end
 
@@ -331,14 +384,72 @@ module Zernio
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if !@headlines.nil? && @headlines.length > 15
+      return false if !@headlines.nil? && @headlines.length < 3
+      return false if !@descriptions.nil? && @descriptions.length > 4
+      return false if !@descriptions.nil? && @descriptions.length < 2
+      return false if !@final_urls.nil? && @final_urls.length < 1
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] headlines Value to be assigned
+    def headlines=(headlines)
+      if headlines.nil?
+        fail ArgumentError, 'headlines cannot be nil'
+      end
+
+      if headlines.length > 15
+        fail ArgumentError, 'invalid value for "headlines", number of items must be less than or equal to 15.'
+      end
+
+      if headlines.length < 3
+        fail ArgumentError, 'invalid value for "headlines", number of items must be greater than or equal to 3.'
+      end
+
+      @headlines = headlines
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] descriptions Value to be assigned
+    def descriptions=(descriptions)
+      if descriptions.nil?
+        fail ArgumentError, 'descriptions cannot be nil'
+      end
+
+      if descriptions.length > 4
+        fail ArgumentError, 'invalid value for "descriptions", number of items must be less than or equal to 4.'
+      end
+
+      if descriptions.length < 2
+        fail ArgumentError, 'invalid value for "descriptions", number of items must be greater than or equal to 2.'
+      end
+
+      @descriptions = descriptions
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] final_urls Value to be assigned
+    def final_urls=(final_urls)
+      if final_urls.nil?
+        fail ArgumentError, 'final_urls cannot be nil'
+      end
+
+      if final_urls.length < 1
+        fail ArgumentError, 'invalid value for "final_urls", number of items must be greater than or equal to 1.'
+      end
+
+      @final_urls = final_urls
+    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 &&
+          headlines == o.headlines &&
+          descriptions == o.descriptions &&
+          final_urls == o.final_urls &&
           thumbnail_url == o.thumbnail_url &&
           image_url == o.image_url &&
           video_id == o.video_id &&
@@ -375,7 +486,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [thumbnail_url, image_url, video_id, video_url, promotion, promotion_status, creative_id, object_type, object_story_id, effective_object_story_id, page_id, effective_instagram_media_id, instagram_user_id, instagram_permalink_url, media_urls, is_serving, serving_hold_reasons, body, google_headline, google_description, link_url, whatsapp_phone_number, pinterest_image_url, pinterest_title, pinterest_description].hash
+      [headlines, descriptions, final_urls, thumbnail_url, image_url, video_id, video_url, promotion, promotion_status, creative_id, object_type, object_story_id, effective_object_story_id, page_id, effective_instagram_media_id, instagram_user_id, instagram_permalink_url, media_urls, is_serving, serving_hold_reasons, body, google_headline, google_description, link_url, whatsapp_phone_number, pinterest_image_url, pinterest_title, pinterest_description].hash
     end
 
     # Builds the object from hash

data/lib/zernio-sdk/models/{create_standalone_ad_request_tracking.rb → ad_tracking.rb}

@@ -14,12 +14,12 @@ require 'date'
 require 'time'
 
 module Zernio
-  # Meta only. Attaches pixel measurement to the ad regardless of the optimization goal (the \"Website events\" tracking row in Ads Manager). `pixelId` becomes the ad's `tracking_specs` (offsite_conversion + fb_pixel); `urlTags` becomes the ad's `url_tags` (click-tracking query params). Applied on the legacy single-creative shape, every ad of the multi-creative shape, and the attach shape. NOTE: tracking lives on the AD object and is not inherited from the ad set, so pass it on EVERY attach call that should carry the pixel.
-  class CreateStandaloneAdRequestTracking < ApiModelBase
+  # Meta only. Attaches pixel measurement to the ad regardless of the optimization goal (the \"Website events\" tracking row in Ads Manager). `pixelId` becomes the ad's `tracking_specs` (offsite_conversion + fb_pixel); `urlTags` is stored on the new creative as `url_tags` and retained on the ad for compatibility. Applied on the legacy single-creative shape, every ad of the multi-creative shape, and the attach shape. NOTE: tracking lives on the AD object and is not inherited from the ad set, so pass it on EVERY attach call that should carry the pixel.
+  class AdTracking < ApiModelBase
     # Meta Pixel ID to attach for offsite-conversion measurement.
     attr_accessor :pixel_id
 
-    # 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.
+    # Click-URL params stored on the creative as `url_tags` and returned by GET /v1/ads/{adId}/tracking-tags. App-promotion linkUrl stays byte-identical to promotedObject.objectStoreUrl. Meta dynamic macros ({{ad.id}}, {{campaign.id}}, {{placement}}, ...) are sent through unescaped so Meta expands them; every other character is percent-encoded.
     attr_accessor :url_tags
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -58,14 +58,14 @@ module Zernio
     # @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::CreateStandaloneAdRequestTracking` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::AdTracking` 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::CreateStandaloneAdRequestTracking`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::AdTracking`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }

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

@@ -15,13 +15,12 @@ require 'time'
 
 module Zernio
   class AddAccountCalloutsRequest < ApiModelBase
-    # Zernio SocialAccount id owning the Google Ads connection.
+    # Zernio Google Ads connection id.
     attr_accessor :account_id
 
-    # Numeric Google Ads customer id. Only required when the connection has more than one.
+    # Google customer id without dashes. Required when the connection has multiple customers.
     attr_accessor :customer_id
 
-    # Callout text, 1-25 characters each; up to 20 per request (Google's CalloutAsset limits).
     attr_accessor :callouts
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -102,6 +101,16 @@ module Zernio
         invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
       end
 
+      pattern = Regexp.new(/^[a-fA-F0-9]{24}$/)
+      if @account_id !~ pattern
+        invalid_properties.push("invalid value for \"account_id\", must conform to the pattern #{pattern}.")
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if !@customer_id.nil? && @customer_id !~ pattern
+        invalid_properties.push("invalid value for \"customer_id\", must conform to the pattern #{pattern}.")
+      end
+
       if @callouts.nil?
         invalid_properties.push('invalid value for "callouts", callouts cannot be nil.')
       end
@@ -122,6 +131,8 @@ module Zernio
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @account_id.nil?
+      return false if @account_id !~ Regexp.new(/^[a-fA-F0-9]{24}$/)
+      return false if !@customer_id.nil? && @customer_id !~ Regexp.new(/^\d+$/)
       return false if @callouts.nil?
       return false if @callouts.length > 20
       return false if @callouts.length < 1
@@ -135,9 +146,29 @@ module Zernio
         fail ArgumentError, 'account_id cannot be nil'
       end
 
+      pattern = Regexp.new(/^[a-fA-F0-9]{24}$/)
+      if account_id !~ pattern
+        fail ArgumentError, "invalid value for \"account_id\", must conform to the pattern #{pattern}."
+      end
+
       @account_id = account_id
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] customer_id Value to be assigned
+    def customer_id=(customer_id)
+      if customer_id.nil?
+        fail ArgumentError, 'customer_id cannot be nil'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if customer_id !~ pattern
+        fail ArgumentError, "invalid value for \"customer_id\", must conform to the pattern #{pattern}."
+      end
+
+      @customer_id = customer_id
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] callouts Value to be assigned
     def callouts=(callouts)

data/lib/zernio-sdk/models/add_account_sitelinks201_response.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
+  class AddAccountSitelinks201Response < ApiModelBase
+    attr_accessor :customer_id
+
+    attr_accessor :sitelinks
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'customer_id' => :'customerId',
+        :'sitelinks' => :'sitelinks'
+      }
+    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
+      {
+        :'customer_id' => :'String',
+        :'sitelinks' => :'Array<AddAccountSitelinks201ResponseSitelinksInner>'
+      }
+    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::AddAccountSitelinks201Response` 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::AddAccountSitelinks201Response`. 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?(:'customer_id')
+        self.customer_id = attributes[:'customer_id']
+      end
+
+      if attributes.key?(:'sitelinks')
+        if (value = attributes[:'sitelinks']).is_a?(Array)
+          self.sitelinks = value
+        end
+      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 &&
+          customer_id == o.customer_id &&
+          sitelinks == o.sitelinks
+    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
+      [customer_id, sitelinks].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