Class: NuvemfiscalSdkRuby::DistribuicaoNfeDocumento

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DistribuicaoNfeDocumento

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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/distribuicao_nfe_documento.rb', line 170

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#chave_acesso ⇒ Object

Chave de Acesso da NF-e.



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

def chave_acesso
  @chave_acesso
end

#created_at ⇒ Object

Data/hora em que o documento 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_documento.rb', line 22

def created_at
  @created_at
end

#data_evento ⇒ Object

Data e hora do evento.



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

def data_evento
  @data_evento
end

#data_recebimento ⇒ Object

Data e hora de autorização do evento.



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

def data_recebimento
  @data_recebimento
end

#digest_value ⇒ Object

Digest Value da NF-e processada. Utilizado para conferir a integridade da NF-e original.



61
62
63
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_documento.rb', line 61

def digest_value
  @digest_value
end

#emitente_cpf_cnpj ⇒ Object

CPF/CNPJ do emitente.



64
65
66
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_documento.rb', line 64

def emitente_cpf_cnpj
  @emitente_cpf_cnpj
end

#emitente_inscricao_estadual ⇒ Object

Inscrição Estadual do emitente.



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

def emitente_inscricao_estadual
  @emitente_inscricao_estadual
end

#emitente_nome_razao_social ⇒ Object

Nome ou Razão Social do emitente.



67
68
69
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_documento.rb', line 67

def emitente_nome_razao_social
  @emitente_nome_razao_social
end

#id ⇒ Object

ID único gerado pela Nuvem Fiscal para identificar o documento.



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

def id
  @id
end

#nsu ⇒ Object

NSU do documento fiscal.



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

def nsu
  @nsu
end

#numero_protocolo ⇒ Object

Número do protocolo de autorização.



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

def numero_protocolo
  @numero_protocolo
end

#numero_sequencial ⇒ Object

Número sequencial do evento para o mesmo tipo de evento.



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

def numero_sequencial
  @numero_sequencial
end

#resumo ⇒ Object

Indica se o documento distribuído está em sua forma resumida.



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

def resumo
  @resumo
end

#schema ⇒ Object

Identificação do Schema XML que será utilizado para validar o XML existente no conteúdo da tag docZip. Vai identificar o tipo do documento e sua versão. Exemplos: resNFe_v1.00.xsd, procNFe_v3.10.xsd, resEvento_1.00.xsd, procEventoNFe_v1.00.xsd.



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

def schema
  @schema
end

#tipo_documento ⇒ Object

Tipo do documento de interesse da pessoa ou empresa.



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

def tipo_documento
  @tipo_documento
end

#tipo_evento ⇒ Object

Tipo do evento.



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

def tipo_evento
  @tipo_evento
end

#tipo_nfe ⇒ Object

Tipo da NF-e (0 - entrada; 1 - saída).



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

def tipo_nfe
  @tipo_nfe
end

#valor_nfe ⇒ Object

Valor total da NF-e.



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

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



361
362
363
364
365
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
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_documento.rb', line 361

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



119
120
121
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_documento.rb', line 119

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

def self.attribute_map
  {
    :'id' => :'id',
    :'created_at' => :'created_at',
    :'nsu' => :'nsu',
    :'schema' => :'schema',
    :'tipo_documento' => :'tipo_documento',
    :'chave_acesso' => :'chave_acesso',
    :'resumo' => :'resumo',
    :'tipo_evento' => :'tipo_evento',
    :'numero_sequencial' => :'numero_sequencial',
    :'data_evento' => :'data_evento',
    :'data_recebimento' => :'data_recebimento',
    :'numero_protocolo' => :'numero_protocolo',
    :'tipo_nfe' => :'tipo_nfe',
    :'valor_nfe' => :'valor_nfe',
    :'digest_value' => :'digest_value',
    :'emitente_cpf_cnpj' => :'emitente_cpf_cnpj',
    :'emitente_nome_razao_social' => :'emitente_nome_razao_social',
    :'emitente_inscricao_estadual' => :'emitente_inscricao_estadual'
  }
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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_documento.rb', line 337

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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_documento.rb', line 148

def self.openapi_nullable
  Set.new([
    :'nsu',
    :'tipo_documento',
    :'chave_acesso',
    :'resumo',
    :'tipo_evento',
    :'numero_sequencial',
    :'data_evento',
    :'data_recebimento',
    :'numero_protocolo',
    :'tipo_nfe',
    :'valor_nfe',
    :'digest_value',
    :'emitente_cpf_cnpj',
    :'emitente_nome_razao_social',
    :'emitente_inscricao_estadual'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_documento.rb', line 124

def self.openapi_types
  {
    :'id' => :'String',
    :'created_at' => :'Time',
    :'nsu' => :'Integer',
    :'schema' => :'String',
    :'tipo_documento' => :'String',
    :'chave_acesso' => :'String',
    :'resumo' => :'Boolean',
    :'tipo_evento' => :'String',
    :'numero_sequencial' => :'Integer',
    :'data_evento' => :'Time',
    :'data_recebimento' => :'Time',
    :'numero_protocolo' => :'String',
    :'tipo_nfe' => :'Integer',
    :'valor_nfe' => :'Float',
    :'digest_value' => :'String',
    :'emitente_cpf_cnpj' => :'String',
    :'emitente_nome_razao_social' => :'String',
    :'emitente_inscricao_estadual' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_documento.rb', line 299

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created_at == o.created_at &&
      nsu == o.nsu &&
      schema == o.schema &&
      tipo_documento == o.tipo_documento &&
      chave_acesso == o.chave_acesso &&
      resumo == o.resumo &&
      tipo_evento == o.tipo_evento &&
      numero_sequencial == o.numero_sequencial &&
      data_evento == o.data_evento &&
      data_recebimento == o.data_recebimento &&
      numero_protocolo == o.numero_protocolo &&
      tipo_nfe == o.tipo_nfe &&
      valor_nfe == o.valor_nfe &&
      digest_value == o.digest_value &&
      emitente_cpf_cnpj == o.emitente_cpf_cnpj &&
      emitente_nome_razao_social == o.emitente_nome_razao_social &&
      emitente_inscricao_estadual == o.emitente_inscricao_estadual
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



432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_documento.rb', line 432

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


324
325
326
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_documento.rb', line 324

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



330
331
332
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_documento.rb', line 330

def hash
  [id, created_at, nsu, schema, tipo_documento, chave_acesso, resumo, tipo_evento, numero_sequencial, data_evento, data_recebimento, numero_protocolo, tipo_nfe, valor_nfe, digest_value, emitente_cpf_cnpj, emitente_nome_razao_social, emitente_inscricao_estadual].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
267
268
269
270
271
272
273
274
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_documento.rb', line 262

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @schema.nil?
    invalid_properties.push('invalid value for "schema", schema cannot be nil.')
  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



408
409
410
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_documento.rb', line 408

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



414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_documento.rb', line 414

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



402
403
404
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_documento.rb', line 402

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



278
279
280
281
282
283
284
285
 
# File 'lib/nuvemfiscal_sdk_ruby/models/distribuicao_nfe_documento.rb', line 278

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @schema.nil?
  tipo_documento_validator = EnumAttributeValidator.new('String', ["nota", "evento"])
  return false unless tipo_documento_validator.valid?(@tipo_documento)
  true
end