class ProtonApi::CustomerAnalysisRequest

Attributes

benchmark_end_date[RW]
benchmark_start_date[RW]
business_id[RW]
client_id[RW]
currency_code[RW]
currency_conversion[RW]
customer_ids[RW]
end_date[RW]
only_active_customers[RW]
response_limit[RW]
start_date[RW]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/proton_api/models/customer_analysis_request.rb, line 40
def self.attribute_map
  {
    :'currency_code' => :'currency_code',
    :'client_id' => :'client_id',
    :'response_limit' => :'response_limit',
    :'end_date' => :'end_date',
    :'benchmark_end_date' => :'benchmark_end_date',
    :'currency_conversion' => :'currency_conversion',
    :'start_date' => :'start_date',
    :'customer_ids' => :'customer_ids',
    :'business_id' => :'business_id',
    :'benchmark_start_date' => :'benchmark_start_date',
    :'only_active_customers' => :'only_active_customers'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/proton_api/models/customer_analysis_request.rb, line 75
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'currency_code')
    self.currency_code = attributes[:'currency_code']
  end

  if attributes.has_key?(:'client_id')
    self.client_id = attributes[:'client_id']
  end

  if attributes.has_key?(:'response_limit')
    self.response_limit = attributes[:'response_limit']
  else
    self.response_limit = 10
  end

  if attributes.has_key?(:'end_date')
    self.end_date = attributes[:'end_date']
  end

  if attributes.has_key?(:'benchmark_end_date')
    self.benchmark_end_date = attributes[:'benchmark_end_date']
  end

  if attributes.has_key?(:'currency_conversion')
    self.currency_conversion = attributes[:'currency_conversion']
  end

  if attributes.has_key?(:'start_date')
    self.start_date = attributes[:'start_date']
  end

  if attributes.has_key?(:'customer_ids')
    if (value = attributes[:'customer_ids']).is_a?(Array)
      self.customer_ids = value
    end
  end

  if attributes.has_key?(:'business_id')
    self.business_id = attributes[:'business_id']
  end

  if attributes.has_key?(:'benchmark_start_date')
    self.benchmark_start_date = attributes[:'benchmark_start_date']
  end

  if attributes.has_key?(:'only_active_customers')
    self.only_active_customers = attributes[:'only_active_customers']
  else
    self.only_active_customers = false
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/proton_api/models/customer_analysis_request.rb, line 57
def self.swagger_types
  {
    :'currency_code' => :'String',
    :'client_id' => :'String',
    :'response_limit' => :'Integer',
    :'end_date' => :'Date',
    :'benchmark_end_date' => :'Date',
    :'currency_conversion' => :'String',
    :'start_date' => :'Date',
    :'customer_ids' => :'Array<String>',
    :'business_id' => :'String',
    :'benchmark_start_date' => :'Date',
    :'only_active_customers' => :'BOOLEAN'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/proton_api/models/customer_analysis_request.rb, line 162
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      currency_code == o.currency_code &&
      client_id == o.client_id &&
      response_limit == o.response_limit &&
      end_date == o.end_date &&
      benchmark_end_date == o.benchmark_end_date &&
      currency_conversion == o.currency_conversion &&
      start_date == o.start_date &&
      customer_ids == o.customer_ids &&
      business_id == o.business_id &&
      benchmark_start_date == o.benchmark_start_date &&
      only_active_customers == o.only_active_customers
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/proton_api/models/customer_analysis_request.rb, line 213
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    value
  when :Date
    value
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = ProtonApi.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/proton_api/models/customer_analysis_request.rb, line 277
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/proton_api/models/customer_analysis_request.rb, line 193
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/proton_api/models/customer_analysis_request.rb, line 180
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/proton_api/models/customer_analysis_request.rb, line 186
def hash
  [currency_code, client_id, response_limit, end_date, benchmark_end_date, currency_conversion, start_date, customer_ids, business_id, benchmark_start_date, only_active_customers].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/proton_api/models/customer_analysis_request.rb, line 134
def list_invalid_properties
  invalid_properties = Array.new
  if !@response_limit.nil? && @response_limit < 1
    invalid_properties.push('invalid value for "response_limit", must be greater than or equal to 1.')
  end

  invalid_properties
end
response_limit=(response_limit) click to toggle source

Custom attribute writer method with validation @param [Object] response_limit Value to be assigned

# File lib/proton_api/models/customer_analysis_request.rb, line 152
def response_limit=(response_limit)
  if !response_limit.nil? && response_limit < 1
    fail ArgumentError, 'invalid value for "response_limit", must be greater than or equal to 1.'
  end

  @response_limit = response_limit
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/proton_api/models/customer_analysis_request.rb, line 258
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/proton_api/models/customer_analysis_request.rb, line 264
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/proton_api/models/customer_analysis_request.rb, line 252
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/proton_api/models/customer_analysis_request.rb, line 145
def valid?
  return false if !@response_limit.nil? && @response_limit < 1
  true
end