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



129
130
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
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
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 129

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?(:'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?(:'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
end

Instance Attribute Details

#account ⇒ Object

Returns the value of attribute account.



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

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



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

def address1
  @address1
end

#address2 ⇒ Object

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



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

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



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

def administrative_area
  @administrative_area
end

#country ⇒ Object

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



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

def country
  @country
end

#date_of_birth ⇒ Object

Sender’s date of birth in YYYYMMDD format.



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

def date_of_birth
  @date_of_birth
end

#first_name ⇒ Object

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



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

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



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

def last_name
  @last_name
end

#locality ⇒ Object

The sender’s city Mandatory for card payments



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

def locality
  @locality
end

#middle_name ⇒ Object

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



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

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.



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.



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

def payment_information
  @payment_information
end

#personal_identification ⇒ Object

Returns the value of attribute personal_identification.



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

def personal_identification
  @personal_identification
end

#phone_number ⇒ Object

Sender’s phone number.



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

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.



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

def postal_code
  @postal_code
end

#reference_number ⇒ Object

Reference number generated by you that uniquely identifies the sender.



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

def reference_number
  @reference_number
end

Class Method Details

.attribute_map ⇒ Object

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



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/ptsv1pushfundstransfer_sender_information.rb', line 62

def self.attribute_map
  {
    :'name' => :'name',
    :'first_name' => :'firstName',
    :'last_name' => :'lastName',
    :'middle_name' => :'middleName',
    :'postal_code' => :'postalCode',
    :'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'
  }
end

.json_map ⇒ Object

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 84

def self.json_map
  {
    :'name' => :'name',
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'middle_name' => :'middle_name',
    :'postal_code' => :'postal_code',
    :'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'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'name' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'middle_name' => :'String',
    :'postal_code' => :'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'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 311

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      middle_name == o.middle_name &&
      postal_code == o.postal_code &&
      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
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



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 368

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



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

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



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 347

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


334
335
336
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 334

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



340
341
342
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 340

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



202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 202

def list_invalid_properties
  invalid_properties = Array.new
  #if !@country.nil? && @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



414
415
416
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 414

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



420
421
422
423
424
425
426
427
428
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 420

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



408
409
410
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 408

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



217
218
219
220
221
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb', line 217

def valid?
  #return false if !@country.nil? && @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