Class: CyberSource::Ptsv2paymentsOrderInformationBillTo

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsOrderInformationBillTo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb', line 179

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address1 ⇒ Object

Payment card billing street address as it appears on the credit card issuer’s records. #### SEPA Required for Create Mandate and Import Mandate #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Important When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. 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. #### FDMS Nashville When the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_, it must be sent as _1 1st Street_. Required if keyed; not used if swiped. String (20) #### TSYS Acquiring Solutions Required when ‘processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional. String (60) #### For Payouts This field may be sent only for FDC Compass. Important It is your responsibility to determine whether a field is required for the transaction you are requesting.



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

def address1
  @address1
end

#address2 ⇒ Object

Used for additional address information. For example: _Attention: Accounts Payable_ Optional field. For Payouts: This field may be sent only for FDC Compass. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Important When you populate ‘orderInformation.billTo.address1` and `orderInformation.billTo.address2`, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. 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. #### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions This value is used for AVS. #### FDMS Nashville `orderInformation.billTo.address1` and `orderInformation.billTo.address2` together cannot exceed 20 characters. String (20) #### All Other Processors String (60)



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

def address2
  @address2
end

#address3 ⇒ Object

Additional address information (third line of the billing address)



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

def address3
  @address3
end

#address4 ⇒ Object

Additional address information (fourth line of the billing address)



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

def address4
  @address4
end

#administrative_area ⇒ Object

State or province of the billing address. Use the [State, Province, and Territory Codes for the United States and Canada](developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). For Payouts: This field may be sent only for FDC Compass. ##### 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. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. #### 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.



49
50
51
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb', line 49

def administrative_area
  @administrative_area
end

#alternate_email ⇒ Object

#### Visa Platform Connect contains customer’s alternate email address.



85
86
87
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb', line 85

def alternate_email
  @alternate_email
end

#alternate_phone_number ⇒ Object

#### Visa Platform Connect contains customer’s alternate phone number.



82
83
84
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb', line 82

def alternate_phone_number
  @alternate_phone_number
end

#building_number ⇒ Object

Building number in the street address. For example, if the street address is: Rua da Quitanda 187 then the building number is 187. This field is supported only for: - Cielo transactions. - Redecard customer validation with CyberSource Latin American Processing.



64
65
66
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb', line 64

def building_number
  @building_number
end

#company ⇒ Object

Returns the value of attribute company.



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

def company
  @company
end

#country ⇒ Object

Payment card billing country. Use the two-character [ISO Standard Country Codes](apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### SEPA/BACS Required for Create Mandate and Import Mandate #### 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. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. #### 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.



58
59
60
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb', line 58

def country
  @country
end

#county ⇒ Object

U.S. county if available.



55
56
57
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb', line 55

def county
  @county
end

#district ⇒ Object

Customer’s neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This field is available only on Cielo.



61
62
63
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb', line 61

def district
  @district
end

#email ⇒ Object

Customer’s email address, including the full domain name. #### 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. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won’t work and you must resend the invoice with the new payment link. #### 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.



67
68
69
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb', line 67

def email
  @email
end

#email_domain ⇒ Object

Email domain of the customer. The domain of the email address comprises all characters that follow the @ symbol, such as mail.example.com. For the Risk Update service, if the email address and the domain are sent in the request, the domain supersedes the email address.



70
71
72
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb', line 70

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



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

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.



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

def last_name
  @last_name
end

#locality ⇒ Object

Payment card billing city. #### SEPA Required for Create Mandate and Import Mandate #### Atos This field must not contain colons (:). #### 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.



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

def locality
  @locality
end

#middle_name ⇒ Object

Customer’s middle name.



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

def middle_name
  @middle_name
end

#name_suffix ⇒ Object

Customer’s name suffix.



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

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.



73
74
75
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb', line 73

def phone_number
  @phone_number
end

#phone_type ⇒ Object

Customer’s phone number type. #### For Payouts: This field may be sent only for FDC Compass. Possible Values: * day * home * night * work



76
77
78
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb', line 76

def phone_type
  @phone_type
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` 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 #### For Payouts: This field may be sent only for FDC Compass. #### American Express Direct Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. #### Atos This field must not contain colons (:). #### 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. #### FDMS Nashville Required if `pointOfSaleInformation.entryMode=keyed` and the address is in the U.S. or Canada. Optional if `pointOfSaleInformation.entryMode=keyed` and the address is not in the U.S. or Canada. Not used if swiped. #### RBS WorldPay Atlanta: For best card-present keyed rates, send the postal code if `pointOfSaleInformation.entryMode=keyed`. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional field.



52
53
54
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb', line 52

def postal_code
  @postal_code
end

#title ⇒ Object

Title.



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

def title
  @title
end

#verification_status ⇒ Object

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



79
80
81
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb', line 79

def verification_status
  @verification_status
end

Class Method Details

.attribute_map ⇒ Object

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb', line 88

def self.attribute_map
  {
    :'first_name' => :'firstName',
    :'last_name' => :'lastName',
    :'middle_name' => :'middleName',
    :'name_suffix' => :'nameSuffix',
    :'title' => :'title',
    :'company' => :'company',
    :'address1' => :'address1',
    :'address2' => :'address2',
    :'address3' => :'address3',
    :'address4' => :'address4',
    :'locality' => :'locality',
    :'administrative_area' => :'administrativeArea',
    :'postal_code' => :'postalCode',
    :'county' => :'county',
    :'country' => :'country',
    :'district' => :'district',
    :'building_number' => :'buildingNumber',
    :'email' => :'email',
    :'email_domain' => :'emailDomain',
    :'phone_number' => :'phoneNumber',
    :'phone_type' => :'phoneType',
    :'verification_status' => :'verificationStatus',
    :'alternate_phone_number' => :'alternatePhoneNumber',
    :'alternate_email' => :'alternateEmail'
  }
end

.json_map ⇒ Object

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



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
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb', line 118

def self.json_map
  {
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'middle_name' => :'middle_name',
    :'name_suffix' => :'name_suffix',
    :'title' => :'title',
    :'company' => :'company',
    :'address1' => :'address1',
    :'address2' => :'address2',
    :'address3' => :'address3',
    :'address4' => :'address4',
    :'locality' => :'locality',
    :'administrative_area' => :'administrative_area',
    :'postal_code' => :'postal_code',
    :'county' => :'county',
    :'country' => :'country',
    :'district' => :'district',
    :'building_number' => :'building_number',
    :'email' => :'email',
    :'email_domain' => :'email_domain',
    :'phone_number' => :'phone_number',
    :'phone_type' => :'phone_type',
    :'verification_status' => :'verification_status',
    :'alternate_phone_number' => :'alternate_phone_number',
    :'alternate_email' => :'alternate_email'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb', line 148

def self.swagger_types
  {
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'middle_name' => :'String',
    :'name_suffix' => :'String',
    :'title' => :'String',
    :'company' => :'Ptsv2paymentsOrderInformationBillToCompany',
    :'address1' => :'String',
    :'address2' => :'String',
    :'address3' => :'String',
    :'address4' => :'String',
    :'locality' => :'String',
    :'administrative_area' => :'String',
    :'postal_code' => :'String',
    :'county' => :'String',
    :'country' => :'String',
    :'district' => :'String',
    :'building_number' => :'String',
    :'email' => :'String',
    :'email_domain' => :'String',
    :'phone_number' => :'String',
    :'phone_type' => :'String',
    :'verification_status' => :'String',
    :'alternate_phone_number' => :'String',
    :'alternate_email' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb', line 423

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      middle_name == o.middle_name &&
      name_suffix == o.name_suffix &&
      title == o.title &&
      company == o.company &&
      address1 == o.address1 &&
      address2 == o.address2 &&
      address3 == o.address3 &&
      address4 == o.address4 &&
      locality == o.locality &&
      administrative_area == o.administrative_area &&
      postal_code == o.postal_code &&
      county == o.county &&
      country == o.country &&
      district == o.district &&
      building_number == o.building_number &&
      email == o.email &&
      email_domain == o.email_domain &&
      phone_number == o.phone_number &&
      phone_type == o.phone_type &&
      verification_status == o.verification_status &&
      alternate_phone_number == o.alternate_phone_number &&
      alternate_email == o.alternate_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



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb', line 488

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



554
555
556
557
558
559
560
561
562
563
564
565
566
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb', line 554

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



467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb', line 467

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


454
455
456
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb', line 454

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



460
461
462
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb', line 460

def hash
  [first_name, last_name, middle_name, name_suffix, title, company, address1, address2, address3, address4, locality, administrative_area, postal_code, county, country, district, building_number, email, email_domain, phone_number, phone_type, verification_status, alternate_phone_number, alternate_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



284
285
286
287
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb', line 284

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



534
535
536
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb', line 534

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



540
541
542
543
544
545
546
547
548
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb', line 540

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



528
529
530
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb', line 528

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



291
292
293
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb', line 291

def valid?
  true
end