Class: NuvemfiscalSdkRuby::NfeSefazLocal

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

Overview

Identificação do local de retirada/entrega (informar apenas quando for diferente do endereço do remetente/destinatário)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NfeSefazLocal

Initializes the object



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#c_mun ⇒ Object

Código do município (utilizar a tabela do IBGE).



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

def c_mun
  @c_mun
end

#c_pais ⇒ Object

Código de Pais.



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

def c_pais
  @c_pais
end

#cep ⇒ Object

CEP.



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

def cep
  @cep
end

#cnpj ⇒ Object

CNPJ.



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

def cnpj
  @cnpj
end

#cpf ⇒ Object

CPF (v2.0).



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

def cpf
  @cpf
end

#email ⇒ Object

Informar o e-mail do expedidor/Recebedor. O campo pode ser utilizado para informar o e-mail de recepção da NF-e indicada pelo expedidor.



62
63
64
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_local.rb', line 62

def email
  @email
end

#fone ⇒ Object

Telefone, preencher com Código DDD + número do telefone , nas operações com exterior é permtido informar o código do país + código da localidade + número do telefone.



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

def fone
  @fone
end

#ie ⇒ Object

Inscrição Estadual (v2.0).



65
66
67
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_local.rb', line 65

def ie
  @ie
end

#nro ⇒ Object

Número.



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

def nro
  @nro
end

#uf ⇒ Object

Sigla da UF.



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

def uf
  @uf
end

#x_bairro ⇒ Object

Bairro.



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

def x_bairro
  @x_bairro
end

#x_cpl ⇒ Object

Complemento.



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

def x_cpl
  @x_cpl
end

#x_lgr ⇒ Object

Logradouro.



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

def x_lgr
  @x_lgr
end

#x_mun ⇒ Object

Nome do município.



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

def x_mun
  @x_mun
end

#x_nome ⇒ Object

Razão Social ou Nome do Expedidor/Recebedor.



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

def x_nome
  @x_nome
end

#x_pais ⇒ Object

Nome do país.



56
57
58
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_local.rb', line 56

def x_pais
  @x_pais
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_local.rb', line 544

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



90
91
92
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_local.rb', line 90

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'cnpj' => :'CNPJ',
    :'cpf' => :'CPF',
    :'x_nome' => :'xNome',
    :'x_lgr' => :'xLgr',
    :'nro' => :'nro',
    :'x_cpl' => :'xCpl',
    :'x_bairro' => :'xBairro',
    :'c_mun' => :'cMun',
    :'x_mun' => :'xMun',
    :'uf' => :'UF',
    :'cep' => :'CEP',
    :'c_pais' => :'cPais',
    :'x_pais' => :'xPais',
    :'fone' => :'fone',
    :'email' => :'email',
    :'ie' => :'IE'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_local.rb', line 520

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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_local.rb', line 117

def self.openapi_nullable
  Set.new([
    :'cnpj',
    :'cpf',
    :'x_nome',
    :'x_lgr',
    :'nro',
    :'x_cpl',
    :'x_bairro',
    :'c_mun',
    :'x_mun',
    :'uf',
    :'cep',
    :'c_pais',
    :'x_pais',
    :'fone',
    :'email',
    :'ie'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_local.rb', line 95

def self.openapi_types
  {
    :'cnpj' => :'String',
    :'cpf' => :'String',
    :'x_nome' => :'String',
    :'x_lgr' => :'String',
    :'nro' => :'String',
    :'x_cpl' => :'String',
    :'x_bairro' => :'String',
    :'c_mun' => :'String',
    :'x_mun' => :'String',
    :'uf' => :'String',
    :'cep' => :'String',
    :'c_pais' => :'String',
    :'x_pais' => :'String',
    :'fone' => :'String',
    :'email' => :'String',
    :'ie' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_local.rb', line 484

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cnpj == o.cnpj &&
      cpf == o.cpf &&
      x_nome == o.x_nome &&
      x_lgr == o.x_lgr &&
      nro == o.nro &&
      x_cpl == o.x_cpl &&
      x_bairro == o.x_bairro &&
      c_mun == o.c_mun &&
      x_mun == o.x_mun &&
      uf == o.uf &&
      cep == o.cep &&
      c_pais == o.c_pais &&
      x_pais == o.x_pais &&
      fone == o.fone &&
      email == o.email &&
      ie == o.ie
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



615
616
617
618
619
620
621
622
623
624
625
626
627
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_local.rb', line 615

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

See Also:

  • `==` method


507
508
509
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_local.rb', line 507

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



513
514
515
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_local.rb', line 513

def hash
  [cnpj, cpf, x_nome, x_lgr, nro, x_cpl, x_bairro, c_mun, x_mun, uf, cep, c_pais, x_pais, fone, email, ie].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



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
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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_local.rb', line 232

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



591
592
593
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_local.rb', line 591

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



597
598
599
600
601
602
603
604
605
606
607
608
609
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_local.rb', line 597

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



585
586
587
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_local.rb', line 585

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_local.rb', line 316

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@cnpj.nil? && @cnpj.to_s.length > 14
  return false if !@cpf.nil? && @cpf.to_s.length > 11
  return false if !@x_nome.nil? && @x_nome.to_s.length > 60
  return false if !@x_nome.nil? && @x_nome.to_s.length < 2
  return false if @x_lgr.to_s.length > 60
  return false if @x_lgr.to_s.length < 2
  return false if @nro.to_s.length > 60
  return false if @nro.to_s.length < 1
  return false if !@x_cpl.nil? && @x_cpl.to_s.length > 60
  return false if !@x_cpl.nil? && @x_cpl.to_s.length < 1
  return false if @x_bairro.to_s.length > 60
  return false if @x_bairro.to_s.length < 2
  return false if @x_mun.to_s.length > 60
  return false if @x_mun.to_s.length < 2
  return false if !@x_pais.nil? && @x_pais.to_s.length > 60
  return false if !@x_pais.nil? && @x_pais.to_s.length < 2
  return false if !@email.nil? && @email.to_s.length > 60
  return false if !@email.nil? && @email.to_s.length < 1
  return false if !@ie.nil? && @ie.to_s.length > 14
  true
end