Class: CyberSource::Ptsv2payoutsRecipientInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2payoutsRecipientInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



120
121
122
123
124
125
126
127
128
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
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 120

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

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

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

  if attributes.has_key?(:'address1')
    self.address1 = attributes[:'address1']
  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?(:'postalCode')
    self.postal_code = attributes[:'postalCode']
  end

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

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

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

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

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

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

Instance Attribute Details

#address1 ⇒ Object

Recipient address information. Required only for FDCCompass.



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

def address1
  @address1
end

#administrative_area ⇒ Object

Recipient State. Required only for FDCCompass.



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

def administrative_area
  @administrative_area
end

#alias_name ⇒ Object

Account owner alias name.



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

def alias_name
  @alias_name
end

#country ⇒ Object

Recipient country code. Required only for FDCCompass.



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

def country
  @country
end

#country_of_birth ⇒ Object

Account Owner Country of Birth



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

def country_of_birth
  @country_of_birth
end

#email ⇒ Object

Account Owner email address



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

def email
  @email
end

#first_name ⇒ Object

First name of recipient. characters. * CTV (14) * Paymentech (30)



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

def first_name
  @first_name
end

#last_name ⇒ Object

Last name of recipient. characters. * CTV (14) * Paymentech (30)



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

def last_name
  @last_name
end

#locality ⇒ Object

Recipient city. Required only for FDCCompass.



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

def locality
  @locality
end

#middle_name ⇒ Object

Recipient’s middle name. This field is a passthrough, which means that CyberSource 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.



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

def middle_name
  @middle_name
end

#nationality ⇒ Object

Account Owner Nationality



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

def nationality
  @nationality
end

#occupation ⇒ Object

Account Owner Occupation



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

def occupation
  @occupation
end

#phone_number ⇒ Object

Recipient phone number. Required only for FDCCompass.



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

def phone_number
  @phone_number
end

#postal_code ⇒ Object

Recipient postal code. Required only for FDCCompass.



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

def postal_code
  @postal_code
end

Class Method Details

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 59

def self.attribute_map
  {
    :'first_name' => :'firstName',
    :'middle_name' => :'middleName',
    :'last_name' => :'lastName',
    :'address1' => :'address1',
    :'locality' => :'locality',
    :'administrative_area' => :'administrativeArea',
    :'country' => :'country',
    :'postal_code' => :'postalCode',
    :'phone_number' => :'phoneNumber',
    :'alias_name' => :'aliasName',
    :'nationality' => :'nationality',
    :'country_of_birth' => :'countryOfBirth',
    :'occupation' => :'occupation',
    :'email' => :'email'
  }
end

.json_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 79

def self.json_map
  {
    :'first_name' => :'first_name',
    :'middle_name' => :'middle_name',
    :'last_name' => :'last_name',
    :'address1' => :'address1',
    :'locality' => :'locality',
    :'administrative_area' => :'administrative_area',
    :'country' => :'country',
    :'postal_code' => :'postal_code',
    :'phone_number' => :'phone_number',
    :'alias_name' => :'alias_name',
    :'nationality' => :'nationality',
    :'country_of_birth' => :'country_of_birth',
    :'occupation' => :'occupation',
    :'email' => :'email'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 99

def self.swagger_types
  {
    :'first_name' => :'String',
    :'middle_name' => :'String',
    :'last_name' => :'String',
    :'address1' => :'String',
    :'locality' => :'String',
    :'administrative_area' => :'String',
    :'country' => :'String',
    :'postal_code' => :'String',
    :'phone_number' => :'String',
    :'alias_name' => :'String',
    :'nationality' => :'String',
    :'country_of_birth' => :'String',
    :'occupation' => :'String',
    :'email' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 282

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      first_name == o.first_name &&
      middle_name == o.middle_name &&
      last_name == o.last_name &&
      address1 == o.address1 &&
      locality == o.locality &&
      administrative_area == o.administrative_area &&
      country == o.country &&
      postal_code == o.postal_code &&
      phone_number == o.phone_number &&
      alias_name == o.alias_name &&
      nationality == o.nationality &&
      country_of_birth == o.country_of_birth &&
      occupation == o.occupation &&
      email == o.email
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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 337

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



403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 403

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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 316

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


303
304
305
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 303

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



309
310
311
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 309

def hash
  [first_name, middle_name, last_name, address1, locality, administrative_area, country, postal_code, phone_number, alias_name, nationality, country_of_birth, occupation, email].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



185
186
187
188
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 185

def list_invalid_properties
  invalid_properties = Array.new
  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



383
384
385
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 383

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



389
390
391
392
393
394
395
396
397
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 389

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



377
378
379
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 377

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



192
193
194
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 192

def valid?
  true
end