Class: NuvemfiscalSdkRuby::DfeInutilizacao

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DfeInutilizacao

Initializes the object

Parameters:

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

    Model attributes in the form of hash



162
163
164
165
166
167
168
169
170
171
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
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
254
255
256
257
258
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 162

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `NuvemfiscalSdkRuby::DfeInutilizacao` 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::DfeInutilizacao`. 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?(:'cnpj')
    self.cnpj = attributes[:'cnpj']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#ambiente ⇒ Object

Identificação do ambiente.



36
37
38
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 36

def ambiente
  @ambiente
end

#ano ⇒ Object

Returns the value of attribute ano.



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

def ano
  @ano
end

#autor ⇒ Object

Returns the value of attribute autor.



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

def autor
  @autor
end

#chave_acesso ⇒ Object

Chave de Acesso do documento vinculado ao evento.



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

def chave_acesso
  @chave_acesso
end

#cnpj ⇒ Object

Returns the value of attribute cnpj.



18
19
20
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 18

def cnpj
  @cnpj
end

#codigo_mensagem ⇒ Object

Código da Mensagem.



65
66
67
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 65

def codigo_mensagem
  @codigo_mensagem
end

#codigo_status ⇒ Object

Código do status de registro do Evento.



56
57
58
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 56

def codigo_status
  @codigo_status
end

#data_evento ⇒ Object

Data e hora do Evento.



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

def data_evento
  @data_evento
end

#data_recebimento ⇒ Object

Data e hora do recebimento do Evento pela SEFAZ.



53
54
55
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 53

def data_recebimento
  @data_recebimento
end

#id ⇒ Object

ID único gerado pela Nuvem Fiscal para este evento.



33
34
35
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 33

def id
  @id
end

#justificativa ⇒ Object

Returns the value of attribute justificativa.



30
31
32
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 30

def justificativa
  @justificativa
end

#mensagem ⇒ Object

Mensagem da SEFAZ para o emissor.



68
69
70
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 68

def mensagem
  @mensagem
end

#modelo ⇒ Object

Returns the value of attribute modelo.



22
23
24
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 22

def modelo
  @modelo
end

#motivo_status ⇒ Object

Descrição literal do status do registro do Evento.



59
60
61
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 59

def motivo_status
  @motivo_status
end

#numero_final ⇒ Object

Returns the value of attribute numero_final.



28
29
30
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 28

def numero_final
  @numero_final
end

#numero_inicial ⇒ Object

Returns the value of attribute numero_inicial.



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

def numero_inicial
  @numero_inicial
end

#numero_protocolo ⇒ Object

Número do Protocolo de registro do Evento.



62
63
64
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 62

def numero_protocolo
  @numero_protocolo
end

#numero_sequencial ⇒ Object

Sequencial do evento para o mesmo tipo de evento.



50
51
52
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 50

def numero_sequencial
  @numero_sequencial
end

#serie ⇒ Object

Returns the value of attribute serie.



24
25
26
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 24

def serie
  @serie
end

#status ⇒ Object

Status do Evento.



39
40
41
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 39

def status
  @status
end

#tipo_evento ⇒ Object

Returns the value of attribute tipo_evento.



70
71
72
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 70

def tipo_evento
  @tipo_evento
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



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 366

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



122
123
124
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 122

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 95

def self.attribute_map
  {
    :'cnpj' => :'cnpj',
    :'ano' => :'ano',
    :'modelo' => :'modelo',
    :'serie' => :'serie',
    :'numero_inicial' => :'numero_inicial',
    :'numero_final' => :'numero_final',
    :'justificativa' => :'justificativa',
    :'id' => :'id',
    :'ambiente' => :'ambiente',
    :'status' => :'status',
    :'autor' => :'autor',
    :'chave_acesso' => :'chave_acesso',
    :'data_evento' => :'data_evento',
    :'numero_sequencial' => :'numero_sequencial',
    :'data_recebimento' => :'data_recebimento',
    :'codigo_status' => :'codigo_status',
    :'motivo_status' => :'motivo_status',
    :'numero_protocolo' => :'numero_protocolo',
    :'codigo_mensagem' => :'codigo_mensagem',
    :'mensagem' => :'mensagem',
    :'tipo_evento' => :'tipo_evento'
  }
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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 342

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



154
155
156
157
158
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 154

def self.openapi_nullable
  Set.new([
    :'data_recebimento',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 127

def self.openapi_types
  {
    :'cnpj' => :'String',
    :'ano' => :'Integer',
    :'modelo' => :'Integer',
    :'serie' => :'Integer',
    :'numero_inicial' => :'Integer',
    :'numero_final' => :'Integer',
    :'justificativa' => :'String',
    :'id' => :'String',
    :'ambiente' => :'String',
    :'status' => :'String',
    :'autor' => :'DfeAutorEvento',
    :'chave_acesso' => :'String',
    :'data_evento' => :'Time',
    :'numero_sequencial' => :'Integer',
    :'data_recebimento' => :'Time',
    :'codigo_status' => :'Integer',
    :'motivo_status' => :'String',
    :'numero_protocolo' => :'String',
    :'codigo_mensagem' => :'Integer',
    :'mensagem' => :'String',
    :'tipo_evento' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 301

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cnpj == o.cnpj &&
      ano == o.ano &&
      modelo == o.modelo &&
      serie == o.serie &&
      numero_inicial == o.numero_inicial &&
      numero_final == o.numero_final &&
      justificativa == o.justificativa &&
      id == o.id &&
      ambiente == o.ambiente &&
      status == o.status &&
      autor == o.autor &&
      chave_acesso == o.chave_acesso &&
      data_evento == o.data_evento &&
      numero_sequencial == o.numero_sequencial &&
      data_recebimento == o.data_recebimento &&
      codigo_status == o.codigo_status &&
      motivo_status == o.motivo_status &&
      numero_protocolo == o.numero_protocolo &&
      codigo_mensagem == o.codigo_mensagem &&
      mensagem == o.mensagem &&
      tipo_evento == o.tipo_evento
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



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

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


329
330
331
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 329

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



335
336
337
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 335

def hash
  [cnpj, ano, modelo, serie, numero_inicial, numero_final, justificativa, id, ambiente, status, autor, chave_acesso, data_evento, numero_sequencial, data_recebimento, codigo_status, motivo_status, numero_protocolo, codigo_mensagem, mensagem, tipo_evento].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



262
263
264
265
266
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 262

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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



413
414
415
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 413

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



419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 419

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



407
408
409
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 407

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



270
271
272
273
274
275
276
277
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_inutilizacao.rb', line 270

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  ambiente_validator = EnumAttributeValidator.new('String', ["homologacao", "producao"])
  return false unless ambiente_validator.valid?(@ambiente)
  status_validator = EnumAttributeValidator.new('String', ["pendente", "registrado", "rejeitado", "erro"])
  return false unless status_validator.valid?(@status)
  true
end