Class: NuvemfiscalSdkRuby::NfeSefazAvulsa

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

Overview

Emissão de avulsa, informar os dados do Fisco emitente.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NfeSefazAvulsa

Initializes the object

Parameters:

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

    Model attributes in the form of hash



110
111
112
113
114
115
116
117
118
119
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
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_avulsa.rb', line 110

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#cnpj ⇒ Object

CNPJ do Órgão emissor.



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

def cnpj
  @cnpj
end

#d_emi ⇒ Object

Data de emissão do DAR (AAAA-MM-DD).



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

def d_emi
  @d_emi
end

#d_pag ⇒ Object

Data de pagamento do DAR (AAAA-MM-DD).



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

def d_pag
  @d_pag
end

#fone ⇒ Object

Telefone.



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

def fone
  @fone
end

#matr ⇒ Object

Matrícula do agente.



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

def matr
  @matr
end

#n_dar ⇒ Object

Número do Documento de Arrecadação de Receita.



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

def n_dar
  @n_dar
end

#rep_emi ⇒ Object

Repartição Fiscal emitente.



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

def rep_emi
  @rep_emi
end

#uf ⇒ Object

Sigla da Unidade da Federação.



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

def uf
  @uf
end

#v_dar ⇒ Object

Valor Total constante no DAR.



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

def v_dar
  @v_dar
end

#x_agente ⇒ Object

Nome do agente.



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

def x_agente
  @x_agente
end

#x_orgao ⇒ Object

Órgão emitente.



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

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



402
403
404
405
406
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
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_avulsa.rb', line 402

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_avulsa.rb', line 53

def self.attribute_map
  {
    :'cnpj' => :'CNPJ',
    :'x_orgao' => :'xOrgao',
    :'matr' => :'matr',
    :'x_agente' => :'xAgente',
    :'fone' => :'fone',
    :'uf' => :'UF',
    :'n_dar' => :'nDAR',
    :'d_emi' => :'dEmi',
    :'v_dar' => :'vDAR',
    :'rep_emi' => :'repEmi',
    :'d_pag' => :'dPag'
  }
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



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_avulsa.rb', line 378

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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_avulsa.rb', line 92

def self.openapi_nullable
  Set.new([
    :'cnpj',
    :'x_orgao',
    :'matr',
    :'x_agente',
    :'fone',
    :'uf',
    :'n_dar',
    :'d_emi',
    :'v_dar',
    :'rep_emi',
    :'d_pag'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_avulsa.rb', line 75

def self.openapi_types
  {
    :'cnpj' => :'String',
    :'x_orgao' => :'String',
    :'matr' => :'String',
    :'x_agente' => :'String',
    :'fone' => :'String',
    :'uf' => :'String',
    :'n_dar' => :'String',
    :'d_emi' => :'Date',
    :'v_dar' => :'Float',
    :'rep_emi' => :'String',
    :'d_pag' => :'Date'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_avulsa.rb', line 347

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cnpj == o.cnpj &&
      x_orgao == o.x_orgao &&
      matr == o.matr &&
      x_agente == o.x_agente &&
      fone == o.fone &&
      uf == o.uf &&
      n_dar == o.n_dar &&
      d_emi == o.d_emi &&
      v_dar == o.v_dar &&
      rep_emi == o.rep_emi &&
      d_pag == o.d_pag
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



473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_avulsa.rb', line 473

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


365
366
367
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_avulsa.rb', line 365

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



371
372
373
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_avulsa.rb', line 371

def hash
  [cnpj, x_orgao, matr, x_agente, fone, uf, n_dar, d_emi, v_dar, rep_emi, d_pag].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



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @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 @x_orgao.to_s.length > 60
    invalid_properties.push('invalid value for "x_orgao", the character length must be smaller than or equal to 60.')
  end

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

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

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

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

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

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

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

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

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

  if @rep_emi.to_s.length < 1
    invalid_properties.push('invalid value for "rep_emi", the character length must be great 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



449
450
451
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_avulsa.rb', line 449

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



455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_avulsa.rb', line 455

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



443
444
445
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_avulsa.rb', line 443

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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_avulsa.rb', line 238

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @cnpj.to_s.length > 14
  return false if @x_orgao.to_s.length > 60
  return false if @x_orgao.to_s.length < 1
  return false if @matr.to_s.length > 60
  return false if @matr.to_s.length < 1
  return false if @x_agente.to_s.length > 60
  return false if @x_agente.to_s.length < 1
  return false if !@n_dar.nil? && @n_dar.to_s.length > 60
  return false if !@n_dar.nil? && @n_dar.to_s.length < 1
  return false if !@v_dar.nil? && @v_dar < 0
  return false if @rep_emi.to_s.length > 60
  return false if @rep_emi.to_s.length < 1
  true
end