Class: CyberSource::Ptsv1pushfundstransferSenderInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv1pushfundstransferSenderInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 159

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account ⇒ Object

Returns the value of attribute account.



66
67
68
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 66

def 
  @account
end

#address1 ⇒ Object

Street address of sender. Funds Disbursement This value is the address of the originator sending the funds disbursement. Required for card transactions



41
42
43
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 41

def address1
  @address1
end

#address2 ⇒ Object

Used for additional address information. For example: Attention: Accounts Payable Optional field.



44
45
46
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 44

def address2
  @address2
end

#administrative_area ⇒ Object

Sender’s state. Use the State, Province, and Territory Codes for the United States and Canada.The sender’s province, state or territory. Conditional, required if sender’s country is USA or CAN. Must be uppercase alpha 2 or 3 character country subdivision code. See developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf Mandatory for card payments



50
51
52
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 50

def administrative_area
  @administrative_area
end

#building_number ⇒ Object

Building number in the street address. For example, if the street address is: Rua da Quitanda 187 then the building number is 187. Applicable to domestic Colombia transactions only.



35
36
37
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 35

def building_number
  @building_number
end

#country ⇒ Object

Sender’s country code. Use ISO Standard Alpha Country Codes. developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf



53
54
55
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 53

def country
  @country
end

#date_of_birth ⇒ Object

Sender’s date of birth in YYYYMMDD format.



56
57
58
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 56

def date_of_birth
  @date_of_birth
end

#email ⇒ Object

Customer’s email address, including the full domain name.



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

def email
  @email
end

#first_name ⇒ Object

This field contains the first name of the entity funding the transaction Mandatory for card payments



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

def first_name
  @first_name
end

#last_name ⇒ Object

This field contains the last name of the entity funding the transaction Mandatory for card payments



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

def last_name
  @last_name
end

#locality ⇒ Object

The sender’s city Mandatory for card payments



47
48
49
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 47

def locality
  @locality
end

#middle_name ⇒ Object

This field contains the middle name of the entity funding the transaction



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

def middle_name
  @middle_name
end

#name ⇒ Object

Name of sender. Funds Disbursement This value is the name of the originator sending the funds disbursement. Government entities should use this field



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

def name
  @name
end

#payment_information ⇒ Object

Returns the value of attribute payment_information.



61
62
63
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 61

def payment_information
  @payment_information
end

#personal_identification ⇒ Object

Returns the value of attribute personal_identification.



68
69
70
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 68

def personal_identification
  @personal_identification
end

#phone_number ⇒ Object

Customer’s phone number. It is recommended that you include the country code when the order is from outside the U.S.



59
60
61
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 59

def phone_number
  @phone_number
end

#postal_code ⇒ Object

Sender’s postal code. For USA, this must be a valid value of 5 digits or 5 digits hyphen 4 digits, for example ‘63368’, ‘63368-5555’. For other regions, this can be alphanumeric, length 1-10. Required for FDCCompass.



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

def postal_code
  @postal_code
end

#reference_number ⇒ Object

Reference number generated by you that uniquely identifies the sender.



64
65
66
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 64

def reference_number
  @reference_number
end

#street_name ⇒ Object

This field contains the street name of the recipient’s address. Applicable to domestic Colombia transactions only.



38
39
40
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 38

def street_name
  @street_name
end

#type ⇒ Object

‘B` for Business or `I` for individual.



71
72
73
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 71

def type
  @type
end

#vat_registration_number ⇒ Object

Customer’s government-assigned tax identification number.



74
75
76
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 74

def vat_registration_number
  @vat_registration_number
end

Class Method Details

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 77

def self.attribute_map
  {
    :'name' => :'name',
    :'email' => :'email',
    :'first_name' => :'firstName',
    :'last_name' => :'lastName',
    :'middle_name' => :'middleName',
    :'postal_code' => :'postalCode',
    :'building_number' => :'buildingNumber',
    :'street_name' => :'streetName',
    :'address1' => :'address1',
    :'address2' => :'address2',
    :'locality' => :'locality',
    :'administrative_area' => :'administrativeArea',
    :'country' => :'country',
    :'date_of_birth' => :'dateOfBirth',
    :'phone_number' => :'phoneNumber',
    :'payment_information' => :'paymentInformation',
    :'reference_number' => :'referenceNumber',
    :'account' => :'account',
    :'personal_identification' => :'personalIdentification',
    :'type' => :'type',
    :'vat_registration_number' => :'vatRegistrationNumber'
  }
end

.json_map ⇒ Object

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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 104

def self.json_map
  {
    :'name' => :'name',
    :'email' => :'email',
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'middle_name' => :'middle_name',
    :'postal_code' => :'postal_code',
    :'building_number' => :'building_number',
    :'street_name' => :'street_name',
    :'address1' => :'address1',
    :'address2' => :'address2',
    :'locality' => :'locality',
    :'administrative_area' => :'administrative_area',
    :'country' => :'country',
    :'date_of_birth' => :'date_of_birth',
    :'phone_number' => :'phone_number',
    :'payment_information' => :'payment_information',
    :'reference_number' => :'reference_number',
    :'account' => :'account',
    :'personal_identification' => :'personal_identification',
    :'type' => :'type',
    :'vat_registration_number' => :'vat_registration_number'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 131

def self.swagger_types
  {
    :'name' => :'String',
    :'email' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'middle_name' => :'String',
    :'postal_code' => :'String',
    :'building_number' => :'String',
    :'street_name' => :'String',
    :'address1' => :'String',
    :'address2' => :'String',
    :'locality' => :'String',
    :'administrative_area' => :'String',
    :'country' => :'String',
    :'date_of_birth' => :'String',
    :'phone_number' => :'String',
    :'payment_information' => :'Ptsv1pushfundstransferSenderInformationPaymentInformation',
    :'reference_number' => :'String',
    :'account' => :'Ptsv1pushfundstransferSenderInformationAccount',
    :'personal_identification' => :'Ptsv1pushfundstransferSenderInformationPersonalIdentification',
    :'type' => :'String',
    :'vat_registration_number' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 391

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      email == o.email &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      middle_name == o.middle_name &&
      postal_code == o.postal_code &&
      building_number == o.building_number &&
      street_name == o.street_name &&
      address1 == o.address1 &&
      address2 == o.address2 &&
      locality == o.locality &&
      administrative_area == o.administrative_area &&
      country == o.country &&
      date_of_birth == o.date_of_birth &&
      phone_number == o.phone_number &&
      payment_information == o.payment_information &&
      reference_number == o.reference_number &&
       == o. &&
      personal_identification == o.personal_identification &&
      type == o.type &&
      vat_registration_number == o.vat_registration_number
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



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 453

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



519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 519

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



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 432

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


419
420
421
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 419

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



425
426
427
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 425

def hash
  [name, email, first_name, last_name, middle_name, postal_code, building_number, street_name, address1, address2, locality, administrative_area, country, date_of_birth, phone_number, payment_information, reference_number, , personal_identification, type, vat_registration_number].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



252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 252

def list_invalid_properties
  invalid_properties = Array.new
  #if [email protected]? && @country !~ Regexp.new(/^(\\s{0,2}|.{2})$/)
    #invalid_properties.push('invalid value for "country", must conform to the pattern /^(\\s{0,2}|.{2})$/.')
  #end

  #if !@date_of_birth.nil? && @date_of_birth !~ Regexp.new(/^(\\s{0,8}|.{8})$/)
    #invalid_properties.push('invalid value for "date_of_birth", must conform to the pattern /^(\\s{0,8}|.{8})$/.')
  #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



499
500
501
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 499

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



505
506
507
508
509
510
511
512
513
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 505

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



493
494
495
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 493

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



267
268
269
270
271
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 267

def valid?
  #return false if [email protected]? && @country !~ Regexp.new(/^(\\s{0,2}|.{2})$/)
  #return false if !@date_of_birth.nil? && @date_of_birth !~ Regexp.new(/^(\\s{0,8}|.{8})$/)
  true
end