Class: TripletexApi::Country

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_api/models/country.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Country

Initializes the object

Parameters:

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

    Model attributes in the form of hash



68
69
70
71
72
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
103
104
105
106
107
108
# File 'lib/tripletex_api/models/country.rb', line 68

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#changesObject

Returns the value of attribute changes.



22
23
24
# File 'lib/tripletex_api/models/country.rb', line 22

def changes
  @changes
end

#idObject

Returns the value of attribute id.



18
19
20
# File 'lib/tripletex_api/models/country.rb', line 18

def id
  @id
end

#iso_alpha2_codeObject

The ISO 3166-1 Alpha2 code of the country (2 letters). en.wikipedia.org/wiki/ISO_3166-1



29
30
31
# File 'lib/tripletex_api/models/country.rb', line 29

def iso_alpha2_code
  @iso_alpha2_code
end

#iso_alpha3_codeObject

The ISO 3166-1 Alpha3 code of the country (3 letters). en.wikipedia.org/wiki/ISO_3166-1



32
33
34
# File 'lib/tripletex_api/models/country.rb', line 32

def iso_alpha3_code
  @iso_alpha3_code
end

#iso_numeric_codeObject

The ISO 3166-1 numeric code of the country (3 digits). en.wikipedia.org/wiki/ISO_3166-1



35
36
37
# File 'lib/tripletex_api/models/country.rb', line 35

def iso_numeric_code
  @iso_numeric_code
end

#nameObject

Returns the value of attribute name.



26
27
28
# File 'lib/tripletex_api/models/country.rb', line 26

def name
  @name
end

#urlObject

Returns the value of attribute url.



24
25
26
# File 'lib/tripletex_api/models/country.rb', line 24

def url
  @url
end

#versionObject

Returns the value of attribute version.



20
21
22
# File 'lib/tripletex_api/models/country.rb', line 20

def version
  @version
end

Class Method Details

.attribute_mapObject

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



39
40
41
42
43
44
45
46
47
48
49
50
# File 'lib/tripletex_api/models/country.rb', line 39

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'changes' => :'changes',
    :'url' => :'url',
    :'name' => :'name',
    :'iso_alpha2_code' => :'isoAlpha2Code',
    :'iso_alpha3_code' => :'isoAlpha3Code',
    :'iso_numeric_code' => :'isoNumericCode'
  }
end

.swagger_typesObject

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
64
# File 'lib/tripletex_api/models/country.rb', line 53

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'changes' => :'Array<Change>',
    :'url' => :'String',
    :'name' => :'String',
    :'iso_alpha2_code' => :'String',
    :'iso_alpha3_code' => :'String',
    :'iso_numeric_code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



141
142
143
144
145
146
147
148
149
150
151
152
# File 'lib/tripletex_api/models/country.rb', line 141

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      version == o.version &&
      changes == o.changes &&
      url == o.url &&
      name == o.name &&
      iso_alpha2_code == o.iso_alpha2_code &&
      iso_alpha3_code == o.iso_alpha3_code &&
      iso_numeric_code == o.iso_numeric_code
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



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
226
# File 'lib/tripletex_api/models/country.rb', line 190

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



256
257
258
259
260
261
262
263
264
265
266
267
268
# File 'lib/tripletex_api/models/country.rb', line 256

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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
# File 'lib/tripletex_api/models/country.rb', line 169

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


156
157
158
# File 'lib/tripletex_api/models/country.rb', line 156

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



162
163
164
# File 'lib/tripletex_api/models/country.rb', line 162

def hash
  [id, version, changes, url, name, iso_alpha2_code, iso_alpha3_code, iso_numeric_code].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



112
113
114
115
116
117
118
119
# File 'lib/tripletex_api/models/country.rb', line 112

def list_invalid_properties
  invalid_properties = Array.new
  if !@iso_alpha3_code.nil? && @iso_alpha3_code.to_s.length > 3
    invalid_properties.push("invalid value for 'iso_alpha3_code', the character length must be smaller than or equal to 3.")
  end

  return 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



236
237
238
# File 'lib/tripletex_api/models/country.rb', line 236

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



242
243
244
245
246
247
248
249
250
# File 'lib/tripletex_api/models/country.rb', line 242

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



230
231
232
# File 'lib/tripletex_api/models/country.rb', line 230

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



123
124
125
126
# File 'lib/tripletex_api/models/country.rb', line 123

def valid?
  return false if !@iso_alpha3_code.nil? && @iso_alpha3_code.to_s.length > 3
  return true
end