Class: CyberSource::PtsV2PaymentsPost201ResponseOrderInformationBillTo

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PtsV2PaymentsPost201ResponseOrderInformationBillTo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_bill_to.rb', line 112

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

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

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

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

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

Instance Attribute Details

#address1 ⇒ Object

First line of the billing street address.



21
22
23
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_bill_to.rb', line 21

def address1
  @address1
end

#address2 ⇒ Object

Second line of the billing street address.



24
25
26
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_bill_to.rb', line 24

def address2
  @address2
end

#administrative_area ⇒ Object

State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada.



33
34
35
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_bill_to.rb', line 33

def administrative_area
  @administrative_area
end

#alternate_email_verification_status ⇒ Object

#### Visa Platform Connect Contains one of the following values that will identify the phone number result code in the account verification response message: ‘VERIFIED’ - Customer verified ‘UNVERIFIED’ - Customer not verified ‘FAILED’ - Customer verification failed



45
46
47
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_bill_to.rb', line 45

def alternate_email_verification_status
  @alternate_email_verification_status
end

#alternate_phone_number_verification_status ⇒ Object

#### Visa Platform Connect Contains one of the following values that will identify the phone number result code in the account verification response message: ‘VERIFIED’ - Customer verified ‘UNVERIFIED’ - Customer not verified ‘FAILED’ - Customer verification failed



42
43
44
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_bill_to.rb', line 42

def alternate_phone_number_verification_status
  @alternate_phone_number_verification_status
end

#country ⇒ Object

Country of the billing address. Use the two-character ISO Standard Country Codes.



36
37
38
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_bill_to.rb', line 36

def country
  @country
end

#email ⇒ Object

Email address of the customer.



39
40
41
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_bill_to.rb', line 39

def email
  @email
end

#first_name ⇒ Object

Returns the value of attribute first_name.



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

def first_name
  @first_name
end

#last_name ⇒ Object

Returns the value of attribute last_name.



18
19
20
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_bill_to.rb', line 18

def last_name
  @last_name
end

#locality ⇒ Object

City of the billing address.



27
28
29
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_bill_to.rb', line 27

def locality
  @locality
end

#name_suffix ⇒ Object

Customer’s name suffix.



51
52
53
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_bill_to.rb', line 51

def name_suffix
  @name_suffix
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. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Optional field. #### Worldpay VAP Optional field. #### All other processors Not used.



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

def phone_number
  @phone_number
end

#postal_code ⇒ Object

Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][4 digits] Example: 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][alpha] [numeric][numeric] Example: A1B 2C3



30
31
32
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_bill_to.rb', line 30

def postal_code
  @postal_code
end

Class Method Details

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_bill_to.rb', line 54

def self.attribute_map
  {
    :'first_name' => :'firstName',
    :'last_name' => :'lastName',
    :'address1' => :'address1',
    :'address2' => :'address2',
    :'locality' => :'locality',
    :'postal_code' => :'postalCode',
    :'administrative_area' => :'administrativeArea',
    :'country' => :'country',
    :'email' => :'email',
    :'alternate_phone_number_verification_status' => :'alternatePhoneNumberVerificationStatus',
    :'alternate_email_verification_status' => :'alternateEmailVerificationStatus',
    :'phone_number' => :'phoneNumber',
    :'name_suffix' => :'nameSuffix'
  }
end

.json_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_bill_to.rb', line 73

def self.json_map
  {
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'address1' => :'address1',
    :'address2' => :'address2',
    :'locality' => :'locality',
    :'postal_code' => :'postal_code',
    :'administrative_area' => :'administrative_area',
    :'country' => :'country',
    :'email' => :'email',
    :'alternate_phone_number_verification_status' => :'alternate_phone_number_verification_status',
    :'alternate_email_verification_status' => :'alternate_email_verification_status',
    :'phone_number' => :'phone_number',
    :'name_suffix' => :'name_suffix'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_bill_to.rb', line 92

def self.swagger_types
  {
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'address1' => :'String',
    :'address2' => :'String',
    :'locality' => :'String',
    :'postal_code' => :'String',
    :'administrative_area' => :'String',
    :'country' => :'String',
    :'email' => :'String',
    :'alternate_phone_number_verification_status' => :'String',
    :'alternate_email_verification_status' => :'String',
    :'phone_number' => :'String',
    :'name_suffix' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_bill_to.rb', line 252

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



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
335
336
337
338
339
340
341
342
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_bill_to.rb', line 306

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



372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_bill_to.rb', line 372

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



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

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


272
273
274
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_bill_to.rb', line 272

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



278
279
280
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_bill_to.rb', line 278

def hash
  [first_name, last_name, address1, address2, locality, postal_code, administrative_area, country, email, alternate_phone_number_verification_status, alternate_email_verification_status, phone_number, name_suffix].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



173
174
175
176
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_bill_to.rb', line 173

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



352
353
354
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_bill_to.rb', line 352

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



358
359
360
361
362
363
364
365
366
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_bill_to.rb', line 358

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



346
347
348
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_bill_to.rb', line 346

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



180
181
182
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_bill_to.rb', line 180

def valid?
  true
end