Class: NuvemfiscalSdkRuby::DistribuicaoNfeEvento

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DistribuicaoNfeEvento

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

Instance Attribute Details

#ambiente ⇒ Object

Identificação do ambiente.



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

def ambiente
  @ambiente
end

#chave_acesso ⇒ Object

Chave de Acesso do documento vinculado ao evento.



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

def chave_acesso
  @chave_acesso
end

#codigo_status ⇒ Object

Código do status de registro do evento.



52
53
54
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_evento.rb', line 52

def codigo_status
  @codigo_status
end

#cpf_cnpj_autor ⇒ Object

CPF/CNPJ do autor do evento.



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

def cpf_cnpj_autor
  @cpf_cnpj_autor
end

#created_at ⇒ Object

Data/hora em que o evento foi criado na Nuvem Fiscal. Representado no formato <a href="en.wikipedia.org/wiki/ISO_8601" target="blank">‘ISO 8601`</a>.



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

def created_at
  @created_at
end

#data_evento ⇒ Object

Data e hora do Evento.



40
41
42
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_evento.rb', line 40

def data_evento
  @data_evento
end

#data_registro ⇒ Object

Data e hora do registro do evento pela SEFAZ.



49
50
51
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_evento.rb', line 49

def data_registro
  @data_registro
end

#id ⇒ Object

ID único gerado pela Nuvem Fiscal para este evento.



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

def id
  @id
end

#justificativa ⇒ Object

Justificativa para o desconhecimento ou não-realização da operação.



46
47
48
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_evento.rb', line 46

def justificativa
  @justificativa
end

#motivo_status ⇒ Object

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



55
56
57
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_evento.rb', line 55

def motivo_status
  @motivo_status
end

#numero_protocolo ⇒ Object

Número do Protocolo de registro do evento.



58
59
60
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_evento.rb', line 58

def numero_protocolo
  @numero_protocolo
end

#numero_sequencial ⇒ Object

Sequencial do evento para o mesmo tipo de evento.



43
44
45
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_evento.rb', line 43

def numero_sequencial
  @numero_sequencial
end

#status ⇒ Object

Status do Evento.



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

def status
  @status
end

#tipo_evento ⇒ Object

Tipo do evento vinculado.



37
38
39
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_evento.rb', line 37

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



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_evento.rb', line 310

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



103
104
105
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_evento.rb', line 103

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'created_at' => :'created_at',
    :'ambiente' => :'ambiente',
    :'status' => :'status',
    :'cpf_cnpj_autor' => :'cpf_cnpj_autor',
    :'chave_acesso' => :'chave_acesso',
    :'tipo_evento' => :'tipo_evento',
    :'data_evento' => :'data_evento',
    :'numero_sequencial' => :'numero_sequencial',
    :'justificativa' => :'justificativa',
    :'data_registro' => :'data_registro',
    :'codigo_status' => :'codigo_status',
    :'motivo_status' => :'motivo_status',
    :'numero_protocolo' => :'numero_protocolo'
  }
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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_evento.rb', line 286

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



128
129
130
131
132
133
134
135
136
137
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_evento.rb', line 128

def self.openapi_nullable
  Set.new([
    :'numero_sequencial',
    :'justificativa',
    :'data_registro',
    :'codigo_status',
    :'motivo_status',
    :'numero_protocolo'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_evento.rb', line 108

def self.openapi_types
  {
    :'id' => :'String',
    :'created_at' => :'Time',
    :'ambiente' => :'String',
    :'status' => :'String',
    :'cpf_cnpj_autor' => :'String',
    :'chave_acesso' => :'String',
    :'tipo_evento' => :'String',
    :'data_evento' => :'Time',
    :'numero_sequencial' => :'Integer',
    :'justificativa' => :'String',
    :'data_registro' => :'Time',
    :'codigo_status' => :'Integer',
    :'motivo_status' => :'String',
    :'numero_protocolo' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_evento.rb', line 252

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created_at == o.created_at &&
      ambiente == o.ambiente &&
      status == o.status &&
      cpf_cnpj_autor == o.cpf_cnpj_autor &&
      chave_acesso == o.chave_acesso &&
      tipo_evento == o.tipo_evento &&
      data_evento == o.data_evento &&
      numero_sequencial == o.numero_sequencial &&
      justificativa == o.justificativa &&
      data_registro == o.data_registro &&
      codigo_status == o.codigo_status &&
      motivo_status == o.motivo_status &&
      numero_protocolo == o.numero_protocolo
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



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_evento.rb', line 381

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


273
274
275
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_evento.rb', line 273

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



279
280
281
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_evento.rb', line 279

def hash
  [id, created_at, ambiente, status, cpf_cnpj_autor, chave_acesso, tipo_evento, data_evento, numero_sequencial, justificativa, data_registro, codigo_status, motivo_status, numero_protocolo].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



213
214
215
216
217
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_evento.rb', line 213

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



357
358
359
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_evento.rb', line 357

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



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_evento.rb', line 363

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



351
352
353
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_evento.rb', line 351

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



221
222
223
224
225
226
227
228
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_evento.rb', line 221

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