Class: CyberSource::Ptsv2paymentsBuyerInformationPersonalIdentification

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

Defined Under Namespace

Classes: EnumAttributeValidator

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 68

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
end

Instance Attribute Details

#id ⇒ Object

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. For processor-specific information, see the ‘personal_id` field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) If `type = PASSPORT`, this is the cardholder’s passport number. Recommended for Discover ProtectBuy.



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

def id
  @id
end

#issued_by ⇒ Object

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. #### TeleCheck Contact your TeleCheck representative to find out whether this field is required or optional. #### All Other Processors Not used. For details about the country that issued the passport, see ‘customer_passport_country` field description in [CyberSource Payer Authentication Using the SCMP API] (apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) For details about the state or province that issued the passport, see `driver_license_state` field description in [Electronic Check Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)



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

def issued_by
  @issued_by
end

#type ⇒ Object

The type of the identification. Possible values: - ‘NATIONAL` - `CPF` - `CPNJ` - `CURP` - `SSN` - `DRIVER_LICENSE` 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.



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



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

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

.swagger_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 58

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



129
130
131
132
133
134
135
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 129

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      id == o.id &&
      issued_by == o.issued_by
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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 173

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



239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 239

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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 152

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


139
140
141
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 139

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



145
146
147
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 145

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

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



89
90
91
92
93
94
95
96
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 89

def list_invalid_properties
  invalid_properties = Array.new
  if !@id.nil? && @id.to_s.length > 26
    invalid_properties.push('invalid value for "id", the character length must be smaller than or equal to 26.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



219
220
221
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 219

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



225
226
227
228
229
230
231
232
233
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 225

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



213
214
215
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 213

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



100
101
102
103
104
105
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb', line 100

def valid?
  type_validator = EnumAttributeValidator.new('String', ['NATIONAL', 'CPF', 'CPNJ', 'CURP', 'SSN', 'DRIVER_LICENSE'])
  return false unless type_validator.valid?(@type)
  return false if !@id.nil? && @id.to_s.length > 26
  true
end