Class: CyberSource::Ptsv2paymentsBuyerInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsBuyerInformation

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
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information.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?(:'merchantCustomerId')
    self.merchant_customer_id = attributes[:'merchantCustomerId']
  end

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

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

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

  if attributes.has_key?(:'personalIdentification')
    if (value = attributes[:'personalIdentification']).is_a?(Array)
      self.personal_identification = value
    end
  end

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

Instance Attribute Details

#company_tax_id ⇒ Object

Company’s tax identifier. This is only used for eCheck service. ** TeleCheck ** Contact your TeleCheck representative to find out whether this field is required or optional. ** All Other Processors ** Not used.



27
28
29
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information.rb', line 27

def company_tax_id
  @company_tax_id
end

#date_of_birth ⇒ Object

Recipient’s date of birth. Format: ‘YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)



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

def date_of_birth
  @date_of_birth
end

#hashed_password ⇒ Object

The merchant’s password that CyberSource hashes and stores as a hashed password. For details about this field, see the ‘customer_password` field description in [Decision Manager Developer Guide Using the SCMP API.](www.cybersource.com/developers/documentation/fraud_management/)



32
33
34
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information.rb', line 32

def hashed_password
  @hashed_password
end

#merchant_customer_id ⇒ Object

Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer’s contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. ‘customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



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

def merchant_customer_id
  @merchant_customer_id
end

#personal_identification ⇒ Object

Returns the value of attribute personal_identification.



29
30
31
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information.rb', line 29

def personal_identification
  @personal_identification
end

#vat_registration_number ⇒ Object

Customer’s government-assigned tax identification number. For processor-specific information, see the purchaser_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)



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

def vat_registration_number
  @vat_registration_number
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information.rb', line 35

def self.attribute_map
  {
    :'merchant_customer_id' => :'merchantCustomerId',
    :'date_of_birth' => :'dateOfBirth',
    :'vat_registration_number' => :'vatRegistrationNumber',
    :'company_tax_id' => :'companyTaxId',
    :'personal_identification' => :'personalIdentification',
    :'hashed_password' => :'hashedPassword'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'merchant_customer_id' => :'String',
    :'date_of_birth' => :'String',
    :'vat_registration_number' => :'String',
    :'company_tax_id' => :'String',
    :'personal_identification' => :'Array<Ptsv2paymentsBuyerInformationPersonalIdentification>',
    :'hashed_password' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



183
184
185
186
187
188
189
190
191
192
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information.rb', line 183

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      merchant_customer_id == o.merchant_customer_id &&
      date_of_birth == o.date_of_birth &&
      vat_registration_number == o.vat_registration_number &&
      company_tax_id == o.company_tax_id &&
      personal_identification == o.personal_identification &&
      hashed_password == o.hashed_password
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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information.rb', line 230

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



296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information.rb', line 296

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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information.rb', line 209

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


196
197
198
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information.rb', line 196

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



202
203
204
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information.rb', line 202

def hash
  [merchant_customer_id, date_of_birth, vat_registration_number, company_tax_id, personal_identification, hashed_password].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



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information.rb', line 95

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

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

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

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

  if !@hashed_password.nil? && @hashed_password.to_s.length > 100
    invalid_properties.push('invalid value for "hashed_password", the character length must be smaller than or equal to 100.')
  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



276
277
278
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information.rb', line 276

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



282
283
284
285
286
287
288
289
290
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information.rb', line 282

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



270
271
272
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information.rb', line 270

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



122
123
124
125
126
127
128
129
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_buyer_information.rb', line 122

def valid?
  return false if !@merchant_customer_id.nil? && @merchant_customer_id.to_s.length > 100
  return false if !@date_of_birth.nil? && @date_of_birth.to_s.length > 8
  return false if !@vat_registration_number.nil? && @vat_registration_number.to_s.length > 20
  return false if !@company_tax_id.nil? && @company_tax_id.to_s.length > 9
  return false if !@hashed_password.nil? && @hashed_password.to_s.length > 100
  true
end