Class: CloudmersiveValidateApiClient::VatLookupResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VatLookupResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb', line 93

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#business_address ⇒ Object

Business address as a single string



31
32
33
 
# File 'lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb', line 31

def business_address
  @business_address
end

#business_building ⇒ Object

For the business address, the name of the building, house or structure if applicable, such as "Cloudmersive Building 2". This will often by null.



34
35
36
 
# File 'lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb', line 34

def business_building
  @business_building
end

#business_city ⇒ Object

For the business address, the city of the address.



43
44
45
 
# File 'lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb', line 43

def business_city
  @business_city
end

#business_country ⇒ Object

For the business address, country of the address, if present in the address. If not included in the address it will be null.



52
53
54
 
# File 'lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb', line 52

def business_country
  @business_country
end

#business_name ⇒ Object

Name of the business



28
29
30
 
# File 'lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb', line 28

def business_name
  @business_name
end

#business_postal_code ⇒ Object

For the business address, the postal code or zip code of the address.



49
50
51
 
# File 'lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb', line 49

def business_postal_code
  @business_postal_code
end

#business_state_or_province ⇒ Object

For the business address, the state or province of the address.



46
47
48
 
# File 'lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb', line 46

def business_state_or_province
  @business_state_or_province
end

#business_street ⇒ Object

For the business address, the name of the street or road of the address. For example, in the address "1600 Pennsylvania Avenue NW" the street number would be "Pennsylvania Avenue NW".



40
41
42
 
# File 'lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb', line 40

def business_street
  @business_street
end

#business_street_number ⇒ Object

For the business address, the street number or house number of the address. For example, in the address "1600 Pennsylvania Avenue NW" the street number would be "1600". This value will typically be populated for most addresses.



37
38
39
 
# File 'lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb', line 37

def business_street_number
  @business_street_number
end

#country_code ⇒ Object

Two-letter country code



19
20
21
 
# File 'lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb', line 19

def country_code
  @country_code
end

#is_valid ⇒ Object

True if the VAT code is valid, false otherwise



25
26
27
 
# File 'lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb', line 25

def is_valid
  @is_valid
end

#vat_number ⇒ Object

VAT number



22
23
24
 
# File 'lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb', line 22

def vat_number
  @vat_number
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb', line 56

def self.attribute_map
  {
    :'country_code' => :'CountryCode',
    :'vat_number' => :'VatNumber',
    :'is_valid' => :'IsValid',
    :'business_name' => :'BusinessName',
    :'business_address' => :'BusinessAddress',
    :'business_building' => :'BusinessBuilding',
    :'business_street_number' => :'BusinessStreetNumber',
    :'business_street' => :'BusinessStreet',
    :'business_city' => :'BusinessCity',
    :'business_state_or_province' => :'BusinessStateOrProvince',
    :'business_postal_code' => :'BusinessPostalCode',
    :'business_country' => :'BusinessCountry'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb', line 74

def self.swagger_types
  {
    :'country_code' => :'String',
    :'vat_number' => :'String',
    :'is_valid' => :'BOOLEAN',
    :'business_name' => :'String',
    :'business_address' => :'String',
    :'business_building' => :'String',
    :'business_street_number' => :'String',
    :'business_street' => :'String',
    :'business_city' => :'String',
    :'business_state_or_province' => :'String',
    :'business_postal_code' => :'String',
    :'business_country' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb', line 164

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      country_code == o.country_code &&
      vat_number == o.vat_number &&
      is_valid == o.is_valid &&
      business_name == o.business_name &&
      business_address == o.business_address &&
      business_building == o.business_building &&
      business_street_number == o.business_street_number &&
      business_street == o.business_street &&
      business_city == o.business_city &&
      business_state_or_province == o.business_state_or_province &&
      business_postal_code == o.business_postal_code &&
      business_country == o.business_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



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
 
# File 'lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb', line 217

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 = CloudmersiveValidateApiClient.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



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb', line 283

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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb', line 196

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


183
184
185
 
# File 'lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb', line 183

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



189
190
191
 
# File 'lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb', line 189

def hash
  [country_code, vat_number, is_valid, business_name, business_address, business_building, business_street_number, business_street, business_city, business_state_or_province, business_postal_code, business_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



151
152
153
154
 
# File 'lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb', line 151

def list_invalid_properties
  invalid_properties = Array.new
  return 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



263
264
265
 
# File 'lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb', line 263

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



269
270
271
272
273
274
275
276
277
 
# File 'lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb', line 269

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



257
258
259
 
# File 'lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb', line 257

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



158
159
160
 
# File 'lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb', line 158

def valid?
  return true
end