class CyberSource::V2paymentsAggregatorInformationSubMerchant

Attributes

address1[RW]

First line of the sub-merchant’s street address.

administrative_area[RW]

Sub-merchant’s state or province. Use the State, Province, and Territory Codes for the United States and Canada.

card_acceptor_id[RW]

Unique identifier assigned by the payment card company to the sub-merchant.

country[RW]

Sub-merchant’s country. Use the two-character ISO Standard Country Codes.

email[RW]

Sub-merchant’s email address. **Maximum length for processors** - American Express Direct: 40 - CyberSource through VisaNet: 40 - FDC Compass: 40 - FDC Nashville Global: 19

locality[RW]

Sub-merchant’s city.

name[RW]

Sub-merchant’s business name.

phone_number[RW]

Sub-merchant’s telephone number. **Maximum length for procesors** - American Express Direct: 20 - CyberSource through VisaNet: 20 - FDC Compass: 13 - FDC Nashville Global: 10

postal_code[RW]

Partial postal code for the sub-merchant’s address.

region[RW]

Sub-merchant’s region. Example `NE` indicates that the sub-merchant is in the northeast region.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/cyberSource_client/models/v2payments_aggregator_information_sub_merchant.rb, line 48
def self.attribute_map
  {
    :'card_acceptor_id' => :'cardAcceptorId',
    :'name' => :'name',
    :'address1' => :'address1',
    :'locality' => :'locality',
    :'administrative_area' => :'administrativeArea',
    :'region' => :'region',
    :'postal_code' => :'postalCode',
    :'country' => :'country',
    :'email' => :'email',
    :'phone_number' => :'phoneNumber'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/cyberSource_client/models/v2payments_aggregator_information_sub_merchant.rb, line 81
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?(:'cardAcceptorId')
    self.card_acceptor_id = attributes[:'cardAcceptorId']
  end

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'phoneNumber')
    self.phone_number = attributes[:'phoneNumber']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/cyberSource_client/models/v2payments_aggregator_information_sub_merchant.rb, line 64
def self.swagger_types
  {
    :'card_acceptor_id' => :'String',
    :'name' => :'String',
    :'address1' => :'String',
    :'locality' => :'String',
    :'administrative_area' => :'String',
    :'region' => :'String',
    :'postal_code' => :'String',
    :'country' => :'String',
    :'email' => :'String',
    :'phone_number' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/cyberSource_client/models/v2payments_aggregator_information_sub_merchant.rb, line 293
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      card_acceptor_id == o.card_acceptor_id &&
      name == o.name &&
      address1 == o.address1 &&
      locality == o.locality &&
      administrative_area == o.administrative_area &&
      region == o.region &&
      postal_code == o.postal_code &&
      country == o.country &&
      email == o.email &&
      phone_number == o.phone_number
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/cyberSource_client/models/v2payments_aggregator_information_sub_merchant.rb, line 344
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
    temp_model = CyberSource.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/cyberSource_client/models/v2payments_aggregator_information_sub_merchant.rb, line 410
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
address1=(address1) click to toggle source

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

# File lib/cyberSource_client/models/v2payments_aggregator_information_sub_merchant.rb, line 213
def address1=(address1)
  if !address1.nil? && address1.to_s.length > 38
    fail ArgumentError, 'invalid value for "address1", the character length must be smaller than or equal to 38.'
  end

  @address1 = address1
end
administrative_area=(administrative_area) click to toggle source

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

# File lib/cyberSource_client/models/v2payments_aggregator_information_sub_merchant.rb, line 233
def administrative_area=(administrative_area)
  if !administrative_area.nil? && administrative_area.to_s.length > 3
    fail ArgumentError, 'invalid value for "administrative_area", the character length must be smaller than or equal to 3.'
  end

  @administrative_area = administrative_area
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/cyberSource_client/models/v2payments_aggregator_information_sub_merchant.rb, line 323
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 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
card_acceptor_id=(card_acceptor_id) click to toggle source

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

# File lib/cyberSource_client/models/v2payments_aggregator_information_sub_merchant.rb, line 193
def card_acceptor_id=(card_acceptor_id)
  if !card_acceptor_id.nil? && card_acceptor_id.to_s.length > 15
    fail ArgumentError, 'invalid value for "card_acceptor_id", the character length must be smaller than or equal to 15.'
  end

  @card_acceptor_id = card_acceptor_id
end
country=(country) click to toggle source

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

# File lib/cyberSource_client/models/v2payments_aggregator_information_sub_merchant.rb, line 263
def country=(country)
  if !country.nil? && country.to_s.length > 3
    fail ArgumentError, 'invalid value for "country", the character length must be smaller than or equal to 3.'
  end

  @country = country
end
email=(email) click to toggle source

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

# File lib/cyberSource_client/models/v2payments_aggregator_information_sub_merchant.rb, line 273
def email=(email)
  if !email.nil? && email.to_s.length > 40
    fail ArgumentError, 'invalid value for "email", the character length must be smaller than or equal to 40.'
  end

  @email = email
end
eql?(o) click to toggle source

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

# File lib/cyberSource_client/models/v2payments_aggregator_information_sub_merchant.rb, line 310
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/cyberSource_client/models/v2payments_aggregator_information_sub_merchant.rb, line 316
def hash
  [card_acceptor_id, name, address1, locality, administrative_area, region, postal_code, country, email, phone_number].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/cyberSource_client/models/v2payments_aggregator_information_sub_merchant.rb, line 130
def list_invalid_properties
  invalid_properties = Array.new
  if !@card_acceptor_id.nil? && @card_acceptor_id.to_s.length > 15
    invalid_properties.push('invalid value for "card_acceptor_id", the character length must be smaller than or equal to 15.')
  end

  if !@name.nil? && @name.to_s.length > 37
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 37.')
  end

  if !@address1.nil? && @address1.to_s.length > 38
    invalid_properties.push('invalid value for "address1", the character length must be smaller than or equal to 38.')
  end

  if !@locality.nil? && @locality.to_s.length > 21
    invalid_properties.push('invalid value for "locality", the character length must be smaller than or equal to 21.')
  end

  if !@administrative_area.nil? && @administrative_area.to_s.length > 3
    invalid_properties.push('invalid value for "administrative_area", the character length must be smaller than or equal to 3.')
  end

  if !@region.nil? && @region.to_s.length > 3
    invalid_properties.push('invalid value for "region", the character length must be smaller than or equal to 3.')
  end

  if !@postal_code.nil? && @postal_code.to_s.length > 15
    invalid_properties.push('invalid value for "postal_code", the character length must be smaller than or equal to 15.')
  end

  if !@country.nil? && @country.to_s.length > 3
    invalid_properties.push('invalid value for "country", the character length must be smaller than or equal to 3.')
  end

  if !@email.nil? && @email.to_s.length > 40
    invalid_properties.push('invalid value for "email", the character length must be smaller than or equal to 40.')
  end

  if !@phone_number.nil? && @phone_number.to_s.length > 20
    invalid_properties.push('invalid value for "phone_number", the character length must be smaller than or equal to 20.')
  end

  invalid_properties
end
locality=(locality) click to toggle source

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

# File lib/cyberSource_client/models/v2payments_aggregator_information_sub_merchant.rb, line 223
def locality=(locality)
  if !locality.nil? && locality.to_s.length > 21
    fail ArgumentError, 'invalid value for "locality", the character length must be smaller than or equal to 21.'
  end

  @locality = locality
end
name=(name) click to toggle source

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

# File lib/cyberSource_client/models/v2payments_aggregator_information_sub_merchant.rb, line 203
def name=(name)
  if !name.nil? && name.to_s.length > 37
    fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 37.'
  end

  @name = name
end
phone_number=(phone_number) click to toggle source

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

# File lib/cyberSource_client/models/v2payments_aggregator_information_sub_merchant.rb, line 283
def phone_number=(phone_number)
  if !phone_number.nil? && phone_number.to_s.length > 20
    fail ArgumentError, 'invalid value for "phone_number", the character length must be smaller than or equal to 20.'
  end

  @phone_number = phone_number
end
postal_code=(postal_code) click to toggle source

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

# File lib/cyberSource_client/models/v2payments_aggregator_information_sub_merchant.rb, line 253
def postal_code=(postal_code)
  if !postal_code.nil? && postal_code.to_s.length > 15
    fail ArgumentError, 'invalid value for "postal_code", the character length must be smaller than or equal to 15.'
  end

  @postal_code = postal_code
end
region=(region) click to toggle source

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

# File lib/cyberSource_client/models/v2payments_aggregator_information_sub_merchant.rb, line 243
def region=(region)
  if !region.nil? && region.to_s.length > 3
    fail ArgumentError, 'invalid value for "region", the character length must be smaller than or equal to 3.'
  end

  @region = region
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/cyberSource_client/models/v2payments_aggregator_information_sub_merchant.rb, line 390
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/cyberSource_client/models/v2payments_aggregator_information_sub_merchant.rb, line 396
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/cyberSource_client/models/v2payments_aggregator_information_sub_merchant.rb, line 384
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/cyberSource_client/models/v2payments_aggregator_information_sub_merchant.rb, line 177
def valid?
  return false if !@card_acceptor_id.nil? && @card_acceptor_id.to_s.length > 15
  return false if !@name.nil? && @name.to_s.length > 37
  return false if !@address1.nil? && @address1.to_s.length > 38
  return false if !@locality.nil? && @locality.to_s.length > 21
  return false if !@administrative_area.nil? && @administrative_area.to_s.length > 3
  return false if !@region.nil? && @region.to_s.length > 3
  return false if !@postal_code.nil? && @postal_code.to_s.length > 15
  return false if !@country.nil? && @country.to_s.length > 3
  return false if !@email.nil? && @email.to_s.length > 40
  return false if !@phone_number.nil? && @phone_number.to_s.length > 20
  true
end