class VeloPayments::Payee2

Attributes

accept_terms_and_conditions_timestamp[RW]

The timestamp when the payee last accepted T&Cs

address[RW]
cellphone_number[RW]
challenge[RW]
company[RW]
country[RW]
created[RW]
display_name[RW]
email[RW]
grace_period_end_date[RW]
individual[RW]
language[RW]
marketing_opt_ins[RW]
onboarded_status[RW]
payee_id[RW]
payee_type[RW]
payment_channel[RW]
payor_refs[RW]
remote_id[RW]

Remote Id must be between 1 and 100 characters long

type[RW]
watchlist_status_updated_timestamp[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/velopayments/models/payee2.rb, line 84
def self.attribute_map
  {
    :'type' => :'type',
    :'payee_id' => :'payeeId',
    :'payor_refs' => :'payorRefs',
    :'email' => :'email',
    :'address' => :'address',
    :'country' => :'country',
    :'display_name' => :'displayName',
    :'payment_channel' => :'paymentChannel',
    :'challenge' => :'challenge',
    :'language' => :'language',
    :'accept_terms_and_conditions_timestamp' => :'acceptTermsAndConditionsTimestamp',
    :'cellphone_number' => :'cellphoneNumber',
    :'payee_type' => :'payeeType',
    :'company' => :'company',
    :'individual' => :'individual',
    :'created' => :'created',
    :'grace_period_end_date' => :'gracePeriodEndDate',
    :'watchlist_status_updated_timestamp' => :'watchlistStatusUpdatedTimestamp',
    :'marketing_opt_ins' => :'marketingOptIns',
    :'onboarded_status' => :'onboardedStatus',
    :'remote_id' => :'remoteId'
  }
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/velopayments/models/payee2.rb, line 345
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/velopayments/models/payee2.rb, line 151
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::Payee2` 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 `VeloPayments::Payee2`. 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?(:'type')
    self.type = attributes[:'type']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

List of attributes with nullable: true

# File lib/velopayments/models/payee2.rb, line 138
def self.openapi_nullable
  Set.new([
    :'payor_refs',
    :'email',
    :'accept_terms_and_conditions_timestamp',
    :'company',
    :'grace_period_end_date',
    :'watchlist_status_updated_timestamp',
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/velopayments/models/payee2.rb, line 111
def self.openapi_types
  {
    :'type' => :'String',
    :'payee_id' => :'String',
    :'payor_refs' => :'Array<PayeePayorRefV2>',
    :'email' => :'String',
    :'address' => :'PayeeAddress',
    :'country' => :'String',
    :'display_name' => :'String',
    :'payment_channel' => :'PayeePaymentChannel2',
    :'challenge' => :'Challenge',
    :'language' => :'Language2',
    :'accept_terms_and_conditions_timestamp' => :'DateTime',
    :'cellphone_number' => :'String',
    :'payee_type' => :'PayeeType',
    :'company' => :'CompanyV1',
    :'individual' => :'IndividualV1',
    :'created' => :'DateTime',
    :'grace_period_end_date' => :'Date',
    :'watchlist_status_updated_timestamp' => :'String',
    :'marketing_opt_ins' => :'Array<MarketingOptIn>',
    :'onboarded_status' => :'OnboardedStatus',
    :'remote_id' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/velopayments/models/payee2.rb, line 304
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      payee_id == o.payee_id &&
      payor_refs == o.payor_refs &&
      email == o.email &&
      address == o.address &&
      country == o.country &&
      display_name == o.display_name &&
      payment_channel == o.payment_channel &&
      challenge == o.challenge &&
      language == o.language &&
      accept_terms_and_conditions_timestamp == o.accept_terms_and_conditions_timestamp &&
      cellphone_number == o.cellphone_number &&
      payee_type == o.payee_type &&
      company == o.company &&
      individual == o.individual &&
      created == o.created &&
      grace_period_end_date == o.grace_period_end_date &&
      watchlist_status_updated_timestamp == o.watchlist_status_updated_timestamp &&
      marketing_opt_ins == o.marketing_opt_ins &&
      onboarded_status == o.onboarded_status &&
      remote_id == o.remote_id
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/velopayments/models/payee2.rb, line 373
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
    VeloPayments.const_get(type).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/velopayments/models/payee2.rb, line 442
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/velopayments/models/payee2.rb, line 352
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.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[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/velopayments/models/payee2.rb, line 332
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/velopayments/models/payee2.rb, line 338
def hash
  [type, payee_id, payor_refs, email, address, country, display_name, payment_channel, challenge, language, accept_terms_and_conditions_timestamp, cellphone_number, payee_type, company, individual, created, grace_period_end_date, watchlist_status_updated_timestamp, marketing_opt_ins, onboarded_status, remote_id].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/velopayments/models/payee2.rb, line 255
def list_invalid_properties
  invalid_properties = Array.new
  if !@remote_id.nil? && @remote_id.to_s.length > 100
    invalid_properties.push('invalid value for "remote_id", the character length must be smaller than or equal to 100.')
  end

  if !@remote_id.nil? && @remote_id.to_s.length < 1
    invalid_properties.push('invalid value for "remote_id", the character length must be great than or equal to 1.')
  end

  invalid_properties
end
remote_id=(remote_id) click to toggle source

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

# File lib/velopayments/models/payee2.rb, line 290
def remote_id=(remote_id)
  if !remote_id.nil? && remote_id.to_s.length > 100
    fail ArgumentError, 'invalid value for "remote_id", the character length must be smaller than or equal to 100.'
  end

  if !remote_id.nil? && remote_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "remote_id", the character length must be great than or equal to 1.'
  end

  @remote_id = remote_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/velopayments/models/payee2.rb, line 418
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/velopayments/models/payee2.rb, line 424
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.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/velopayments/models/payee2.rb, line 412
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

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

# File lib/velopayments/models/payee2.rb, line 280
def type=(type)
  validator = EnumAttributeValidator.new('String', ["Individual", "Company"])
  unless validator.valid?(type)
    fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
  end
  @type = type
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/velopayments/models/payee2.rb, line 270
def valid?
  type_validator = EnumAttributeValidator.new('String', ["Individual", "Company"])
  return false unless type_validator.valid?(@type)
  return false if !@remote_id.nil? && @remote_id.to_s.length > 100
  return false if !@remote_id.nil? && @remote_id.to_s.length < 1
  true
end