Class: CyberSource::Ptsv1pushfundstransferRecipientInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv1pushfundstransferRecipientInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
152
153
154
155
156
157
158
159
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information.rb', line 106

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?(:'paymentInformation')
    self.payment_information = attributes[:'paymentInformation']
  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?(:'postalCode')
    self.postal_code = attributes[:'postalCode']
  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?(:'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?(:'phoneNumber')
    self.phone_number = attributes[:'phoneNumber']
  end

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

Instance Attribute Details

#address1 ⇒ Object

First line of the recipient’s address. Required for card payments



19
20
21
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information.rb', line 19

def address1
  @address1
end

#address2 ⇒ Object

Second line of the recipient’s address



22
23
24
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information.rb', line 22

def address2
  @address2
end

#administrative_area ⇒ Object

The recipient’s province, state or territory. Conditional, required if recipient’s country is USA or CAN. Must be an ISO 3166-2 uppercase alpha 2 or 3 character country subdivision code. For example, Missouri is MO. See developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf Required for card payments.



31
32
33
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information.rb', line 31

def administrative_area
  @administrative_area
end

#country ⇒ Object

Recipient country code. Use the ISO Standard Alpha Country Codes. developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf



34
35
36
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information.rb', line 34

def country
  @country
end

#first_name ⇒ Object

First name of recipient.



37
38
39
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information.rb', line 37

def first_name
  @first_name
end

#last_name ⇒ Object

Last name of recipient.



43
44
45
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information.rb', line 43

def last_name
  @last_name
end

#locality ⇒ Object

Recipient city.



25
26
27
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information.rb', line 25

def locality
  @locality
end

#middle_name ⇒ Object

Sender’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.



40
41
42
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information.rb', line 40

def middle_name
  @middle_name
end

#payment_information ⇒ Object

Returns the value of attribute payment_information.



16
17
18
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information.rb', line 16

def payment_information
  @payment_information
end

#personal_identification ⇒ Object

Returns the value of attribute personal_identification.



48
49
50
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information.rb', line 48

def personal_identification
  @personal_identification
end

#phone_number ⇒ Object

Recipient phone number. This field is supported by FDC Compass. Mastercard Send: Max length is 15 with no dashes or spaces.



46
47
48
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information.rb', line 46

def phone_number
  @phone_number
end

#postal_code ⇒ Object

Recipient 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. Mandatory for card payments.



28
29
30
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information.rb', line 28

def postal_code
  @postal_code
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'payment_information' => :'paymentInformation',
    :'address1' => :'address1',
    :'address2' => :'address2',
    :'locality' => :'locality',
    :'postal_code' => :'postalCode',
    :'administrative_area' => :'administrativeArea',
    :'country' => :'country',
    :'first_name' => :'firstName',
    :'middle_name' => :'middleName',
    :'last_name' => :'lastName',
    :'phone_number' => :'phoneNumber',
    :'personal_identification' => :'personalIdentification'
  }
end

.json_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information.rb', line 69

def self.json_map
  {
    :'payment_information' => :'payment_information',
    :'address1' => :'address1',
    :'address2' => :'address2',
    :'locality' => :'locality',
    :'postal_code' => :'postal_code',
    :'administrative_area' => :'administrative_area',
    :'country' => :'country',
    :'first_name' => :'first_name',
    :'middle_name' => :'middle_name',
    :'last_name' => :'last_name',
    :'phone_number' => :'phone_number',
    :'personal_identification' => :'personal_identification'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'payment_information' => :'Ptsv1pushfundstransferRecipientInformationPaymentInformation',
    :'address1' => :'String',
    :'address2' => :'String',
    :'locality' => :'String',
    :'postal_code' => :'String',
    :'administrative_area' => :'String',
    :'country' => :'String',
    :'first_name' => :'String',
    :'middle_name' => :'String',
    :'last_name' => :'String',
    :'phone_number' => :'String',
    :'personal_identification' => :'Ptsv1pushfundstransferRecipientInformationPersonalIdentification'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information.rb', line 245

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



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
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information.rb', line 298

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



364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information.rb', line 364

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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information.rb', line 277

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


264
265
266
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information.rb', line 264

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [payment_information, address1, address2, locality, postal_code, administrative_area, country, first_name, middle_name, last_name, phone_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



163
164
165
166
167
168
169
170
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information.rb', line 163

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

  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



344
345
346
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information.rb', line 344

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



350
351
352
353
354
355
356
357
358
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information.rb', line 350

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



338
339
340
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information.rb', line 338

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



174
175
176
177
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information.rb', line 174

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