late-sdk 0.0.97 → 0.0.99

data/lib/late-sdk/models/create_standalone_ad_request.rb

@@ -0,0 +1,585 @@
+=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.1
+Contact: support@zernio.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Late
+  class CreateStandaloneAdRequest < ApiModelBase
+    attr_accessor :account_id
+
+    attr_accessor :ad_account_id
+
+    attr_accessor :name
+
+    attr_accessor :goal
+
+    attr_accessor :budget_amount
+
+    attr_accessor :budget_type
+
+    attr_accessor :currency
+
+    # Required for most platforms. Max: Meta=255, Google=30, Pinterest=100
+    attr_accessor :headline
+
+    # Max: Google=90, Pinterest=500
+    attr_accessor :body
+
+    # Meta only
+    attr_accessor :call_to_action
+
+    attr_accessor :link_url
+
+    # Image URL (or video URL for TikTok)
+    attr_accessor :image_url
+
+    attr_accessor :countries
+
+    attr_accessor :age_min
+
+    attr_accessor :age_max
+
+    attr_accessor :interests
+
+    # Required for lifetime budgets
+    attr_accessor :end_date
+
+    # Custom audience ID for targeting
+    attr_accessor :audience_id
+
+    # Google only
+    attr_accessor :campaign_type
+
+    # Google Search only
+    attr_accessor :keywords
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'account_id' => :'accountId',
+        :'ad_account_id' => :'adAccountId',
+        :'name' => :'name',
+        :'goal' => :'goal',
+        :'budget_amount' => :'budgetAmount',
+        :'budget_type' => :'budgetType',
+        :'currency' => :'currency',
+        :'headline' => :'headline',
+        :'body' => :'body',
+        :'call_to_action' => :'callToAction',
+        :'link_url' => :'linkUrl',
+        :'image_url' => :'imageUrl',
+        :'countries' => :'countries',
+        :'age_min' => :'ageMin',
+        :'age_max' => :'ageMax',
+        :'interests' => :'interests',
+        :'end_date' => :'endDate',
+        :'audience_id' => :'audienceId',
+        :'campaign_type' => :'campaignType',
+        :'keywords' => :'keywords'
+      }
+    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',
+        :'name' => :'String',
+        :'goal' => :'String',
+        :'budget_amount' => :'Float',
+        :'budget_type' => :'String',
+        :'currency' => :'String',
+        :'headline' => :'String',
+        :'body' => :'String',
+        :'call_to_action' => :'String',
+        :'link_url' => :'String',
+        :'image_url' => :'String',
+        :'countries' => :'Array<String>',
+        :'age_min' => :'Integer',
+        :'age_max' => :'Integer',
+        :'interests' => :'Array<String>',
+        :'end_date' => :'Time',
+        :'audience_id' => :'String',
+        :'campaign_type' => :'String',
+        :'keywords' => :'Array<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 `Late::CreateStandaloneAdRequest` 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 `Late::CreateStandaloneAdRequest`. 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?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'goal')
+        self.goal = attributes[:'goal']
+      else
+        self.goal = nil
+      end
+
+      if attributes.key?(:'budget_amount')
+        self.budget_amount = attributes[:'budget_amount']
+      else
+        self.budget_amount = nil
+      end
+
+      if attributes.key?(:'budget_type')
+        self.budget_type = attributes[:'budget_type']
+      else
+        self.budget_type = nil
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
+
+      if attributes.key?(:'headline')
+        self.headline = attributes[:'headline']
+      end
+
+      if attributes.key?(:'body')
+        self.body = attributes[:'body']
+      else
+        self.body = nil
+      end
+
+      if attributes.key?(:'call_to_action')
+        self.call_to_action = attributes[:'call_to_action']
+      end
+
+      if attributes.key?(:'link_url')
+        self.link_url = attributes[:'link_url']
+      end
+
+      if attributes.key?(:'image_url')
+        self.image_url = attributes[:'image_url']
+      else
+        self.image_url = nil
+      end
+
+      if attributes.key?(:'countries')
+        if (value = attributes[:'countries']).is_a?(Array)
+          self.countries = value
+        end
+      end
+
+      if attributes.key?(:'age_min')
+        self.age_min = attributes[:'age_min']
+      end
+
+      if attributes.key?(:'age_max')
+        self.age_max = attributes[:'age_max']
+      end
+
+      if attributes.key?(:'interests')
+        if (value = attributes[:'interests']).is_a?(Array)
+          self.interests = value
+        end
+      end
+
+      if attributes.key?(:'end_date')
+        self.end_date = attributes[:'end_date']
+      end
+
+      if attributes.key?(:'audience_id')
+        self.audience_id = attributes[:'audience_id']
+      end
+
+      if attributes.key?(:'campaign_type')
+        self.campaign_type = attributes[:'campaign_type']
+      else
+        self.campaign_type = 'display'
+      end
+
+      if attributes.key?(:'keywords')
+        if (value = attributes[:'keywords']).is_a?(Array)
+          self.keywords = 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
+      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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length > 255
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
+      end
+
+      if @goal.nil?
+        invalid_properties.push('invalid value for "goal", goal cannot be nil.')
+      end
+
+      if @budget_amount.nil?
+        invalid_properties.push('invalid value for "budget_amount", budget_amount cannot be nil.')
+      end
+
+      if @budget_type.nil?
+        invalid_properties.push('invalid value for "budget_type", budget_type cannot be nil.')
+      end
+
+      if @body.nil?
+        invalid_properties.push('invalid value for "body", body cannot be nil.')
+      end
+
+      if @image_url.nil?
+        invalid_properties.push('invalid value for "image_url", image_url cannot be nil.')
+      end
+
+      if !@age_min.nil? && @age_min > 65
+        invalid_properties.push('invalid value for "age_min", must be smaller than or equal to 65.')
+      end
+
+      if !@age_min.nil? && @age_min < 13
+        invalid_properties.push('invalid value for "age_min", must be greater than or equal to 13.')
+      end
+
+      if !@age_max.nil? && @age_max > 65
+        invalid_properties.push('invalid value for "age_max", must be smaller than or equal to 65.')
+      end
+
+      if !@age_max.nil? && @age_max < 13
+        invalid_properties.push('invalid value for "age_max", must be greater than or equal to 13.')
+      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 @name.nil?
+      return false if @name.to_s.length > 255
+      return false if @goal.nil?
+      goal_validator = EnumAttributeValidator.new('String', ["engagement", "traffic", "awareness", "video_views"])
+      return false unless goal_validator.valid?(@goal)
+      return false if @budget_amount.nil?
+      return false if @budget_type.nil?
+      budget_type_validator = EnumAttributeValidator.new('String', ["daily", "lifetime"])
+      return false unless budget_type_validator.valid?(@budget_type)
+      return false if @body.nil?
+      call_to_action_validator = EnumAttributeValidator.new('String', ["LEARN_MORE", "SHOP_NOW", "SIGN_UP", "BOOK_TRAVEL", "CONTACT_US", "DOWNLOAD", "GET_OFFER", "GET_QUOTE", "SUBSCRIBE", "WATCH_MORE"])
+      return false unless call_to_action_validator.valid?(@call_to_action)
+      return false if @image_url.nil?
+      return false if !@age_min.nil? && @age_min > 65
+      return false if !@age_min.nil? && @age_min < 13
+      return false if !@age_max.nil? && @age_max > 65
+      return false if !@age_max.nil? && @age_max < 13
+      campaign_type_validator = EnumAttributeValidator.new('String', ["display", "search"])
+      return false unless campaign_type_validator.valid?(@campaign_type)
+      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] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length > 255
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 255.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] goal Object to be assigned
+    def goal=(goal)
+      validator = EnumAttributeValidator.new('String', ["engagement", "traffic", "awareness", "video_views"])
+      unless validator.valid?(goal)
+        fail ArgumentError, "invalid value for \"goal\", must be one of #{validator.allowable_values}."
+      end
+      @goal = goal
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] budget_amount Value to be assigned
+    def budget_amount=(budget_amount)
+      if budget_amount.nil?
+        fail ArgumentError, 'budget_amount cannot be nil'
+      end
+
+      @budget_amount = budget_amount
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] budget_type Object to be assigned
+    def budget_type=(budget_type)
+      validator = EnumAttributeValidator.new('String', ["daily", "lifetime"])
+      unless validator.valid?(budget_type)
+        fail ArgumentError, "invalid value for \"budget_type\", must be one of #{validator.allowable_values}."
+      end
+      @budget_type = budget_type
+    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 checking allowed values (enum).
+    # @param [Object] call_to_action Object to be assigned
+    def call_to_action=(call_to_action)
+      validator = EnumAttributeValidator.new('String', ["LEARN_MORE", "SHOP_NOW", "SIGN_UP", "BOOK_TRAVEL", "CONTACT_US", "DOWNLOAD", "GET_OFFER", "GET_QUOTE", "SUBSCRIBE", "WATCH_MORE"])
+      unless validator.valid?(call_to_action)
+        fail ArgumentError, "invalid value for \"call_to_action\", must be one of #{validator.allowable_values}."
+      end
+      @call_to_action = call_to_action
+    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] age_min Value to be assigned
+    def age_min=(age_min)
+      if age_min.nil?
+        fail ArgumentError, 'age_min cannot be nil'
+      end
+
+      if age_min > 65
+        fail ArgumentError, 'invalid value for "age_min", must be smaller than or equal to 65.'
+      end
+
+      if age_min < 13
+        fail ArgumentError, 'invalid value for "age_min", must be greater than or equal to 13.'
+      end
+
+      @age_min = age_min
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] age_max Value to be assigned
+    def age_max=(age_max)
+      if age_max.nil?
+        fail ArgumentError, 'age_max cannot be nil'
+      end
+
+      if age_max > 65
+        fail ArgumentError, 'invalid value for "age_max", must be smaller than or equal to 65.'
+      end
+
+      if age_max < 13
+        fail ArgumentError, 'invalid value for "age_max", must be greater than or equal to 13.'
+      end
+
+      @age_max = age_max
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] campaign_type Object to be assigned
+    def campaign_type=(campaign_type)
+      validator = EnumAttributeValidator.new('String', ["display", "search"])
+      unless validator.valid?(campaign_type)
+        fail ArgumentError, "invalid value for \"campaign_type\", must be one of #{validator.allowable_values}."
+      end
+      @campaign_type = campaign_type
+    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 &&
+          name == o.name &&
+          goal == o.goal &&
+          budget_amount == o.budget_amount &&
+          budget_type == o.budget_type &&
+          currency == o.currency &&
+          headline == o.headline &&
+          body == o.body &&
+          call_to_action == o.call_to_action &&
+          link_url == o.link_url &&
+          image_url == o.image_url &&
+          countries == o.countries &&
+          age_min == o.age_min &&
+          age_max == o.age_max &&
+          interests == o.interests &&
+          end_date == o.end_date &&
+          audience_id == o.audience_id &&
+          campaign_type == o.campaign_type &&
+          keywords == o.keywords
+    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, name, goal, budget_amount, budget_type, currency, headline, body, call_to_action, link_url, image_url, countries, age_min, age_max, interests, end_date, audience_id, campaign_type, keywords].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