class OpenapiClient::Merchant

The merchant where this transaction occurred.

Attributes

location[RW]
mcc[RW]

The 4-digit Merchant Category Code. The merchant might be associated with multiple MCCs. In that case the MCC provided here will be the one that better describes the current transaction.

merchant_unique_id[RW]

The unique ID of this merchant. Must be unique for the entire system (not just within a specific industry).

user_defined[RW]

A JSON object that can carry any additional information about the merchant that might be helpful for fraud detection.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/openapi_client/models/merchant.rb, line 30
def self.attribute_map
  {
    :'mcc' => :'mcc',
    :'merchant_unique_id' => :'merchantUniqueId',
    :'location' => :'location',
    :'user_defined' => :'userDefined'
  }
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/openapi_client/models/merchant.rb, line 146
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

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

# File lib/openapi_client/models/merchant.rb, line 51
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Merchant` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::Merchant`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'mcc')
    self.mcc = attributes[:'mcc']
  end

  if attributes.key?(:'merchant_unique_id')
    self.merchant_unique_id = attributes[:'merchant_unique_id']
  end

  if attributes.key?(:'location')
    self.location = attributes[:'location']
  end

  if attributes.key?(:'user_defined')
    self.user_defined = attributes[:'user_defined']
  end
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/openapi_client/models/merchant.rb, line 40
def self.openapi_types
  {
    :'mcc' => :'String',
    :'merchant_unique_id' => :'String',
    :'location' => :'Location',
    :'user_defined' => :'Object'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/openapi_client/models/merchant.rb, line 122
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      mcc == o.mcc &&
      merchant_unique_id == o.merchant_unique_id &&
      location == o.location &&
      user_defined == o.user_defined
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/openapi_client/models/merchant.rb, line 174
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(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
    klass = OpenapiClient.const_get(type)
    if klass.respond_to?(:openapi_discriminator_name)
      klass = OpenapiClient.const_get(value[klass.attribute_map[klass.openapi_discriminator_name]])
    end
 
    klass.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/openapi_client/models/merchant.rb, line 248
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, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) 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/openapi_client/models/merchant.rb, line 153
def build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types)
  return nil unless attributes.is_a?(Hash)
  openapi_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[attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[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/openapi_client/models/merchant.rb, line 133
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/openapi_client/models/merchant.rb, line 139
def hash
  [mcc, merchant_unique_id, location, user_defined].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/openapi_client/models/merchant.rb, line 83
def list_invalid_properties
  invalid_properties = Array.new
  if @merchant_unique_id.nil?
    invalid_properties.push('invalid value for "merchant_unique_id", merchant_unique_id cannot be nil.')
  end

  pattern = Regexp.new(/^(?!\s*$).+/)
  if @merchant_unique_id !~ pattern
    invalid_properties.push("invalid value for \"merchant_unique_id\", must conform to the pattern #{pattern}.")
  end

  invalid_properties
end
merchant_unique_id=(merchant_unique_id) click to toggle source

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

# File lib/openapi_client/models/merchant.rb, line 107
def merchant_unique_id=(merchant_unique_id)
  if merchant_unique_id.nil?
    fail ArgumentError, 'merchant_unique_id cannot be nil'
  end

  pattern = Regexp.new(/^(?!\s*$).+/)
  if merchant_unique_id !~ pattern
    fail ArgumentError, "invalid value for \"merchant_unique_id\", must conform to the pattern #{pattern}."
  end

  @merchant_unique_id = merchant_unique_id
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/openapi_client/models/merchant.rb, line 224
def to_body
  to_hash
end
to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) click to toggle source

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

# File lib/openapi_client/models/merchant.rb, line 230
def to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([]))
  hash = {}
  attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    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/openapi_client/models/merchant.rb, line 218
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/openapi_client/models/merchant.rb, line 99
def valid?
  return false if @merchant_unique_id.nil?
  return false if @merchant_unique_id !~ Regexp.new(/^(?!\s*$).+/)
  true
end