class PhoneComClient::PaymentFull

The Payment Method Full Object contains the same properties as the Payment Method Summary Object, along with the following:

Attributes

cc_exp[RW]

Credit card expiration date

cc_number[RW]

Credit card number partially masked with xxxxxxxx

cc_token[RW]

Encrypted credit card token to be used for billing

contact[RW]

Detail of contact person

created_at[RW]

Time payment record is created

decline_count[RW]

Number of times the payment method was declined

id[RW]

Payment Method ID

next_charge_date[RW]

Next billing date

nickname[RW]

Name of Card

status[RW]

'primary' = primary card used for billing; 'onfile' = card on file; 'hidden' = deleted card;

type[RW]

'cc' for credit card

updated_at[RW]

Last time the payment method was updated

voip_id[RW]

API Account ID

Public Class Methods

attribute_map() click to toggle source

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

# File lib/phone_com_client/models/payment_full.rb, line 58
def self.attribute_map
  {
    :'id' => :'id',
    :'voip_id' => :'voip_id',
    :'status' => :'status',
    :'nickname' => :'nickname',
    :'type' => :'type',
    :'created_at' => :'created_at',
    :'contact' => :'contact',
    :'decline_count' => :'decline_count',
    :'next_charge_date' => :'next_charge_date',
    :'updated_at' => :'updated_at',
    :'cc_token' => :'cc_token',
    :'cc_number' => :'cc_number',
    :'cc_exp' => :'cc_exp'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/phone_com_client/models/payment_full.rb, line 97
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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/phone_com_client/models/payment_full.rb, line 77
def self.swagger_types
  {
    :'id' => :'Integer',
    :'voip_id' => :'Integer',
    :'status' => :'String',
    :'nickname' => :'String',
    :'type' => :'String',
    :'created_at' => :'Integer',
    :'contact' => :'ContactResponse',
    :'decline_count' => :'Integer',
    :'next_charge_date' => :'Integer',
    :'updated_at' => :'Integer',
    :'cc_token' => :'String',
    :'cc_number' => :'String',
    :'cc_exp' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/phone_com_client/models/payment_full.rb, line 171
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      voip_id == o.voip_id &&
      status == o.status &&
      nickname == o.nickname &&
      type == o.type &&
      created_at == o.created_at &&
      contact == o.contact &&
      decline_count == o.decline_count &&
      next_charge_date == o.next_charge_date &&
      updated_at == o.updated_at &&
      cc_token == o.cc_token &&
      cc_number == o.cc_number &&
      cc_exp == o.cc_exp
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/phone_com_client/models/payment_full.rb, line 225
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 = PhoneComClient.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/phone_com_client/models/payment_full.rb, line 291
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/phone_com_client/models/payment_full.rb, line 204
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
eql?(o) click to toggle source

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

# File lib/phone_com_client/models/payment_full.rb, line 191
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/phone_com_client/models/payment_full.rb, line 197
def hash
  [id, voip_id, status, nickname, type, created_at, contact, decline_count, next_charge_date, updated_at, cc_token, cc_number, cc_exp].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/phone_com_client/models/payment_full.rb, line 158
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/phone_com_client/models/payment_full.rb, line 271
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/phone_com_client/models/payment_full.rb, line 277
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/phone_com_client/models/payment_full.rb, line 265
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/phone_com_client/models/payment_full.rb, line 165
def valid?
  true
end