class CyberSource::V2paymentsMerchantInformationMerchantDescriptor

Attributes

address1[RW]

For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)

administrative_area[RW]

Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)

alternate_name[RW]

For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)

contact[RW]

For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * FDCCompass (13) * Paymentech (13)

country[RW]

For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)

locality[RW]

Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)

name[RW]

For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) For Payouts: * Paymentech (22)

postal_code[RW]

For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)

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_merchant_information_merchant_descriptor.rb, line 42
def self.attribute_map
  {
    :'name' => :'name',
    :'alternate_name' => :'alternateName',
    :'contact' => :'contact',
    :'address1' => :'address1',
    :'locality' => :'locality',
    :'country' => :'country',
    :'postal_code' => :'postalCode',
    :'administrative_area' => :'administrativeArea'
  }
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_merchant_information_merchant_descriptor.rb, line 71
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?(:'name')
    self.name = attributes[:'name']
  end

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

  if attributes.has_key?(:'contact')
    self.contact = attributes[:'contact']
  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?(:'country')
    self.country = attributes[:'country']
  end

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

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

Attribute type mapping.

# File lib/cyberSource_client/models/v2payments_merchant_information_merchant_descriptor.rb, line 56
def self.swagger_types
  {
    :'name' => :'String',
    :'alternate_name' => :'String',
    :'contact' => :'String',
    :'address1' => :'String',
    :'locality' => :'String',
    :'country' => :'String',
    :'postal_code' => :'String',
    :'administrative_area' => :'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_merchant_information_merchant_descriptor.rb, line 245
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      alternate_name == o.alternate_name &&
      contact == o.contact &&
      address1 == o.address1 &&
      locality == o.locality &&
      country == o.country &&
      postal_code == o.postal_code &&
      administrative_area == o.administrative_area
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_merchant_information_merchant_descriptor.rb, line 294
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_merchant_information_merchant_descriptor.rb, line 360
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_merchant_information_merchant_descriptor.rb, line 195
def address1=(address1)
  if !address1.nil? && address1.to_s.length > 60
    fail ArgumentError, 'invalid value for "address1", the character length must be smaller than or equal to 60.'
  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_merchant_information_merchant_descriptor.rb, line 235
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
alternate_name=(alternate_name) click to toggle source

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

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

  @alternate_name = alternate_name
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_merchant_information_merchant_descriptor.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 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
contact=(contact) click to toggle source

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

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

  @contact = contact
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_merchant_information_merchant_descriptor.rb, line 215
def country=(country)
  if !country.nil? && country.to_s.length > 2
    fail ArgumentError, 'invalid value for "country", the character length must be smaller than or equal to 2.'
  end

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

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

# File lib/cyberSource_client/models/v2payments_merchant_information_merchant_descriptor.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/cyberSource_client/models/v2payments_merchant_information_merchant_descriptor.rb, line 266
def hash
  [name, alternate_name, contact, address1, locality, country, postal_code, administrative_area].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_merchant_information_merchant_descriptor.rb, line 112
def list_invalid_properties
  invalid_properties = Array.new
  if !@name.nil? && @name.to_s.length > 23
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 23.')
  end

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

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

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

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

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

  if !@postal_code.nil? && @postal_code.to_s.length > 14
    invalid_properties.push('invalid value for "postal_code", the character length must be smaller than or equal to 14.')
  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

  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_merchant_information_merchant_descriptor.rb, line 205
def locality=(locality)
  if !locality.nil? && locality.to_s.length > 13
    fail ArgumentError, 'invalid value for "locality", the character length must be smaller than or equal to 13.'
  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_merchant_information_merchant_descriptor.rb, line 165
def name=(name)
  if !name.nil? && name.to_s.length > 23
    fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 23.'
  end

  @name = name
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_merchant_information_merchant_descriptor.rb, line 225
def postal_code=(postal_code)
  if !postal_code.nil? && postal_code.to_s.length > 14
    fail ArgumentError, 'invalid value for "postal_code", the character length must be smaller than or equal to 14.'
  end

  @postal_code = postal_code
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_merchant_information_merchant_descriptor.rb, line 340
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_merchant_information_merchant_descriptor.rb, line 346
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_merchant_information_merchant_descriptor.rb, line 334
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_merchant_information_merchant_descriptor.rb, line 151
def valid?
  return false if !@name.nil? && @name.to_s.length > 23
  return false if !@alternate_name.nil? && @alternate_name.to_s.length > 13
  return false if !@contact.nil? && @contact.to_s.length > 14
  return false if !@address1.nil? && @address1.to_s.length > 60
  return false if !@locality.nil? && @locality.to_s.length > 13
  return false if !@country.nil? && @country.to_s.length > 2
  return false if !@postal_code.nil? && @postal_code.to_s.length > 14
  return false if !@administrative_area.nil? && @administrative_area.to_s.length > 3
  true
end