Class: CyberSource::PtsV2PaymentsOrderPost201ResponseOrderInformationBillTo

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PtsV2PaymentsOrderPost201ResponseOrderInformationBillTo

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/pts_v2_payments_order_post201_response_order_information_bill_to.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?(:'title')
    self.title = attributes[:'title']
  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?(:'nameSuffix')
    self.name_suffix = attributes[:'nameSuffix']
  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?(:'phoneNumber')
    self.phone_number = attributes[:'phoneNumber']
  end

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

Instance Attribute Details

#address1 ⇒ Object

First line of the billing street address.



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

def address1
  @address1
end

#address2 ⇒ Object

Second line of the billing street address.



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

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.



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

def administrative_area
  @administrative_area
end

#country ⇒ Object

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



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

def country
  @country
end

#email ⇒ Object

Customer’s email address.



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

def email
  @email
end

#first_name ⇒ Object

Customer’s first name. This name must be the same as the name on the card. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### CyberSource Latin American Processing Important For an authorization request, CyberSource Latin American Processing concatenates ‘orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\ Note CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### 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. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.



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

def first_name
  @first_name
end

#last_name ⇒ Object

Customer’s last name. This name must be the same as the name on the card. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. #### SEPA Required for Create Mandate and Import Mandate #### BACS Required for Import Mandate #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource Latin American Processing Important For an authorization request, CyberSource Latin American Processing concatenates ‘orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\ Note CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### 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. #### RBS WorldPay Atlanta Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.



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

def last_name
  @last_name
end

#locality ⇒ Object

City of the billing address.



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

def locality
  @locality
end

#middle_name ⇒ Object

Customer’s middle name.



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

def middle_name
  @middle_name
end

#name_suffix ⇒ Object

Customer’s name suffix.



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

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.



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

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



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

def postal_code
  @postal_code
end

#title ⇒ Object

Title.



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

def title
  @title
end

#verification_status ⇒ Object

Whether buyer has verified their identity. Used in case of PayPal transactions. Possible Values: * VERIFIED * UNVERIFIED



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

def verification_status
  @verification_status
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/pts_v2_payments_order_post201_response_order_information_bill_to.rb', line 59

def self.attribute_map
  {
    :'title' => :'title',
    :'first_name' => :'firstName',
    :'middle_name' => :'middleName',
    :'last_name' => :'lastName',
    :'name_suffix' => :'nameSuffix',
    :'address1' => :'address1',
    :'address2' => :'address2',
    :'locality' => :'locality',
    :'postal_code' => :'postalCode',
    :'administrative_area' => :'administrativeArea',
    :'country' => :'country',
    :'email' => :'email',
    :'phone_number' => :'phoneNumber',
    :'verification_status' => :'verificationStatus'
  }
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/pts_v2_payments_order_post201_response_order_information_bill_to.rb', line 79

def self.json_map
  {
    :'title' => :'title',
    :'first_name' => :'first_name',
    :'middle_name' => :'middle_name',
    :'last_name' => :'last_name',
    :'name_suffix' => :'name_suffix',
    :'address1' => :'address1',
    :'address2' => :'address2',
    :'locality' => :'locality',
    :'postal_code' => :'postal_code',
    :'administrative_area' => :'administrative_area',
    :'country' => :'country',
    :'email' => :'email',
    :'phone_number' => :'phone_number',
    :'verification_status' => :'verification_status'
  }
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/pts_v2_payments_order_post201_response_order_information_bill_to.rb', line 99

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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



331
332
333
334
335
336
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
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_order_post201_response_order_information_bill_to.rb', line 331

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



397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_order_post201_response_order_information_bill_to.rb', line 397

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



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_order_post201_response_order_information_bill_to.rb', line 310

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


297
298
299
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_order_post201_response_order_information_bill_to.rb', line 297

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [title, first_name, middle_name, last_name, name_suffix, address1, address2, locality, postal_code, administrative_area, country, email, phone_number, verification_status].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/pts_v2_payments_order_post201_response_order_information_bill_to.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



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

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



383
384
385
386
387
388
389
390
391
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_order_post201_response_order_information_bill_to.rb', line 383

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



371
372
373
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_order_post201_response_order_information_bill_to.rb', line 371

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/pts_v2_payments_order_post201_response_order_information_bill_to.rb', line 192

def valid?
  true
end