Class: NuvemfiscalSdkRuby::CteSefazEndereco

Inherits:
Object
  • Object
show all
Defined in:
lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_endereco.rb

Overview

Dados do endereço.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CteSefazEndereco

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_endereco.rb', line 104

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `NuvemfiscalSdkRuby::CteSefazEndereco` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `NuvemfiscalSdkRuby::CteSefazEndereco`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'x_lgr')
    self.x_lgr = attributes[:'x_lgr']
  else
    self.x_lgr = nil
  end

  if attributes.key?(:'nro')
    self.nro = attributes[:'nro']
  else
    self.nro = nil
  end

  if attributes.key?(:'x_cpl')
    self.x_cpl = attributes[:'x_cpl']
  end

  if attributes.key?(:'x_bairro')
    self.x_bairro = attributes[:'x_bairro']
  else
    self.x_bairro = nil
  end

  if attributes.key?(:'c_mun')
    self.c_mun = attributes[:'c_mun']
  else
    self.c_mun = nil
  end

  if attributes.key?(:'x_mun')
    self.x_mun = attributes[:'x_mun']
  else
    self.x_mun = nil
  end

  if attributes.key?(:'cep')
    self.cep = attributes[:'cep']
  end

  if attributes.key?(:'uf')
    self.uf = attributes[:'uf']
  else
    self.uf = nil
  end

  if attributes.key?(:'c_pais')
    self.c_pais = attributes[:'c_pais']
  end

  if attributes.key?(:'x_pais')
    self.x_pais = attributes[:'x_pais']
  end
end

Instance Attribute Details

#c_mun ⇒ Object

Código do município (utilizar a tabela do IBGE). Informar 9999999 para operações com o exterior.



32
33
34
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_endereco.rb', line 32

def c_mun
  @c_mun
end

#c_pais ⇒ Object

Código do país. Utilizar a tabela do BACEN.



44
45
46
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_endereco.rb', line 44

def c_pais
  @c_pais
end

#cep ⇒ Object

CEP. Informar os zeros não significativos.



38
39
40
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_endereco.rb', line 38

def cep
  @cep
end

#nro ⇒ Object

Número.



23
24
25
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_endereco.rb', line 23

def nro
  @nro
end

#uf ⇒ Object

Sigla da UF. Informar EX para operações com o exterior.



41
42
43
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_endereco.rb', line 41

def uf
  @uf
end

#x_bairro ⇒ Object

Bairro.



29
30
31
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_endereco.rb', line 29

def x_bairro
  @x_bairro
end

#x_cpl ⇒ Object

Complemento.



26
27
28
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_endereco.rb', line 26

def x_cpl
  @x_cpl
end

#x_lgr ⇒ Object

Logradouro.



20
21
22
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_endereco.rb', line 20

def x_lgr
  @x_lgr
end

#x_mun ⇒ Object

Nome do município. Informar EXTERIOR para operações com o exterior.



35
36
37
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_endereco.rb', line 35

def x_mun
  @x_mun
end

#x_pais ⇒ Object

Nome do país.



47
48
49
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_endereco.rb', line 47

def x_pais
  @x_pais
end

Class Method Details

._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



385
386
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
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_endereco.rb', line 385

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = NuvemfiscalSdkRuby.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



66
67
68
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_endereco.rb', line 66

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_endereco.rb', line 50

def self.attribute_map
  {
    :'x_lgr' => :'xLgr',
    :'nro' => :'nro',
    :'x_cpl' => :'xCpl',
    :'x_bairro' => :'xBairro',
    :'c_mun' => :'cMun',
    :'x_mun' => :'xMun',
    :'cep' => :'CEP',
    :'uf' => :'UF',
    :'c_pais' => :'cPais',
    :'x_pais' => :'xPais'
  }
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



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_endereco.rb', line 361

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_endereco.rb', line 87

def self.openapi_nullable
  Set.new([
    :'x_lgr',
    :'nro',
    :'x_cpl',
    :'x_bairro',
    :'c_mun',
    :'x_mun',
    :'cep',
    :'uf',
    :'c_pais',
    :'x_pais'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_endereco.rb', line 71

def self.openapi_types
  {
    :'x_lgr' => :'String',
    :'nro' => :'String',
    :'x_cpl' => :'String',
    :'x_bairro' => :'String',
    :'c_mun' => :'String',
    :'x_mun' => :'String',
    :'cep' => :'String',
    :'uf' => :'String',
    :'c_pais' => :'String',
    :'x_pais' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_endereco.rb', line 331

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      x_lgr == o.x_lgr &&
      nro == o.nro &&
      x_cpl == o.x_cpl &&
      x_bairro == o.x_bairro &&
      c_mun == o.c_mun &&
      x_mun == o.x_mun &&
      cep == o.cep &&
      uf == o.uf &&
      c_pais == o.c_pais &&
      x_pais == o.x_pais
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



456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_endereco.rb', line 456

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


348
349
350
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_endereco.rb', line 348

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



354
355
356
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_endereco.rb', line 354

def hash
  [x_lgr, nro, x_cpl, x_bairro, c_mun, x_mun, cep, uf, c_pais, x_pais].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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
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
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_endereco.rb', line 172

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @x_lgr.to_s.length > 255
    invalid_properties.push('invalid value for "x_lgr", the character length must be smaller than or equal to 255.')
  end

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

  if @nro.to_s.length > 60
    invalid_properties.push('invalid value for "nro", the character length must be smaller than or equal to 60.')
  end

  if @nro.to_s.length < 1
    invalid_properties.push('invalid value for "nro", the character length must be great than or equal to 1.')
  end

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

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

  if @x_bairro.to_s.length > 60
    invalid_properties.push('invalid value for "x_bairro", the character length must be smaller than or equal to 60.')
  end

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

  if @x_mun.to_s.length > 60
    invalid_properties.push('invalid value for "x_mun", the character length must be smaller than or equal to 60.')
  end

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

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

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

  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



432
433
434
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_endereco.rb', line 432

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



438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_endereco.rb', line 438

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



426
427
428
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_endereco.rb', line 426

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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_endereco.rb', line 228

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @x_lgr.to_s.length > 255
  return false if @x_lgr.to_s.length < 2
  return false if @nro.to_s.length > 60
  return false if @nro.to_s.length < 1
  return false if !@x_cpl.nil? && @x_cpl.to_s.length > 60
  return false if !@x_cpl.nil? && @x_cpl.to_s.length < 1
  return false if @x_bairro.to_s.length > 60
  return false if @x_bairro.to_s.length < 2
  return false if @x_mun.to_s.length > 60
  return false if @x_mun.to_s.length < 2
  return false if !@x_pais.nil? && @x_pais.to_s.length > 60
  return false if !@x_pais.nil? && @x_pais.to_s.length < 2
  true
end