Class: CloudmersiveValidateApiClient::ValidateCountryResponse

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

Overview

Result of performing a country validation operation

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ValidateCountryResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

  if attributes.has_key?(:'Timezones')
    if (value = attributes[:'Timezones']).is_a?(Array)
      self.timezones = value
    end
  end

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

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

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

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

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

Instance Attribute Details

#country_full_name ⇒ Object

Full name of the country



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

def country_full_name
  @country_full_name
end

#currency_english_name ⇒ Object

Full name of the currency



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

def currency_english_name
  @currency_english_name
end

#currency_symbol ⇒ Object

Symbol associated with the currency



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

def currency_symbol
  @currency_symbol
end

#fips_two_letter_code ⇒ Object

Two-letter FIPS 10-4 country code



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

def fips_two_letter_code
  @fips_two_letter_code
end

#is_european_union_member ⇒ Object

True if this country is currently a member of the European Union (EU), false otherwise



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

def is_european_union_member
  @is_european_union_member
end

#iso_currency_code ⇒ Object

ISO 4217 currency three-letter code associated with the country



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

def iso_currency_code
  @iso_currency_code
end

#iso_two_letter_code ⇒ Object

Two-letter ISO 3166-1 country code



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

def iso_two_letter_code
  @iso_two_letter_code
end

#region ⇒ Object

Region (continent) in which the country is located; possible values are None, Europe, Americas, Asia, Africa, Oceania



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

def region
  @region
end

#subregion ⇒ Object

Subregion in which the country is located; possible values are None, NorthernEurope, WesternEurope, SouthernEurope, EasternEurope, CentralAmerica, NorthernAmerica, SouthAmerica, EasternAfrica, MiddleAfrica, NorthernAfrica , SouthernAfrica , WesternAfrica , CentralAsia , EasternAsia , SouthernAsia , SouthEasternAsia , WesternAsia , Southern , Middle , AustraliaandNewZealand , Melanesia , Polynesia , Micronesia , Caribbean,



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

def subregion
  @subregion
end

#successful ⇒ Object

True if successful, false otherwise



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

def successful
  @successful
end

#three_letter_code ⇒ Object

Three-letter ISO 3166-1 country code



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

def three_letter_code
  @three_letter_code
end

#timezones ⇒ Object

Time zones (IANA/Olsen) in the country



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

def timezones
  @timezones
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'successful' => :'Successful',
    :'country_full_name' => :'CountryFullName',
    :'iso_two_letter_code' => :'ISOTwoLetterCode',
    :'fips_two_letter_code' => :'FIPSTwoLetterCode',
    :'three_letter_code' => :'ThreeLetterCode',
    :'is_european_union_member' => :'IsEuropeanUnionMember',
    :'timezones' => :'Timezones',
    :'iso_currency_code' => :'ISOCurrencyCode',
    :'currency_symbol' => :'CurrencySymbol',
    :'currency_english_name' => :'CurrencyEnglishName',
    :'region' => :'Region',
    :'subregion' => :'Subregion'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'successful' => :'BOOLEAN',
    :'country_full_name' => :'String',
    :'iso_two_letter_code' => :'String',
    :'fips_two_letter_code' => :'String',
    :'three_letter_code' => :'String',
    :'is_european_union_member' => :'BOOLEAN',
    :'timezones' => :'Array<Timezone>',
    :'iso_currency_code' => :'String',
    :'currency_symbol' => :'String',
    :'currency_english_name' => :'String',
    :'region' => :'String',
    :'subregion' => :'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/validate_country_response.rb', line 164

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      successful == o.successful &&
      country_full_name == o.country_full_name &&
      iso_two_letter_code == o.iso_two_letter_code &&
      fips_two_letter_code == o.fips_two_letter_code &&
      three_letter_code == o.three_letter_code &&
      is_european_union_member == o.is_european_union_member &&
      timezones == o.timezones &&
      iso_currency_code == o.iso_currency_code &&
      currency_symbol == o.currency_symbol &&
      currency_english_name == o.currency_english_name &&
      region == o.region &&
      subregion == o.subregion
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/validate_country_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/validate_country_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/validate_country_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 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/validate_country_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/validate_country_response.rb', line 189

def hash
  [successful, country_full_name, iso_two_letter_code, fips_two_letter_code, three_letter_code, is_european_union_member, timezones, iso_currency_code, currency_symbol, currency_english_name, region, subregion].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/validate_country_response.rb', line 151

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



263
264
265
 
# File 'lib/cloudmersive-validate-api-client/models/validate_country_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/validate_country_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/validate_country_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/validate_country_response.rb', line 158

def valid?
  true
end