Class: NuvemfiscalSdkRuby::MdfeEncerramento

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MdfeEncerramento

Initializes the object

Parameters:

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

    Model attributes in the form of hash



149
150
151
152
153
154
155
156
157
158
159
160
161
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
 
# File 'lib/nuvemfiscal_sdk_ruby/models/mdfe_encerramento.rb', line 149

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

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

  if attributes.key?(:'codigo_municipio')
    self.codigo_municipio = attributes[:'codigo_municipio']
  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.



31
32
33
 
# File 'lib/nuvemfiscal_sdk_ruby/models/mdfe_encerramento.rb', line 31

def ambiente
  @ambiente
end

#autor ⇒ Object

Returns the value of attribute autor.



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

def autor
  @autor
end

#chave_acesso ⇒ Object

Chave de Acesso do documento vinculado ao evento.



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

def chave_acesso
  @chave_acesso
end

#codigo_mensagem ⇒ Object

Código da Mensagem.



60
61
62
 
# File 'lib/nuvemfiscal_sdk_ruby/models/mdfe_encerramento.rb', line 60

def codigo_mensagem
  @codigo_mensagem
end

#codigo_municipio ⇒ Object

Código do Município de encerramento do manifesto.



25
26
27
 
# File 'lib/nuvemfiscal_sdk_ruby/models/mdfe_encerramento.rb', line 25

def codigo_municipio
  @codigo_municipio
end

#codigo_status ⇒ Object

Código do status de registro do Evento.



51
52
53
 
# File 'lib/nuvemfiscal_sdk_ruby/models/mdfe_encerramento.rb', line 51

def codigo_status
  @codigo_status
end

#data_encerramento ⇒ Object

Data que o manifesto foi encerrado.



19
20
21
 
# File 'lib/nuvemfiscal_sdk_ruby/models/mdfe_encerramento.rb', line 19

def data_encerramento
  @data_encerramento
end

#data_evento ⇒ Object

Data e hora do Evento.



42
43
44
 
# File 'lib/nuvemfiscal_sdk_ruby/models/mdfe_encerramento.rb', line 42

def data_evento
  @data_evento
end

#data_recebimento ⇒ Object

Data e hora do recebimento do Evento pela SEFAZ.



48
49
50
 
# File 'lib/nuvemfiscal_sdk_ruby/models/mdfe_encerramento.rb', line 48

def data_recebimento
  @data_recebimento
end

#id ⇒ Object

ID único gerado pela Nuvem Fiscal para este evento.



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

def id
  @id
end

#mensagem ⇒ Object

Mensagem da SEFAZ para o emissor.



63
64
65
 
# File 'lib/nuvemfiscal_sdk_ruby/models/mdfe_encerramento.rb', line 63

def mensagem
  @mensagem
end

#motivo_status ⇒ Object

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



54
55
56
 
# File 'lib/nuvemfiscal_sdk_ruby/models/mdfe_encerramento.rb', line 54

def motivo_status
  @motivo_status
end

#numero_protocolo ⇒ Object

Número do Protocolo de registro do Evento.



57
58
59
 
# File 'lib/nuvemfiscal_sdk_ruby/models/mdfe_encerramento.rb', line 57

def numero_protocolo
  @numero_protocolo
end

#numero_sequencial ⇒ Object

Sequencial do evento para o mesmo tipo de evento.



45
46
47
 
# File 'lib/nuvemfiscal_sdk_ruby/models/mdfe_encerramento.rb', line 45

def numero_sequencial
  @numero_sequencial
end

#status ⇒ Object

Status do Evento.



34
35
36
 
# File 'lib/nuvemfiscal_sdk_ruby/models/mdfe_encerramento.rb', line 34

def status
  @status
end

#tipo_evento ⇒ Object

Returns the value of attribute tipo_evento.



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

def tipo_evento
  @tipo_evento
end

#uf ⇒ Object

UF de encerramento do manifesto.



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

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



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/nuvemfiscal_sdk_ruby/models/mdfe_encerramento.rb', line 333

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



113
114
115
 
# File 'lib/nuvemfiscal_sdk_ruby/models/mdfe_encerramento.rb', line 113

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/nuvemfiscal_sdk_ruby/models/mdfe_encerramento.rb', line 90

def self.attribute_map
  {
    :'data_encerramento' => :'data_encerramento',
    :'uf' => :'uf',
    :'codigo_municipio' => :'codigo_municipio',
    :'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



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/nuvemfiscal_sdk_ruby/models/mdfe_encerramento.rb', line 309

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



141
142
143
144
145
 
# File 'lib/nuvemfiscal_sdk_ruby/models/mdfe_encerramento.rb', line 141

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

.openapi_types ⇒ Object

Attribute type mapping.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/nuvemfiscal_sdk_ruby/models/mdfe_encerramento.rb', line 118

def self.openapi_types
  {
    :'data_encerramento' => :'Date',
    :'uf' => :'String',
    :'codigo_municipio' => :'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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/nuvemfiscal_sdk_ruby/models/mdfe_encerramento.rb', line 272

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      data_encerramento == o.data_encerramento &&
      uf == o.uf &&
      codigo_municipio == o.codigo_municipio &&
      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



404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/nuvemfiscal_sdk_ruby/models/mdfe_encerramento.rb', line 404

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


296
297
298
 
# File 'lib/nuvemfiscal_sdk_ruby/models/mdfe_encerramento.rb', line 296

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



302
303
304
 
# File 'lib/nuvemfiscal_sdk_ruby/models/mdfe_encerramento.rb', line 302

def hash
  [data_encerramento, uf, codigo_municipio, 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



233
234
235
236
237
 
# File 'lib/nuvemfiscal_sdk_ruby/models/mdfe_encerramento.rb', line 233

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



380
381
382
 
# File 'lib/nuvemfiscal_sdk_ruby/models/mdfe_encerramento.rb', line 380

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



386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/nuvemfiscal_sdk_ruby/models/mdfe_encerramento.rb', line 386

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



374
375
376
 
# File 'lib/nuvemfiscal_sdk_ruby/models/mdfe_encerramento.rb', line 374

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



241
242
243
244
245
246
247
248
 
# File 'lib/nuvemfiscal_sdk_ruby/models/mdfe_encerramento.rb', line 241

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