class VeloPayments::UserDetailsUpdateRequest

<p>All properties are optional</p> <p>Only provided properties will be updated</p> <p>Use null to null out a property that is allowed to be nullable</p>

Attributes

email[RW]

the email address of the user

first_name[RW]
last_name[RW]
mfa_type[RW]
primary_contact_number[RW]

The main contact number for the user

secondary_contact_number[RW]

The secondary contact number for the user

sms_number[RW]

The phone number of a device that the user can receive sms messages on

verification_code[RW]

<p>Optional property that MUST be suppied when manually verifying a user</p> <p>The user's smsNumber is registered via a separate endpoint and an OTP sent to them</p>

Public Class Methods

attribute_map() click to toggle source

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

# File lib/velopayments/models/user_details_update_request.rb, line 40
def self.attribute_map
  {
    :'primary_contact_number' => :'primaryContactNumber',
    :'secondary_contact_number' => :'secondaryContactNumber',
    :'first_name' => :'firstName',
    :'last_name' => :'lastName',
    :'email' => :'email',
    :'sms_number' => :'smsNumber',
    :'mfa_type' => :'mfaType',
    :'verification_code' => :'verificationCode'
  }
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/user_details_update_request.rb, line 295
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/user_details_update_request.rb, line 83
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::UserDetailsUpdateRequest` 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::UserDetailsUpdateRequest`. 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?(:'primary_contact_number')
    self.primary_contact_number = attributes[:'primary_contact_number']
  end

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

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

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

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

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

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

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

List of attributes with nullable: true

# File lib/velopayments/models/user_details_update_request.rb, line 68
def self.openapi_nullable
  Set.new([
    :'primary_contact_number',
    :'secondary_contact_number',
    :'first_name',
    :'last_name',
    :'email',
    :'sms_number',
    :'mfa_type',
    :'verification_code'
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/velopayments/models/user_details_update_request.rb, line 54
def self.openapi_types
  {
    :'primary_contact_number' => :'String',
    :'secondary_contact_number' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'email' => :'String',
    :'sms_number' => :'String',
    :'mfa_type' => :'MFAType',
    :'verification_code' => :'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/user_details_update_request.rb, line 267
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      primary_contact_number == o.primary_contact_number &&
      secondary_contact_number == o.secondary_contact_number &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      email == o.email &&
      sms_number == o.sms_number &&
      mfa_type == o.mfa_type &&
      verification_code == o.verification_code
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/user_details_update_request.rb, line 323
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/user_details_update_request.rb, line 392
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/user_details_update_request.rb, line 302
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/user_details_update_request.rb, line 282
def eql?(o)
  self == o
end
first_name=(first_name) click to toggle source

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

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

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

  @first_name = first_name
end
hash() click to toggle source

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

# File lib/velopayments/models/user_details_update_request.rb, line 288
def hash
  [primary_contact_number, secondary_contact_number, first_name, last_name, email, sms_number, mfa_type, verification_code].hash
end
last_name=(last_name) click to toggle source

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

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

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

  @last_name = last_name
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/user_details_update_request.rb, line 131
def list_invalid_properties
  invalid_properties = Array.new
  pattern = Regexp.new(/^\+?[1-9]\d{1,14}$/)
  if !@primary_contact_number.nil? && @primary_contact_number !~ pattern
    invalid_properties.push("invalid value for \"primary_contact_number\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^\+?[1-9]\d{1,14}$/)
  if !@secondary_contact_number.nil? && @secondary_contact_number !~ pattern
    invalid_properties.push("invalid value for \"secondary_contact_number\", must conform to the pattern #{pattern}.")
  end

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

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

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

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

  pattern = Regexp.new(/^\+?[1-9]\d{1,14}$/)
  if !@sms_number.nil? && @sms_number !~ pattern
    invalid_properties.push("invalid value for \"sms_number\", must conform to the pattern #{pattern}.")
  end

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

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

  invalid_properties
end
primary_contact_number=(primary_contact_number) click to toggle source

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

# File lib/velopayments/models/user_details_update_request.rb, line 192
def primary_contact_number=(primary_contact_number)
  pattern = Regexp.new(/^\+?[1-9]\d{1,14}$/)
  if !primary_contact_number.nil? && primary_contact_number !~ pattern
    fail ArgumentError, "invalid value for \"primary_contact_number\", must conform to the pattern #{pattern}."
  end

  @primary_contact_number = primary_contact_number
end
secondary_contact_number=(secondary_contact_number) click to toggle source

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

# File lib/velopayments/models/user_details_update_request.rb, line 203
def secondary_contact_number=(secondary_contact_number)
  pattern = Regexp.new(/^\+?[1-9]\d{1,14}$/)
  if !secondary_contact_number.nil? && secondary_contact_number !~ pattern
    fail ArgumentError, "invalid value for \"secondary_contact_number\", must conform to the pattern #{pattern}."
  end

  @secondary_contact_number = secondary_contact_number
end
sms_number=(sms_number) click to toggle source

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

# File lib/velopayments/models/user_details_update_request.rb, line 242
def sms_number=(sms_number)
  pattern = Regexp.new(/^\+?[1-9]\d{1,14}$/)
  if !sms_number.nil? && sms_number !~ pattern
    fail ArgumentError, "invalid value for \"sms_number\", must conform to the pattern #{pattern}."
  end

  @sms_number = sms_number
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/user_details_update_request.rb, line 368
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/user_details_update_request.rb, line 374
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/user_details_update_request.rb, line 362
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/user_details_update_request.rb, line 177
def valid?
  return false if !@primary_contact_number.nil? && @primary_contact_number !~ Regexp.new(/^\+?[1-9]\d{1,14}$/)
  return false if !@secondary_contact_number.nil? && @secondary_contact_number !~ Regexp.new(/^\+?[1-9]\d{1,14}$/)
  return false if !@first_name.nil? && @first_name.to_s.length > 128
  return false if !@first_name.nil? && @first_name.to_s.length < 1
  return false if !@last_name.nil? && @last_name.to_s.length > 128
  return false if !@last_name.nil? && @last_name.to_s.length < 1
  return false if !@sms_number.nil? && @sms_number !~ Regexp.new(/^\+?[1-9]\d{1,14}$/)
  return false if !@verification_code.nil? && @verification_code.to_s.length > 6
  return false if !@verification_code.nil? && @verification_code.to_s.length < 6
  true
end
verification_code=(verification_code) click to toggle source

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

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

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

  @verification_code = verification_code
end