Class: CyberSource::Upv1capturecontextsOrderInformationBillTo

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Upv1capturecontextsOrderInformationBillTo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

Instance Attribute Details

#address1 ⇒ Object

Payment card billing street address as it appears on the credit card issuer’s records.



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

def address1
  @address1
end

#address2 ⇒ Object

Used for additional address information. For example: _Attention: Accounts Payable_ Optional field.



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

def address2
  @address2
end

#address3 ⇒ Object

Additional address information (third line of the billing address)



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

def address3
  @address3
end

#address4 ⇒ Object

Additional address information (fourth line of the billing address)



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

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).



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

def administrative_area
  @administrative_area
end

#building_number ⇒ Object

Building number in the street address.



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

def building_number
  @building_number
end

#company ⇒ Object

Returns the value of attribute company.



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

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).



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

def country
  @country
end

#district ⇒ Object

Customer’s neighborhood, community, or region (a barrio in Brazil) within the city or municipality



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

def district
  @district
end

#email ⇒ Object

Customer’s email address, including the full domain name.



50
51
52
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_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



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

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.



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

def last_name
  @last_name
end

#locality ⇒ Object

Payment card billing city.



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

def locality
  @locality
end

#middle_name ⇒ Object

Customer’s middle name.



59
60
61
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_bill_to.rb', line 59

def middle_name
  @middle_name
end

#name_suffix ⇒ Object

Customer’s name suffix.



62
63
64
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_bill_to.rb', line 62

def name_suffix
  @name_suffix
end

#phone_number ⇒ Object

Customer’s phone number.



68
69
70
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_bill_to.rb', line 68

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



71
72
73
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_bill_to.rb', line 71

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.



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

def postal_code
  @postal_code
end

#title ⇒ Object

Title.



65
66
67
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_bill_to.rb', line 65

def title
  @title
end

Class Method Details

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_bill_to.rb', line 74

def self.attribute_map
  {
    :'address1' => :'address1',
    :'address2' => :'address2',
    :'address3' => :'address3',
    :'address4' => :'address4',
    :'administrative_area' => :'administrativeArea',
    :'building_number' => :'buildingNumber',
    :'country' => :'country',
    :'district' => :'district',
    :'locality' => :'locality',
    :'postal_code' => :'postalCode',
    :'company' => :'company',
    :'email' => :'email',
    :'first_name' => :'firstName',
    :'last_name' => :'lastName',
    :'middle_name' => :'middleName',
    :'name_suffix' => :'nameSuffix',
    :'title' => :'title',
    :'phone_number' => :'phoneNumber',
    :'phone_type' => :'phoneType'
  }
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
117
118
119
120
121
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_bill_to.rb', line 99

def self.swagger_types
  {
    :'address1' => :'String',
    :'address2' => :'String',
    :'address3' => :'String',
    :'address4' => :'String',
    :'administrative_area' => :'String',
    :'building_number' => :'String',
    :'country' => :'String',
    :'district' => :'String',
    :'locality' => :'String',
    :'postal_code' => :'String',
    :'company' => :'Upv1capturecontextsOrderInformationBillToCompany',
    :'email' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'middle_name' => :'String',
    :'name_suffix' => :'String',
    :'title' => :'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



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_bill_to.rb', line 319

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



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_bill_to.rb', line 379

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



445
446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_bill_to.rb', line 445

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



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_bill_to.rb', line 358

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


345
346
347
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_bill_to.rb', line 345

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



351
352
353
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_bill_to.rb', line 351

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



210
211
212
213
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_bill_to.rb', line 210

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



425
426
427
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_bill_to.rb', line 425

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



431
432
433
434
435
436
437
438
439
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_bill_to.rb', line 431

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



419
420
421
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_bill_to.rb', line 419

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



217
218
219
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_bill_to.rb', line 217

def valid?
  true
end