Class: CyberSource::Vasv2taxOrderInformationBillTo

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Vasv2taxOrderInformationBillTo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_bill_to.rb', line 73

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?(:'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
end

Instance Attribute Details

#address1 ⇒ Object

First line of the billing street address. #### Tax Calculation Required for U.S. and Canadian taxes. Not applicable to international and value added taxes.



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

def address1
  @address1
end

#address2 ⇒ Object

Second line of the billing street address. #### Tax Calculation Optional for U.S. and Canadian taxes. Not applicable to international and value added taxes.



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

def address2
  @address2
end

#administrative_area ⇒ Object

Credit card billing state or province. #### Tax Calculation Required for U.S. and Canadian taxes. Not applicable to international and value added taxes.



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

def administrative_area
  @administrative_area
end

#country ⇒ Object

Credit card billing country. Use the [ISO Standard Country Codes](developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). If ‘orderInformation.shipTo.country` is not provided, `orderInformation.billTo.country` is used in its place. If `orderInformation.billTo.country` is set to `US` or `CA`, then `orderInformation.billTo.postalCode` and `orderInformation.billTo.administrativeArea` are also required. #### Tax Calculation Required for U.S., Canadian, international and value added taxes.



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

def country
  @country
end

#locality ⇒ Object

Credit card billing city. #### Tax Calculation Required for U.S. and Canadian taxes only. Not applicable to international and value added taxes.



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

def locality
  @locality
end

#postal_code ⇒ Object

Postal code for the billing address. The postal code must consist of 5 to 9 digits. If the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][4 digits] Example: 12345-6789 If the billing country is Canada, the 6-digit postal code must follow this format: [alpha][alpha] [numeric][numeric] Example: A1B 2C3 #### Tax Calculation Required for U.S. and Canadian taxes. Not applicable to international and value added taxes.



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

def postal_code
  @postal_code
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_bill_to.rb', line 36

def self.attribute_map
  {
    :'address1' => :'address1',
    :'address2' => :'address2',
    :'locality' => :'locality',
    :'administrative_area' => :'administrativeArea',
    :'postal_code' => :'postalCode',
    :'country' => :'country'
  }
end

.json_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_bill_to.rb', line 48

def self.json_map
  {
    :'address1' => :'address1',
    :'address2' => :'address2',
    :'locality' => :'locality',
    :'administrative_area' => :'administrative_area',
    :'postal_code' => :'postal_code',
    :'country' => :'country'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_bill_to.rb', line 60

def self.swagger_types
  {
    :'address1' => :'String',
    :'address2' => :'String',
    :'locality' => :'String',
    :'administrative_area' => :'String',
    :'postal_code' => :'String',
    :'country' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



155
156
157
158
159
160
161
162
163
164
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_bill_to.rb', line 155

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address1 == o.address1 &&
      address2 == o.address2 &&
      locality == o.locality &&
      administrative_area == o.administrative_area &&
      postal_code == o.postal_code &&
      country == o.country
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



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

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



268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_bill_to.rb', line 268

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



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_bill_to.rb', line 181

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


168
169
170
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_bill_to.rb', line 168

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



174
175
176
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_bill_to.rb', line 174

def hash
  [address1, address2, locality, administrative_area, postal_code, country].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



106
107
108
109
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_bill_to.rb', line 106

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



248
249
250
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_bill_to.rb', line 248

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



254
255
256
257
258
259
260
261
262
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_bill_to.rb', line 254

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



242
243
244
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_bill_to.rb', line 242

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



113
114
115
 
# File 'lib/cybersource_rest_client/models/vasv2tax_order_information_bill_to.rb', line 113

def valid?
  true
end