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



102
103
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 102

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

Instance Attribute Details

#address1 ⇒ Object

Recipient address information. Required only for FDCCompass.



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

def address1
  @address1
end

#administrative_area ⇒ Object

Recipient State. Required only for FDCCompass.



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

def administrative_area
  @administrative_area
end

#country ⇒ Object

Recipient country code. Required only for FDCCompass.



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

def country
  @country
end

#date_of_birth ⇒ Object

Recipient date of birth in YYYYMMDD format. Required only for FDCCompass.



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

def date_of_birth
  @date_of_birth
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)



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

def last_name
  @last_name
end

#locality ⇒ Object

Recipient city. Required only for FDCCompass.



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

def locality
  @locality
end

#middle_initial ⇒ Object

Middle Initial of recipient. Required only for FDCCompass.



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

def middle_initial
  @middle_initial
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.



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

def middle_name
  @middle_name
end

#phone_number ⇒ Object

Recipient phone number. Required only for FDCCompass.



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

def phone_number
  @phone_number
end

#postal_code ⇒ Object

Recipient postal code. Required only for FDCCompass.



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

def postal_code
  @postal_code
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 50

def self.attribute_map
  {
    :'first_name' => :'firstName',
    :'middle_initial' => :'middleInitial',
    :'middle_name' => :'middleName',
    :'last_name' => :'lastName',
    :'address1' => :'address1',
    :'locality' => :'locality',
    :'administrative_area' => :'administrativeArea',
    :'country' => :'country',
    :'postal_code' => :'postalCode',
    :'phone_number' => :'phoneNumber',
    :'date_of_birth' => :'dateOfBirth'
  }
end

.json_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 67

def self.json_map
  {
    :'first_name' => :'first_name',
    :'middle_initial' => :'middle_initial',
    :'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',
    :'date_of_birth' => :'date_of_birth'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 84

def self.swagger_types
  {
    :'first_name' => :'String',
    :'middle_initial' => :'String',
    :'middle_name' => :'String',
    :'last_name' => :'String',
    :'address1' => :'String',
    :'locality' => :'String',
    :'administrative_area' => :'String',
    :'country' => :'String',
    :'postal_code' => :'String',
    :'phone_number' => :'String',
    :'date_of_birth' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 234

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      first_name == o.first_name &&
      middle_initial == o.middle_initial &&
      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 &&
      date_of_birth == o.date_of_birth
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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 286

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



352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 352

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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 265

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


252
253
254
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 252

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



258
259
260
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 258

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



155
156
157
158
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 155

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



332
333
334
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 332

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



338
339
340
341
342
343
344
345
346
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 338

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



326
327
328
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 326

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



162
163
164
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb', line 162

def valid?
  true
end