Class: NuvemfiscalSdkRuby::NfeSefazDI

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

Overview

Delcaração de Importação (NT 2011/004).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NfeSefazDI

Initializes the object

Parameters:

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

    Model attributes in the form of hash



120
121
122
123
124
125
126
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
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
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_di.rb', line 120

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#adi ⇒ Object

Returns the value of attribute adi.



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

def adi
  @adi
end

#c_exportador ⇒ Object

Código do exportador (usado nos sistemas internos de informação do emitente da NF-e).



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

def c_exportador
  @c_exportador
end

#cnpj ⇒ Object

CNPJ do adquirente ou do encomendante.



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

def cnpj
  @cnpj
end

#cpf ⇒ Object

CPF do adquirente ou do encomendante.



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

def cpf
  @cpf
end

#d_desemb ⇒ Object

Data do desembaraço aduaneiro (AAAA-MM-DD).



32
33
34
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_di.rb', line 32

def d_desemb
  @d_desemb
end

#d_di ⇒ Object

Data de registro da DI/DSI/DA (AAAA-MM-DD).



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

def d_di
  @d_di
end

#n_di ⇒ Object

Número do Documento de Importação (DI, DSI, DIRE, DUImp) (NT2011/004).



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

def n_di
  @n_di
end

#tp_intermedio ⇒ Object

Forma de Importação quanto a intermediação * 1 - por conta propria * 2 - por conta e ordem * 3 - encomenda



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

def tp_intermedio
  @tp_intermedio
end

#tp_via_transp ⇒ Object

Via de transporte internacional informada na DI ou na Declaração Única de Importação (DUImp): * 1 - Maritima * 2 - Fluvial * 3 - Lacustre * 4 - Aerea * 5 - Postal * 6 - Ferroviaria * 7 - Rodoviaria * 8 - Conduto * 9 - Meios Proprios * 10 - Entrada/Saida Ficta * 11 - Courier * 12 - Em maos * 13 - Por reboque



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

def tp_via_transp
  @tp_via_transp
end

#uf_desemb ⇒ Object

UF onde ocorreu o desembaraço aduaneiro.



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

def uf_desemb
  @uf_desemb
end

#uf_terceiro ⇒ Object

Sigla da UF do adquirente ou do encomendante.



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

def uf_terceiro
  @uf_terceiro
end

#v_afrmm ⇒ Object

Valor Adicional ao frete para renovação de marinha mercante.



38
39
40
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_di.rb', line 38

def v_afrmm
  @v_afrmm
end

#x_loc_desemb ⇒ Object

Local do desembaraço aduaneiro.



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

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



430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_di.rb', line 430

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



77
78
79
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_di.rb', line 77

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_di.rb', line 58

def self.attribute_map
  {
    :'n_di' => :'nDI',
    :'d_di' => :'dDI',
    :'x_loc_desemb' => :'xLocDesemb',
    :'uf_desemb' => :'UFDesemb',
    :'d_desemb' => :'dDesemb',
    :'tp_via_transp' => :'tpViaTransp',
    :'v_afrmm' => :'vAFRMM',
    :'tp_intermedio' => :'tpIntermedio',
    :'cnpj' => :'CNPJ',
    :'cpf' => :'CPF',
    :'uf_terceiro' => :'UFTerceiro',
    :'c_exportador' => :'cExportador',
    :'adi' => :'adi'
  }
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



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_di.rb', line 406

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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_di.rb', line 101

def self.openapi_nullable
  Set.new([
    :'n_di',
    :'d_di',
    :'x_loc_desemb',
    :'uf_desemb',
    :'d_desemb',
    :'tp_via_transp',
    :'v_afrmm',
    :'tp_intermedio',
    :'cnpj',
    :'cpf',
    :'uf_terceiro',
    :'c_exportador',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'n_di' => :'String',
    :'d_di' => :'Date',
    :'x_loc_desemb' => :'String',
    :'uf_desemb' => :'String',
    :'d_desemb' => :'Date',
    :'tp_via_transp' => :'Integer',
    :'v_afrmm' => :'Float',
    :'tp_intermedio' => :'Integer',
    :'cnpj' => :'String',
    :'cpf' => :'String',
    :'uf_terceiro' => :'String',
    :'c_exportador' => :'String',
    :'adi' => :'Array<NfeSefazAdi>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_di.rb', line 373

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      n_di == o.n_di &&
      d_di == o.d_di &&
      x_loc_desemb == o.x_loc_desemb &&
      uf_desemb == o.uf_desemb &&
      d_desemb == o.d_desemb &&
      tp_via_transp == o.tp_via_transp &&
      v_afrmm == o.v_afrmm &&
      tp_intermedio == o.tp_intermedio &&
      cnpj == o.cnpj &&
      cpf == o.cpf &&
      uf_terceiro == o.uf_terceiro &&
      c_exportador == o.c_exportador &&
      adi == o.adi
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



501
502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_di.rb', line 501

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


393
394
395
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_di.rb', line 393

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



399
400
401
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_di.rb', line 399

def hash
  [n_di, d_di, x_loc_desemb, uf_desemb, d_desemb, tp_via_transp, v_afrmm, tp_intermedio, cnpj, cpf, uf_terceiro, c_exportador, adi].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



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
259
260
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_di.rb', line 208

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @n_di.to_s.length > 15
    invalid_properties.push('invalid value for "n_di", the character length must be smaller than or equal to 15.')
  end

  if @n_di.to_s.length < 1
    invalid_properties.push('invalid value for "n_di", the character length must be great than or equal to 1.')
  end

  if @x_loc_desemb.to_s.length > 60
    invalid_properties.push('invalid value for "x_loc_desemb", the character length must be smaller than or equal to 60.')
  end

  if @x_loc_desemb.to_s.length < 1
    invalid_properties.push('invalid value for "x_loc_desemb", the character length must be great than or equal to 1.')
  end

  if !@v_afrmm.nil? && @v_afrmm < 0
    invalid_properties.push('invalid value for "v_afrmm", must be greater than or equal to 0.')
  end

  if !@cnpj.nil? && @cnpj.to_s.length > 14
    invalid_properties.push('invalid value for "cnpj", the character length must be smaller than or equal to 14.')
  end

  if !@cpf.nil? && @cpf.to_s.length > 11
    invalid_properties.push('invalid value for "cpf", the character length must be smaller than or equal to 11.')
  end

  if @c_exportador.to_s.length > 60
    invalid_properties.push('invalid value for "c_exportador", the character length must be smaller than or equal to 60.')
  end

  if @c_exportador.to_s.length < 1
    invalid_properties.push('invalid value for "c_exportador", the character length must be great than or equal to 1.')
  end

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

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

  if @adi.length < 1
    invalid_properties.push('invalid value for "adi", number of items must be greater than or equal to 1.')
  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



477
478
479
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_di.rb', line 477

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



483
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_di.rb', line 483

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



471
472
473
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_di.rb', line 471

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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_di.rb', line 264

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @n_di.to_s.length > 15
  return false if @n_di.to_s.length < 1
  return false if @x_loc_desemb.to_s.length > 60
  return false if @x_loc_desemb.to_s.length < 1
  return false if !@v_afrmm.nil? && @v_afrmm < 0
  return false if !@cnpj.nil? && @cnpj.to_s.length > 14
  return false if !@cpf.nil? && @cpf.to_s.length > 11
  return false if @c_exportador.to_s.length > 60
  return false if @c_exportador.to_s.length < 1
  return false if @adi.nil?
  return false if @adi.length > 999
  return false if @adi.length < 1
  true
end