class VeloPayments::PayeeResponseV2

Attributes

accept_terms_and_conditions_timestamp[RW]

The timestamp when the payee last accepted T&Cs

address[RW]
cellphone_number[RW]
company[RW]
country[RW]
created[RW]
disabled[RW]
disabled_comment[RW]
disabled_updated_timestamp[RW]
display_name[RW]
email[RW]
enhanced_kyc_completed[RW]
grace_period_end_date[RW]
individual[RW]
kyc_completed_timestamp[RW]
language[RW]
last_ofac_check_timestamp[RW]
marketing_opt_in_decision[RW]
marketing_opt_in_timestamp[RW]
ofac_override[RW]
ofac_override_reason[RW]
ofac_override_timestamp[RW]
ofac_status[RW]
onboarded_status[RW]
pause_payment[RW]
pause_payment_timestamp[RW]
payee_id[RW]
payee_type[RW]
payor_refs[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/velopayments/models/payee_response_v2.rb, line 77
def self.attribute_map
  {
    :'payee_id' => :'payeeId',
    :'payor_refs' => :'payorRefs',
    :'email' => :'email',
    :'onboarded_status' => :'onboardedStatus',
    :'ofac_status' => :'ofacStatus',
    :'language' => :'language',
    :'created' => :'created',
    :'country' => :'country',
    :'display_name' => :'displayName',
    :'payee_type' => :'payeeType',
    :'disabled' => :'disabled',
    :'disabled_comment' => :'disabledComment',
    :'disabled_updated_timestamp' => :'disabledUpdatedTimestamp',
    :'address' => :'address',
    :'individual' => :'individual',
    :'company' => :'company',
    :'cellphone_number' => :'cellphoneNumber',
    :'last_ofac_check_timestamp' => :'lastOfacCheckTimestamp',
    :'ofac_override' => :'ofacOverride',
    :'ofac_override_reason' => :'ofacOverrideReason',
    :'ofac_override_timestamp' => :'ofacOverrideTimestamp',
    :'grace_period_end_date' => :'gracePeriodEndDate',
    :'enhanced_kyc_completed' => :'enhancedKycCompleted',
    :'kyc_completed_timestamp' => :'kycCompletedTimestamp',
    :'pause_payment' => :'pausePayment',
    :'pause_payment_timestamp' => :'pausePaymentTimestamp',
    :'marketing_opt_in_decision' => :'marketingOptInDecision',
    :'marketing_opt_in_timestamp' => :'marketingOptInTimestamp',
    :'accept_terms_and_conditions_timestamp' => :'acceptTermsAndConditionsTimestamp'
  }
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/payee_response_v2.rb, line 360
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/payee_response_v2.rb, line 164
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::PayeeResponseV2` 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::PayeeResponseV2`. 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?(:'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?(:'onboarded_status')
    self.onboarded_status = attributes[:'onboarded_status']
  end

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

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

  if attributes.key?(:'created')
    self.created = attributes[:'created']
  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?(:'payee_type')
    self.payee_type = attributes[:'payee_type']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

List of attributes with nullable: true

# File lib/velopayments/models/payee_response_v2.rb, line 147
def self.openapi_nullable
  Set.new([
    :'payor_refs',
    :'email',
    :'company',
    :'last_ofac_check_timestamp',
    :'ofac_override_timestamp',
    :'grace_period_end_date',
    :'kyc_completed_timestamp',
    :'pause_payment_timestamp',
    :'marketing_opt_in_timestamp',
    :'accept_terms_and_conditions_timestamp'
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/velopayments/models/payee_response_v2.rb, line 112
def self.openapi_types
  {
    :'payee_id' => :'String',
    :'payor_refs' => :'Array<PayeePayorRefV2>',
    :'email' => :'String',
    :'onboarded_status' => :'OnboardedStatus2',
    :'ofac_status' => :'OfacStatus2',
    :'language' => :'Language2',
    :'created' => :'DateTime',
    :'country' => :'String',
    :'display_name' => :'String',
    :'payee_type' => :'PayeeType',
    :'disabled' => :'Boolean',
    :'disabled_comment' => :'String',
    :'disabled_updated_timestamp' => :'DateTime',
    :'address' => :'PayeeAddress2',
    :'individual' => :'Individual',
    :'company' => :'Company',
    :'cellphone_number' => :'String',
    :'last_ofac_check_timestamp' => :'String',
    :'ofac_override' => :'Boolean',
    :'ofac_override_reason' => :'String',
    :'ofac_override_timestamp' => :'String',
    :'grace_period_end_date' => :'Date',
    :'enhanced_kyc_completed' => :'Boolean',
    :'kyc_completed_timestamp' => :'String',
    :'pause_payment' => :'Boolean',
    :'pause_payment_timestamp' => :'String',
    :'marketing_opt_in_decision' => :'Boolean',
    :'marketing_opt_in_timestamp' => :'String',
    :'accept_terms_and_conditions_timestamp' => :'DateTime'
  }
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/payee_response_v2.rb, line 311
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      payee_id == o.payee_id &&
      payor_refs == o.payor_refs &&
      email == o.email &&
      onboarded_status == o.onboarded_status &&
      ofac_status == o.ofac_status &&
      language == o.language &&
      created == o.created &&
      country == o.country &&
      display_name == o.display_name &&
      payee_type == o.payee_type &&
      disabled == o.disabled &&
      disabled_comment == o.disabled_comment &&
      disabled_updated_timestamp == o.disabled_updated_timestamp &&
      address == o.address &&
      individual == o.individual &&
      company == o.company &&
      cellphone_number == o.cellphone_number &&
      last_ofac_check_timestamp == o.last_ofac_check_timestamp &&
      ofac_override == o.ofac_override &&
      ofac_override_reason == o.ofac_override_reason &&
      ofac_override_timestamp == o.ofac_override_timestamp &&
      grace_period_end_date == o.grace_period_end_date &&
      enhanced_kyc_completed == o.enhanced_kyc_completed &&
      kyc_completed_timestamp == o.kyc_completed_timestamp &&
      pause_payment == o.pause_payment &&
      pause_payment_timestamp == o.pause_payment_timestamp &&
      marketing_opt_in_decision == o.marketing_opt_in_decision &&
      marketing_opt_in_timestamp == o.marketing_opt_in_timestamp &&
      accept_terms_and_conditions_timestamp == o.accept_terms_and_conditions_timestamp
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/payee_response_v2.rb, line 388
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/payee_response_v2.rb, line 457
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/payee_response_v2.rb, line 367
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/payee_response_v2.rb, line 347
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/payee_response_v2.rb, line 353
def hash
  [payee_id, payor_refs, email, onboarded_status, ofac_status, language, created, country, display_name, payee_type, disabled, disabled_comment, disabled_updated_timestamp, address, individual, company, cellphone_number, last_ofac_check_timestamp, ofac_override, ofac_override_reason, ofac_override_timestamp, grace_period_end_date, enhanced_kyc_completed, kyc_completed_timestamp, pause_payment, pause_payment_timestamp, marketing_opt_in_decision, marketing_opt_in_timestamp, accept_terms_and_conditions_timestamp].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/payee_response_v2.rb, line 298
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
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/payee_response_v2.rb, line 433
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/payee_response_v2.rb, line 439
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/payee_response_v2.rb, line 427
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/velopayments/models/payee_response_v2.rb, line 305
def valid?
  true
end