zernio-sdk 0.0.536 → 0.0.538

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

@@ -0,0 +1,390 @@
+=begin
+#Zernio API
+
+#API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api 
+
+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 CreateAdCreativeRequest < ApiModelBase
+    # Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token and Page.
+    attr_accessor :account_id
+
+    # Meta ad account id (act_<n>).
+    attr_accessor :ad_account_id
+
+    attr_accessor :headline
+
+    # Primary text
+    attr_accessor :body
+
+    # Link description below the headline; omitted = Meta scrapes the destination's OG description.
+    attr_accessor :description
+
+    # CTA type (same whitelist as POST /v1/ads/create).
+    attr_accessor :call_to_action
+
+    attr_accessor :link_url
+
+    # Publicly reachable image; uploaded to the account's library server-side.
+    attr_accessor :image_url
+
+    # Existing library image hash (POST /v1/ads/images or GET /v1/ads/images).
+    attr_accessor :image_hash
+
+    attr_accessor :carousel_cards
+
+    # Appended to every outbound URL (e.g. utm_source=fb).
+    attr_accessor :url_tags
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'account_id' => :'accountId',
+        :'ad_account_id' => :'adAccountId',
+        :'headline' => :'headline',
+        :'body' => :'body',
+        :'description' => :'description',
+        :'call_to_action' => :'callToAction',
+        :'link_url' => :'linkUrl',
+        :'image_url' => :'imageUrl',
+        :'image_hash' => :'imageHash',
+        :'carousel_cards' => :'carouselCards',
+        :'url_tags' => :'urlTags'
+      }
+    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
+      {
+        :'account_id' => :'String',
+        :'ad_account_id' => :'String',
+        :'headline' => :'String',
+        :'body' => :'String',
+        :'description' => :'String',
+        :'call_to_action' => :'String',
+        :'link_url' => :'String',
+        :'image_url' => :'String',
+        :'image_hash' => :'String',
+        :'carousel_cards' => :'Array<CreateAdCreativeRequestCarouselCardsInner>',
+        :'url_tags' => :'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::CreateAdCreativeRequest` 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::CreateAdCreativeRequest`. 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?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      else
+        self.account_id = nil
+      end
+
+      if attributes.key?(:'ad_account_id')
+        self.ad_account_id = attributes[:'ad_account_id']
+      else
+        self.ad_account_id = nil
+      end
+
+      if attributes.key?(:'headline')
+        self.headline = attributes[:'headline']
+      else
+        self.headline = nil
+      end
+
+      if attributes.key?(:'body')
+        self.body = attributes[:'body']
+      else
+        self.body = nil
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'call_to_action')
+        self.call_to_action = attributes[:'call_to_action']
+      else
+        self.call_to_action = 'LEARN_MORE'
+      end
+
+      if attributes.key?(:'link_url')
+        self.link_url = attributes[:'link_url']
+      else
+        self.link_url = nil
+      end
+
+      if attributes.key?(:'image_url')
+        self.image_url = attributes[:'image_url']
+      end
+
+      if attributes.key?(:'image_hash')
+        self.image_hash = attributes[:'image_hash']
+      end
+
+      if attributes.key?(:'carousel_cards')
+        if (value = attributes[:'carousel_cards']).is_a?(Array)
+          self.carousel_cards = value
+        end
+      end
+
+      if attributes.key?(:'url_tags')
+        self.url_tags = attributes[:'url_tags']
+      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
+      if @account_id.nil?
+        invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
+      end
+
+      if @ad_account_id.nil?
+        invalid_properties.push('invalid value for "ad_account_id", ad_account_id cannot be nil.')
+      end
+
+      if @headline.nil?
+        invalid_properties.push('invalid value for "headline", headline cannot be nil.')
+      end
+
+      if @headline.to_s.length > 255
+        invalid_properties.push('invalid value for "headline", the character length must be smaller than or equal to 255.')
+      end
+
+      if @body.nil?
+        invalid_properties.push('invalid value for "body", body cannot be nil.')
+      end
+
+      if !@description.nil? && @description.to_s.length > 255
+        invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 255.')
+      end
+
+      if @link_url.nil?
+        invalid_properties.push('invalid value for "link_url", link_url cannot be nil.')
+      end
+
+      if !@carousel_cards.nil? && @carousel_cards.length > 10
+        invalid_properties.push('invalid value for "carousel_cards", number of items must be less than or equal to 10.')
+      end
+
+      if !@carousel_cards.nil? && @carousel_cards.length < 2
+        invalid_properties.push('invalid value for "carousel_cards", number of items must be greater than or equal to 2.')
+      end
+
+      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'
+      return false if @account_id.nil?
+      return false if @ad_account_id.nil?
+      return false if @headline.nil?
+      return false if @headline.to_s.length > 255
+      return false if @body.nil?
+      return false if !@description.nil? && @description.to_s.length > 255
+      return false if @link_url.nil?
+      return false if !@carousel_cards.nil? && @carousel_cards.length > 10
+      return false if !@carousel_cards.nil? && @carousel_cards.length < 2
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] account_id Value to be assigned
+    def account_id=(account_id)
+      if account_id.nil?
+        fail ArgumentError, 'account_id cannot be nil'
+      end
+
+      @account_id = account_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ad_account_id Value to be assigned
+    def ad_account_id=(ad_account_id)
+      if ad_account_id.nil?
+        fail ArgumentError, 'ad_account_id cannot be nil'
+      end
+
+      @ad_account_id = ad_account_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] headline Value to be assigned
+    def headline=(headline)
+      if headline.nil?
+        fail ArgumentError, 'headline cannot be nil'
+      end
+
+      if headline.to_s.length > 255
+        fail ArgumentError, 'invalid value for "headline", the character length must be smaller than or equal to 255.'
+      end
+
+      @headline = headline
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] body Value to be assigned
+    def body=(body)
+      if body.nil?
+        fail ArgumentError, 'body cannot be nil'
+      end
+
+      @body = body
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if description.nil?
+        fail ArgumentError, 'description cannot be nil'
+      end
+
+      if description.to_s.length > 255
+        fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 255.'
+      end
+
+      @description = description
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] link_url Value to be assigned
+    def link_url=(link_url)
+      if link_url.nil?
+        fail ArgumentError, 'link_url cannot be nil'
+      end
+
+      @link_url = link_url
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] carousel_cards Value to be assigned
+    def carousel_cards=(carousel_cards)
+      if carousel_cards.nil?
+        fail ArgumentError, 'carousel_cards cannot be nil'
+      end
+
+      if carousel_cards.length > 10
+        fail ArgumentError, 'invalid value for "carousel_cards", number of items must be less than or equal to 10.'
+      end
+
+      if carousel_cards.length < 2
+        fail ArgumentError, 'invalid value for "carousel_cards", number of items must be greater than or equal to 2.'
+      end
+
+      @carousel_cards = carousel_cards
+    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 &&
+          account_id == o.account_id &&
+          ad_account_id == o.ad_account_id &&
+          headline == o.headline &&
+          body == o.body &&
+          description == o.description &&
+          call_to_action == o.call_to_action &&
+          link_url == o.link_url &&
+          image_url == o.image_url &&
+          image_hash == o.image_hash &&
+          carousel_cards == o.carousel_cards &&
+          url_tags == o.url_tags
+    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
+      [account_id, ad_account_id, headline, body, description, call_to_action, link_url, image_url, image_hash, carousel_cards, url_tags].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

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

@@ -0,0 +1,255 @@
+=begin
+#Zernio API
+
+#API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api 
+
+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 CreateAdCreativeRequestCarouselCardsInner < ApiModelBase
+    attr_accessor :image_url
+
+    attr_accessor :link_url
+
+    attr_accessor :headline
+
+    attr_accessor :description
+
+    attr_accessor :call_to_action
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'image_url' => :'imageUrl',
+        :'link_url' => :'linkUrl',
+        :'headline' => :'headline',
+        :'description' => :'description',
+        :'call_to_action' => :'callToAction'
+      }
+    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
+      {
+        :'image_url' => :'String',
+        :'link_url' => :'String',
+        :'headline' => :'String',
+        :'description' => :'String',
+        :'call_to_action' => :'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::CreateAdCreativeRequestCarouselCardsInner` 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::CreateAdCreativeRequestCarouselCardsInner`. 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?(:'image_url')
+        self.image_url = attributes[:'image_url']
+      else
+        self.image_url = nil
+      end
+
+      if attributes.key?(:'link_url')
+        self.link_url = attributes[:'link_url']
+      else
+        self.link_url = nil
+      end
+
+      if attributes.key?(:'headline')
+        self.headline = attributes[:'headline']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'call_to_action')
+        self.call_to_action = attributes[:'call_to_action']
+      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
+      if @image_url.nil?
+        invalid_properties.push('invalid value for "image_url", image_url cannot be nil.')
+      end
+
+      if @link_url.nil?
+        invalid_properties.push('invalid value for "link_url", link_url cannot be nil.')
+      end
+
+      if !@headline.nil? && @headline.to_s.length > 255
+        invalid_properties.push('invalid value for "headline", the character length must be smaller than or equal to 255.')
+      end
+
+      if !@description.nil? && @description.to_s.length > 255
+        invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 255.')
+      end
+
+      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'
+      return false if @image_url.nil?
+      return false if @link_url.nil?
+      return false if !@headline.nil? && @headline.to_s.length > 255
+      return false if !@description.nil? && @description.to_s.length > 255
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] image_url Value to be assigned
+    def image_url=(image_url)
+      if image_url.nil?
+        fail ArgumentError, 'image_url cannot be nil'
+      end
+
+      @image_url = image_url
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] link_url Value to be assigned
+    def link_url=(link_url)
+      if link_url.nil?
+        fail ArgumentError, 'link_url cannot be nil'
+      end
+
+      @link_url = link_url
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] headline Value to be assigned
+    def headline=(headline)
+      if headline.nil?
+        fail ArgumentError, 'headline cannot be nil'
+      end
+
+      if headline.to_s.length > 255
+        fail ArgumentError, 'invalid value for "headline", the character length must be smaller than or equal to 255.'
+      end
+
+      @headline = headline
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if description.nil?
+        fail ArgumentError, 'description cannot be nil'
+      end
+
+      if description.to_s.length > 255
+        fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 255.'
+      end
+
+      @description = description
+    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 &&
+          image_url == o.image_url &&
+          link_url == o.link_url &&
+          headline == o.headline &&
+          description == o.description &&
+          call_to_action == o.call_to_action
+    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
+      [image_url, link_url, headline, description, call_to_action].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