Class: NuvemfiscalSdkRuby::NfeSefazInfNFe

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

Overview

Informações da Nota Fiscal eletrônica.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NfeSefazInfNFe

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

  if attributes.key?(:'aut_xml')
    if (value = attributes[:'aut_xml']).is_a?(Array)
      self.aut_xml = value
    end
  end

  if attributes.key?(:'det')
    if (value = attributes[:'det']).is_a?(Array)
      self.det = value
    end
  else
    self.det = nil
  end

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#aut_xml ⇒ Object

Returns the value of attribute aut_xml.



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

def aut_xml
  @aut_xml
end

#avulsa ⇒ Object

Returns the value of attribute avulsa.



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

def avulsa
  @avulsa
end

#cana ⇒ Object

Returns the value of attribute cana.



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

def cana
  @cana
end

#cobr ⇒ Object

Returns the value of attribute cobr.



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

def cobr
  @cobr
end

#compra ⇒ Object

Returns the value of attribute compra.



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

def compra
  @compra
end

#dest ⇒ Object

Returns the value of attribute dest.



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

def dest
  @dest
end

#det ⇒ Object

Returns the value of attribute det.



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

def det
  @det
end

#emit ⇒ Object

Returns the value of attribute emit.



27
28
29
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_inf_nfe.rb', line 27

def emit
  @emit
end

#entrega ⇒ Object

Returns the value of attribute entrega.



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

def entrega
  @entrega
end

#exporta ⇒ Object

Returns the value of attribute exporta.



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

def exporta
  @exporta
end

#id ⇒ Object

PL_005d - 11/08/09 - validação do Id. *Geramos automaticamente quando nenhum valor é informado.*



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

def id
  @id
end

#ide ⇒ Object

Returns the value of attribute ide.



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

def ide
  @ide
end

#inf_adic ⇒ Object

Returns the value of attribute inf_adic.



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

def inf_adic
  @inf_adic
end

#inf_intermed ⇒ Object

Returns the value of attribute inf_intermed.



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

def inf_intermed
  @inf_intermed
end

#inf_resp_tec ⇒ Object

Returns the value of attribute inf_resp_tec.



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

def inf_resp_tec
  @inf_resp_tec
end

#inf_solic_nff ⇒ Object

Returns the value of attribute inf_solic_nff.



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

def inf_solic_nff
  @inf_solic_nff
end

#pag ⇒ Object

Returns the value of attribute pag.



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

def pag
  @pag
end

#retirada ⇒ Object

Returns the value of attribute retirada.



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

def retirada
  @retirada
end

#total ⇒ Object

Returns the value of attribute total.



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

def total
  @total
end

#transp ⇒ Object

Returns the value of attribute transp.



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

def transp
  @transp
end

#versao ⇒ Object

Versão do leiaute (v4.00).



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

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



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_inf_nfe.rb', line 407

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



91
92
93
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_inf_nfe.rb', line 91

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_inf_nfe.rb', line 64

def self.attribute_map
  {
    :'versao' => :'versao',
    :'id' => :'Id',
    :'ide' => :'ide',
    :'emit' => :'emit',
    :'avulsa' => :'avulsa',
    :'dest' => :'dest',
    :'retirada' => :'retirada',
    :'entrega' => :'entrega',
    :'aut_xml' => :'autXML',
    :'det' => :'det',
    :'total' => :'total',
    :'transp' => :'transp',
    :'cobr' => :'cobr',
    :'pag' => :'pag',
    :'inf_intermed' => :'infIntermed',
    :'inf_adic' => :'infAdic',
    :'exporta' => :'exporta',
    :'compra' => :'compra',
    :'cana' => :'cana',
    :'inf_resp_tec' => :'infRespTec',
    :'inf_solic_nff' => :'infSolicNFF'
  }
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



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_inf_nfe.rb', line 383

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



123
124
125
126
127
128
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_inf_nfe.rb', line 123

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

.openapi_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_inf_nfe.rb', line 96

def self.openapi_types
  {
    :'versao' => :'String',
    :'id' => :'String',
    :'ide' => :'NfeSefazIde',
    :'emit' => :'NfeSefazEmit',
    :'avulsa' => :'NfeSefazAvulsa',
    :'dest' => :'NfeSefazDest',
    :'retirada' => :'NfeSefazLocal',
    :'entrega' => :'NfeSefazLocal',
    :'aut_xml' => :'Array<NfeSefazAutXML>',
    :'det' => :'Array<NfeSefazDet>',
    :'total' => :'NfeSefazTotal',
    :'transp' => :'NfeSefazTransp',
    :'cobr' => :'NfeSefazCobr',
    :'pag' => :'NfeSefazPag',
    :'inf_intermed' => :'NfeSefazInfIntermed',
    :'inf_adic' => :'NfeSefazInfAdic',
    :'exporta' => :'NfeSefazExporta',
    :'compra' => :'NfeSefazCompra',
    :'cana' => :'NfeSefazCana',
    :'inf_resp_tec' => :'NfeSefazInfRespTec',
    :'inf_solic_nff' => :'NfeSefazInfSolicNFF'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      versao == o.versao &&
      id == o.id &&
      ide == o.ide &&
      emit == o.emit &&
      avulsa == o.avulsa &&
      dest == o.dest &&
      retirada == o.retirada &&
      entrega == o.entrega &&
      aut_xml == o.aut_xml &&
      det == o.det &&
      total == o.total &&
      transp == o.transp &&
      cobr == o.cobr &&
      pag == o.pag &&
      inf_intermed == o.inf_intermed &&
      inf_adic == o.inf_adic &&
      exporta == o.exporta &&
      compra == o.compra &&
      cana == o.cana &&
      inf_resp_tec == o.inf_resp_tec &&
      inf_solic_nff == o.inf_solic_nff
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



478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_inf_nfe.rb', line 478

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


370
371
372
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_inf_nfe.rb', line 370

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



376
377
378
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_inf_nfe.rb', line 376

def hash
  [versao, id, ide, emit, avulsa, dest, retirada, entrega, aut_xml, det, total, transp, cobr, pag, inf_intermed, inf_adic, exporta, compra, cana, inf_resp_tec, inf_solic_nff].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



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_inf_nfe.rb', line 250

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

  if @emit.nil?
    invalid_properties.push('invalid value for "emit", emit cannot be nil.')
  end

  if !@aut_xml.nil? && @aut_xml.length > 10
    invalid_properties.push('invalid value for "aut_xml", number of items must be less than or equal to 10.')
  end

  if @det.nil?
    invalid_properties.push('invalid value for "det", det cannot be nil.')
  end

  if @det.length > 990
    invalid_properties.push('invalid value for "det", number of items must be less than or equal to 990.')
  end

  if @det.length < 1
    invalid_properties.push('invalid value for "det", number of items must be greater than or equal to 1.')
  end

  if @total.nil?
    invalid_properties.push('invalid value for "total", total cannot be nil.')
  end

  if @transp.nil?
    invalid_properties.push('invalid value for "transp", transp cannot be nil.')
  end

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



454
455
456
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_inf_nfe.rb', line 454

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



460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_inf_nfe.rb', line 460

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



448
449
450
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_inf_nfe.rb', line 448

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



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_inf_nfe.rb', line 294

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @ide.nil?
  return false if @emit.nil?
  return false if !@aut_xml.nil? && @aut_xml.length > 10
  return false if @det.nil?
  return false if @det.length > 990
  return false if @det.length < 1
  return false if @total.nil?
  return false if @transp.nil?
  return false if @pag.nil?
  true
end