Class: CyberSource::V2paymentsOrderInformationBillTo

Inherits:
Object
  • Object
show all
Defined in:
lib/cyberSource_client/models/v2payments_order_information_bill_to.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V2paymentsOrderInformationBillTo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 138

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

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

Instance Attribute Details

#address1 ⇒ Object

First line of the billing street address as it appears on the credit card issuer’s records. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_address1 field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



36
37
38
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 36

def address1
  @address1
end

#address2 ⇒ Object

Additional address information. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_address2 field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



39
40
41
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 39

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. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_state field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



45
46
47
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 45

def administrative_area
  @administrative_area
end

#building_number ⇒ Object

Building number in the street address. This field is supported only for: - Cielo transactions. - Redecard customer validation with CyberSource Latin American Processing.



57
58
59
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 57

def building_number
  @building_number
end

#company ⇒ Object

Name of the customer’s company. For processor-specific information, see the company_name field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



33
34
35
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 33

def company
  @company
end

#country ⇒ Object

Country of the billing address. Use the two-character ISO Standard Country Codes. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



51
52
53
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 51

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



54
55
56
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 54

def district
  @district
end

#email ⇒ Object

Customer’s email address, including the full domain name. For processor-specific information, see the customer_email field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



60
61
62
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 60

def email
  @email
end

#first_name ⇒ Object

Customer’s first name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



18
19
20
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 18

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. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



21
22
23
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 21

def last_name
  @last_name
end

#locality ⇒ Object

City of the billing address. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_city field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



42
43
44
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 42

def locality
  @locality
end

#middle_name ⇒ Object

Customer’s middle name.



24
25
26
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 24

def middle_name
  @middle_name
end

#name_suffix ⇒ Object

Customer’s name suffix.



27
28
29
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 27

def name_suffix
  @name_suffix
end

#phone_number ⇒ Object

Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



63
64
65
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 63

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



66
67
68
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 66

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 For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_zip field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



48
49
50
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 48

def postal_code
  @postal_code
end

#title ⇒ Object

Title.



30
31
32
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 30

def title
  @title
end

Class Method Details

.attribute_map ⇒ Object

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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 91

def self.attribute_map
  {
    :'first_name' => :'firstName',
    :'last_name' => :'lastName',
    :'middle_name' => :'middleName',
    :'name_suffix' => :'nameSuffix',
    :'title' => :'title',
    :'company' => :'company',
    :'address1' => :'address1',
    :'address2' => :'address2',
    :'locality' => :'locality',
    :'administrative_area' => :'administrativeArea',
    :'postal_code' => :'postalCode',
    :'country' => :'country',
    :'district' => :'district',
    :'building_number' => :'buildingNumber',
    :'email' => :'email',
    :'phone_number' => :'phoneNumber',
    :'phone_type' => :'phoneType'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 114

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 480

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 &&
      locality == o.locality &&
      administrative_area == o.administrative_area &&
      postal_code == o.postal_code &&
      country == o.country &&
      district == o.district &&
      building_number == o.building_number &&
      email == o.email &&
      phone_number == o.phone_number &&
      phone_type == o.phone_type
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



538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 538

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



604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 604

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



517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 517

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("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{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


504
505
506
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 504

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



510
511
512
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 510

def hash
  [first_name, last_name, middle_name, name_suffix, title, company, address1, address2, locality, administrative_area, postal_code, country, district, building_number, email, phone_number, phone_type].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



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
281
282
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 215

def list_invalid_properties
  invalid_properties = Array.new
  if !@first_name.nil? && @first_name.to_s.length > 60
    invalid_properties.push('invalid value for "first_name", the character length must be smaller than or equal to 60.')
  end

  if !@last_name.nil? && @last_name.to_s.length > 60
    invalid_properties.push('invalid value for "last_name", the character length must be smaller than or equal to 60.')
  end

  if !@middle_name.nil? && @middle_name.to_s.length > 60
    invalid_properties.push('invalid value for "middle_name", the character length must be smaller than or equal to 60.')
  end

  if !@name_suffix.nil? && @name_suffix.to_s.length > 60
    invalid_properties.push('invalid value for "name_suffix", the character length must be smaller than or equal to 60.')
  end

  if !@title.nil? && @title.to_s.length > 60
    invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 60.')
  end

  if !@company.nil? && @company.to_s.length > 60
    invalid_properties.push('invalid value for "company", the character length must be smaller than or equal to 60.')
  end

  if !@address1.nil? && @address1.to_s.length > 60
    invalid_properties.push('invalid value for "address1", the character length must be smaller than or equal to 60.')
  end

  if !@address2.nil? && @address2.to_s.length > 60
    invalid_properties.push('invalid value for "address2", the character length must be smaller than or equal to 60.')
  end

  if !@locality.nil? && @locality.to_s.length > 50
    invalid_properties.push('invalid value for "locality", the character length must be smaller than or equal to 50.')
  end

  if !@administrative_area.nil? && @administrative_area.to_s.length > 2
    invalid_properties.push('invalid value for "administrative_area", the character length must be smaller than or equal to 2.')
  end

  if !@postal_code.nil? && @postal_code.to_s.length > 10
    invalid_properties.push('invalid value for "postal_code", the character length must be smaller than or equal to 10.')
  end

  if !@country.nil? && @country.to_s.length > 2
    invalid_properties.push('invalid value for "country", the character length must be smaller than or equal to 2.')
  end

  if !@district.nil? && @district.to_s.length > 50
    invalid_properties.push('invalid value for "district", the character length must be smaller than or equal to 50.')
  end

  if !@building_number.nil? && @building_number.to_s.length > 256
    invalid_properties.push('invalid value for "building_number", the character length must be smaller than or equal to 256.')
  end

  if !@email.nil? && @email.to_s.length > 255
    invalid_properties.push('invalid value for "email", the character length must be smaller than or equal to 255.')
  end

  if !@phone_number.nil? && @phone_number.to_s.length > 15
    invalid_properties.push('invalid value for "phone_number", the character length must be smaller than or equal to 15.')
  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



584
585
586
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 584

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



590
591
592
593
594
595
596
597
598
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 590

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



578
579
580
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 578

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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/cyberSource_client/models/v2payments_order_information_bill_to.rb', line 286

def valid?
  return false if !@first_name.nil? && @first_name.to_s.length > 60
  return false if !@last_name.nil? && @last_name.to_s.length > 60
  return false if !@middle_name.nil? && @middle_name.to_s.length > 60
  return false if !@name_suffix.nil? && @name_suffix.to_s.length > 60
  return false if !@title.nil? && @title.to_s.length > 60
  return false if !@company.nil? && @company.to_s.length > 60
  return false if !@address1.nil? && @address1.to_s.length > 60
  return false if !@address2.nil? && @address2.to_s.length > 60
  return false if !@locality.nil? && @locality.to_s.length > 50
  return false if !@administrative_area.nil? && @administrative_area.to_s.length > 2
  return false if !@postal_code.nil? && @postal_code.to_s.length > 10
  return false if !@country.nil? && @country.to_s.length > 2
  return false if !@district.nil? && @district.to_s.length > 50
  return false if !@building_number.nil? && @building_number.to_s.length > 256
  return false if !@email.nil? && @email.to_s.length > 255
  return false if !@phone_number.nil? && @phone_number.to_s.length > 15
  phone_type_validator = EnumAttributeValidator.new('String', ['day', 'home', 'night', 'work'])
  return false unless phone_type_validator.valid?(@phone_type)
  true
end