Class: CyberSource::Ptsv2paymentsBuyerInformationPersonalIdentification

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsBuyerInformationPersonalIdentification

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 60

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

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

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

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

Instance Attribute Details

#idObject

The value of the identification type. This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. Note CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. If ‘type = PASSPORT`, this is the cardholder’s passport number. Recommended for Discover ProtectBuy.



20
21
22
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 20

def id
  @id
end

#issued_byObject

The government agency that issued the driver’s license or passport. If type` = DRIVER_LICENSE`, this is the State or province where the customer’s driver’s license was issued. If type` = PASSPORT`, this is the Issuing country for the cardholder’s passport. Recommended for Discover ProtectBuy. Use the two-character [State, Province, and Territory Codes for the United States and Canada](developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). #### TeleCheck Contact your TeleCheck representative to find out whether this field is required or optional. #### All Other Processors Not used.



23
24
25
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 23

def issued_by
  @issued_by
end

#typeObject

The type of the identification. Possible values: - ‘NATIONAL` - `CPF` - `CPNJ` - `CURP` - `SSN` - `DRIVER_LICENSE` - `PASSPORT_NUMBER` - `PERSONAL_ID` - `TAX_ID` - `BR_CPF` The individual tax ID type, typically is 11 characters long - `BR_CNPJ` The business tax ID type, typically is 14 characters long. This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. Note CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.



17
18
19
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 17

def type
  @type
end

#verification_resultsObject

Verification results received from Issuer or Card Network for verification transactions. Response Only Field.



26
27
28
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 26

def verification_results
  @verification_results
end

Class Method Details

.attribute_mapObject

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



29
30
31
32
33
34
35
36
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 29

def self.attribute_map
  {
    :'type' => :'type',
    :'id' => :'id',
    :'issued_by' => :'issuedBy',
    :'verification_results' => :'verificationResults'
  }
end

.json_mapObject

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



39
40
41
42
43
44
45
46
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 39

def self.json_map
  {
    :'type' => :'type',
    :'id' => :'id',
    :'issued_by' => :'issued_by',
    :'verification_results' => :'verification_results'
  }
end

.swagger_typesObject

Attribute type mapping.



49
50
51
52
53
54
55
56
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 49

def self.swagger_types
  {
    :'type' => :'String',
    :'id' => :'String',
    :'issued_by' => :'String',
    :'verification_results' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



104
105
106
107
108
109
110
111
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 104

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      id == o.id &&
      issued_by == o.issued_by &&
      verification_results == o.verification_results
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 149

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 = CyberSource.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



215
216
217
218
219
220
221
222
223
224
225
226
227
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 215

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 128

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("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[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) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


115
116
117
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 115

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



121
122
123
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 121

def hash
  [type, id, issued_by, verification_results].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



85
86
87
88
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 85

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



195
196
197
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 195

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



201
202
203
204
205
206
207
208
209
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 201

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



189
190
191
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 189

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



92
93
94
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 92

def valid?
  true
end