Class: CyberSource::TssV2TransactionsGet200ResponseOrderInformationBillTo

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TssV2TransactionsGet200ResponseOrderInformationBillTo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_bill_to.rb', line 101

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

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

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



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

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)



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

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)



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

def administrative_area
  @administrative_area
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)



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

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_rest_client/models/tss_v2_transactions_get200_response_order_information_bill_to.rb', line 51

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



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

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_rest_client/models/tss_v2_transactions_get200_response_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_rest_client/models/tss_v2_transactions_get200_response_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)



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

def locality
  @locality
end

#middel_name ⇒ Object

Customer’s middle name.



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

def middel_name
  @middel_name
end

#name_suffix ⇒ Object

Customer’s name suffix.



27
28
29
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_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)



57
58
59
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_bill_to.rb', line 57

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



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

def postal_code
  @postal_code
end

#title ⇒ Object

Title.



54
55
56
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_bill_to.rb', line 54

def title
  @title
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_bill_to.rb', line 60

def self.attribute_map
  {
    :'first_name' => :'firstName',
    :'last_name' => :'lastName',
    :'middel_name' => :'middelName',
    :'name_suffix' => :'nameSuffix',
    :'address1' => :'address1',
    :'address2' => :'address2',
    :'locality' => :'locality',
    :'administrative_area' => :'administrativeArea',
    :'postal_code' => :'postalCode',
    :'company' => :'company',
    :'email' => :'email',
    :'country' => :'country',
    :'title' => :'title',
    :'phone_number' => :'phoneNumber'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_bill_to.rb', line 80

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_bill_to.rb', line 389

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



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_bill_to.rb', line 444

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



510
511
512
513
514
515
516
517
518
519
520
521
522
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_bill_to.rb', line 510

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



423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_bill_to.rb', line 423

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


410
411
412
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_bill_to.rb', line 410

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



416
417
418
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_bill_to.rb', line 416

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



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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_bill_to.rb', line 166

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 !@middel_name.nil? && @middel_name.to_s.length > 60
    invalid_properties.push('invalid value for "middel_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 !@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 !@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 !@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 !@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 !@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 !@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



490
491
492
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_bill_to.rb', line 490

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



496
497
498
499
500
501
502
503
504
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_bill_to.rb', line 496

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



484
485
486
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_bill_to.rb', line 484

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



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_bill_to.rb', line 229

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 !@middel_name.nil? && @middel_name.to_s.length > 60
  return false if !@name_suffix.nil? && @name_suffix.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 !@company.nil? && @company.to_s.length > 60
  return false if !@email.nil? && @email.to_s.length > 255
  return false if !@country.nil? && @country.to_s.length > 2
  return false if !@title.nil? && @title.to_s.length > 60
  return false if !@phone_number.nil? && @phone_number.to_s.length > 15
  true
end