Class: CyberSource::BillTo

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BillTo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



86
87
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
# File 'lib/cybersource_rest_client/models/bill_to.rb', line 86

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

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

Instance Attribute Details

#address1Object

First line of the billing street address. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. Important: It is your responsibility to determine whether a field is required for the transaction you are requesting.



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

def address1
  @address1
end

#address2Object

Additional address information.



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

def address2
  @address2
end

#administrative_areaObject

State or province of the billing address. For an address in the U.S. or Canada, use the State, Province, and Territory Codes for the United States and Canada. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. Important: It is your responsibility to determine whether a field is required for the transaction you are requesting.



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

def administrative_area
  @administrative_area
end

#companyObject

Name of the customer’s company. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. Important: It is your responsibility to determine whether a field is required for the transaction you are requesting.



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

def company
  @company
end

#countryObject

Country of the billing address. Accepts input in the ISO 3166-1 standard, stores as ISO 3166-1-Alpha-2. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. Important It is your responsibility to determine whether a field is required for the transaction you are requesting.



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

def country
  @country
end

#emailObject

Customer’s email address. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. Important It is your responsibility to determine whether a field is required for the transaction you are requesting.



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

def email
  @email
end

#first_nameObject

Customer’s first name. For a credit card transaction, this name must match the name on the card. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. Important: It is your responsibility to determine whether a field is required for the transaction you are requesting.



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

def first_name
  @first_name
end

#last_nameObject

Customer’s last name. For a credit card transaction, this name must match the name on the card. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. Important: It is your responsibility to determine whether a field is required for the transaction you are requesting.



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

def last_name
  @last_name
end

#localityObject

City of the billing address. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. Important: It is your responsibility to determine whether a field is required for the transaction you are requesting.



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

def locality
  @locality
end

#phone_numberObject

Customer phone number. When you create a customer profile, the requirements depend on the payment method: * Credit cards — optional. * Electronic checks — contact your payment processor representative to find out if this field is required or optional. * PINless debits — optional.



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

def phone_number
  @phone_number
end

#postal_codeObject

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 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. Important: It is your responsibility to determine whether a field is required for the transaction you are requesting.



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

def postal_code
  @postal_code
end

Class Method Details

.attribute_mapObject

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# File 'lib/cybersource_rest_client/models/bill_to.rb', line 51

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

.swagger_typesObject

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/cybersource_rest_client/models/bill_to.rb', line 68

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
# File 'lib/cybersource_rest_client/models/bill_to.rb', line 335

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



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
416
417
418
419
420
421
422
423
# File 'lib/cybersource_rest_client/models/bill_to.rb', line 387

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



453
454
455
456
457
458
459
460
461
462
463
464
465
# File 'lib/cybersource_rest_client/models/bill_to.rb', line 453

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



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
# File 'lib/cybersource_rest_client/models/bill_to.rb', line 366

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


353
354
355
# File 'lib/cybersource_rest_client/models/bill_to.rb', line 353

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



359
360
361
# File 'lib/cybersource_rest_client/models/bill_to.rb', line 359

def hash
  [first_name, last_name, company, address1, address2, locality, administrative_area, postal_code, country, email, phone_number].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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

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 !@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 > 20
    invalid_properties.push('invalid value for "administrative_area", the character length must be smaller than or equal to 20.')
  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 > 3
    invalid_properties.push('invalid value for "country", the character length must be smaller than or equal to 3.')
  end

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

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

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

  if !@phone_number.nil? && @phone_number.to_s.length < 6
    invalid_properties.push('invalid value for "phone_number", the character length must be great than or equal to 6.')
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



433
434
435
# File 'lib/cybersource_rest_client/models/bill_to.rb', line 433

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



439
440
441
442
443
444
445
446
447
# File 'lib/cybersource_rest_client/models/bill_to.rb', line 439

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



427
428
429
# File 'lib/cybersource_rest_client/models/bill_to.rb', line 427

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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
# File 'lib/cybersource_rest_client/models/bill_to.rb', line 198

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 !@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 > 20
  return false if !@postal_code.nil? && @postal_code.to_s.length > 10
  return false if !@country.nil? && @country.to_s.length > 3
  return false if !@country.nil? && @country.to_s.length < 2
  return false if !@email.nil? && @email.to_s.length > 320
  return false if !@phone_number.nil? && @phone_number.to_s.length > 32
  return false if !@phone_number.nil? && @phone_number.to_s.length < 6
  true
end