class ProtonApi::CardAnalysisRequest

Attributes

business_id[RW]
card_program_id[RW]
card_status_scope[RW]
client_id[RW]
currency_code[RW]
currency_conversion[RW]
end_date[RW]
history_frequency_interval[RW]
response_limit[RW]
show_history[RW]
show_top_businesses[RW]
show_top_cardholders[RW]
show_top_cards[RW]
start_date[RW]
transaction_status_scope[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/card_analysis_request.rb, line 70
def self.attribute_map
  {
    :'currency_code' => :'currency_code',
    :'client_id' => :'client_id',
    :'show_history' => :'show_history',
    :'response_limit' => :'response_limit',
    :'currency_conversion' => :'currency_conversion',
    :'end_date' => :'end_date',
    :'history_frequency_interval' => :'history_frequency_interval',
    :'show_top_cards' => :'show_top_cards',
    :'start_date' => :'start_date',
    :'business_id' => :'business_id',
    :'transaction_status_scope' => :'transaction_status_scope',
    :'card_status_scope' => :'card_status_scope',
    :'show_top_cardholders' => :'show_top_cardholders',
    :'card_program_id' => :'card_program_id',
    :'show_top_businesses' => :'show_top_businesses'
  }
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/card_analysis_request.rb, line 113
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?(:'show_history')
    self.show_history = attributes[:'show_history']
  else
    self.show_history = false
  end

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

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

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

  if attributes.has_key?(:'history_frequency_interval')
    self.history_frequency_interval = attributes[:'history_frequency_interval']
  else
    self.history_frequency_interval = 'month'
  end

  if attributes.has_key?(:'show_top_cards')
    self.show_top_cards = attributes[:'show_top_cards']
  else
    self.show_top_cards = false
  end

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

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

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

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

  if attributes.has_key?(:'show_top_cardholders')
    self.show_top_cardholders = attributes[:'show_top_cardholders']
  else
    self.show_top_cardholders = false
  end

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

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

Attribute type mapping.

# File lib/proton_api/models/card_analysis_request.rb, line 91
def self.swagger_types
  {
    :'currency_code' => :'String',
    :'client_id' => :'String',
    :'show_history' => :'BOOLEAN',
    :'response_limit' => :'Integer',
    :'currency_conversion' => :'String',
    :'end_date' => :'Date',
    :'history_frequency_interval' => :'String',
    :'show_top_cards' => :'BOOLEAN',
    :'start_date' => :'Date',
    :'business_id' => :'String',
    :'transaction_status_scope' => :'Array<String>',
    :'card_status_scope' => :'Array<String>',
    :'show_top_cardholders' => :'BOOLEAN',
    :'card_program_id' => :'String',
    :'show_top_businesses' => :'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/card_analysis_request.rb, line 238
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      currency_code == o.currency_code &&
      client_id == o.client_id &&
      show_history == o.show_history &&
      response_limit == o.response_limit &&
      currency_conversion == o.currency_conversion &&
      end_date == o.end_date &&
      history_frequency_interval == o.history_frequency_interval &&
      show_top_cards == o.show_top_cards &&
      start_date == o.start_date &&
      business_id == o.business_id &&
      transaction_status_scope == o.transaction_status_scope &&
      card_status_scope == o.card_status_scope &&
      show_top_cardholders == o.show_top_cardholders &&
      card_program_id == o.card_program_id &&
      show_top_businesses == o.show_top_businesses
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/card_analysis_request.rb, line 293
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/card_analysis_request.rb, line 357
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/card_analysis_request.rb, line 273
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/card_analysis_request.rb, line 260
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/card_analysis_request.rb, line 266
def hash
  [currency_code, client_id, show_history, response_limit, currency_conversion, end_date, history_frequency_interval, show_top_cards, start_date, business_id, transaction_status_scope, card_status_scope, show_top_cardholders, card_program_id, show_top_businesses].hash
end
history_frequency_interval=(history_frequency_interval) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] history_frequency_interval Object to be assigned

# File lib/proton_api/models/card_analysis_request.rb, line 228
def history_frequency_interval=(history_frequency_interval)
  validator = EnumAttributeValidator.new('String', ['day', 'week', 'month', 'quarter', 'year'])
  unless validator.valid?(history_frequency_interval)
    fail ArgumentError, 'invalid value for "history_frequency_interval", must be one of #{validator.allowable_values}.'
  end
  @history_frequency_interval = history_frequency_interval
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/card_analysis_request.rb, line 198
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/card_analysis_request.rb, line 218
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/card_analysis_request.rb, line 338
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/card_analysis_request.rb, line 344
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/card_analysis_request.rb, line 332
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/card_analysis_request.rb, line 209
def valid?
  return false if !@response_limit.nil? && @response_limit < 1
  history_frequency_interval_validator = EnumAttributeValidator.new('String', ['day', 'week', 'month', 'quarter', 'year'])
  return false unless history_frequency_interval_validator.valid?(@history_frequency_interval)
  true
end