class CityPayApiClient::CardHolderAccount

Attributes

account_id[RW]

The account id of the card holder account provided by the merchant which uniquely identifies the account.

cards[RW]
contact[RW]
date_created[RW]

The date and time the account was created.

default_card_id[RW]

The id of the default card.

default_card_index[RW]

The index in the array of the default card.

status[RW]

Defines the status of the account for processing valid values are - ACTIVE for active accounts that are able to process - DISABLED for accounts that are currently disabled for processing.

unique_id[RW]

A unique id of the card holder account which uniquely identifies the stored account. This value is not searchable.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/citypay_api_client/models/card_holder_account.rb, line 39
def self.attribute_map
  {
    :'account_id' => :'account_id',
    :'cards' => :'cards',
    :'contact' => :'contact',
    :'date_created' => :'date_created',
    :'default_card_id' => :'default_card_id',
    :'default_card_index' => :'default_card_index',
    :'status' => :'status',
    :'unique_id' => :'unique_id'
  }
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/citypay_api_client/models/card_holder_account.rb, line 203
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/citypay_api_client/models/card_holder_account.rb, line 74
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `CityPayApiClient::CardHolderAccount` 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 `CityPayApiClient::CardHolderAccount`. 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?(:'account_id')
    self.account_id = attributes[:'account_id']
  end

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

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

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

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

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

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

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

List of attributes with nullable: true

# File lib/citypay_api_client/models/card_holder_account.rb, line 67
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/citypay_api_client/models/card_holder_account.rb, line 53
def self.openapi_types
  {
    :'account_id' => :'String',
    :'cards' => :'Array<Card>',
    :'contact' => :'ContactDetails',
    :'date_created' => :'DateTime',
    :'default_card_id' => :'String',
    :'default_card_index' => :'String',
    :'status' => :'String',
    :'unique_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/citypay_api_client/models/card_holder_account.rb, line 175
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      account_id == o.account_id &&
      cards == o.cards &&
      contact == o.contact &&
      date_created == o.date_created &&
      default_card_id == o.default_card_id &&
      default_card_index == o.default_card_index &&
      status == o.status &&
      unique_id == o.unique_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/citypay_api_client/models/card_holder_account.rb, line 231
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
    CityPayApiClient.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/citypay_api_client/models/card_holder_account.rb, line 300
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
account_id=(account_id) click to toggle source

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

# File lib/citypay_api_client/models/card_holder_account.rb, line 157
def account_id=(account_id)
  if account_id.nil?
    fail ArgumentError, 'account_id cannot be nil'
  end

  if account_id.to_s.length > 50
    fail ArgumentError, 'invalid value for "account_id", the character length must be smaller than or equal to 50.'
  end

  if account_id.to_s.length < 5
    fail ArgumentError, 'invalid value for "account_id", the character length must be great than or equal to 5.'
  end

  @account_id = account_id
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/citypay_api_client/models/card_holder_account.rb, line 210
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/citypay_api_client/models/card_holder_account.rb, line 190
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/citypay_api_client/models/card_holder_account.rb, line 196
def hash
  [account_id, cards, contact, date_created, default_card_id, default_card_index, status, unique_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/citypay_api_client/models/card_holder_account.rb, line 124
def list_invalid_properties
  invalid_properties = Array.new
  if @account_id.nil?
    invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
  end

  if @account_id.to_s.length > 50
    invalid_properties.push('invalid value for "account_id", the character length must be smaller than or equal to 50.')
  end

  if @account_id.to_s.length < 5
    invalid_properties.push('invalid value for "account_id", the character length must be great than or equal to 5.')
  end

  if @contact.nil?
    invalid_properties.push('invalid value for "contact", contact cannot be nil.')
  end

  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/citypay_api_client/models/card_holder_account.rb, line 276
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/citypay_api_client/models/card_holder_account.rb, line 282
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/citypay_api_client/models/card_holder_account.rb, line 270
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/citypay_api_client/models/card_holder_account.rb, line 147
def valid?
  return false if @account_id.nil?
  return false if @account_id.to_s.length > 50
  return false if @account_id.to_s.length < 5
  return false if @contact.nil?
  true
end