Class: NuvemfiscalSdkRuby::NfeSefazEmit

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

Overview

Identificação do emitente.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NfeSefazEmit

Initializes the object

Parameters:

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

    Model attributes in the form of hash



102
103
104
105
106
107
108
109
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
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_emit.rb', line 102

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

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

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

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

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

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

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

Instance Attribute Details

#cnaeObject

CNAE Fiscal. *Caso não seja informado, será utilizado o do cadastro da empresa.*



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

def cnae
  @cnae
end

#cnpjObject

Número do CNPJ do emitente. ***Obrigatório caso o emitente seja pessoa jurídica***.



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

def cnpj
  @cnpj
end

#cpfObject

Número do CPF do emitente. ***Obrigatorio caso o emitente seja pessoa física***.



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

def cpf
  @cpf
end

#crtObject

Código de Regime Tributário. Este campo será obrigatoriamente preenchido com: * 1 - Simples Nacional * 2 - Simples Nacional - excesso de sublimite de receita bruta * 3 - Regime Normal * 4 - Simples Nacional - Microempreendedor individual - MEI *Caso não seja informado, será utilizado o do cadastro da empresa.*



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

def crt
  @crt
end

#ender_emitObject

Returns the value of attribute ender_emit.



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

def ender_emit
  @ender_emit
end

#ieObject

Inscrição Estadual do Emitente. *Caso não seja informado, será utilizado o do cadastro da empresa.*



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

def ie
  @ie
end

#iestObject

Inscricao Estadual do Substituto Tributário. *Caso não seja informado, será utilizado o do cadastro da empresa.*



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

def iest
  @iest
end

#imObject

Inscrição Municipal. *Caso não seja informado, será utilizado o do cadastro da empresa.*



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

def im
  @im
end

#x_fantObject

Nome fantasia. *Caso não seja informado, será utilizado o do cadastro da empresa.*



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

def x_fant
  @x_fant
end

#x_nomeObject

Razão Social ou Nome do emitente. *Caso não seja informado, será utilizado o do cadastro da empresa.*



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

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



359
360
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
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_emit.rb', line 359

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_attributesObject

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_emit.rb', line 49

def self.attribute_map
  {
    :'cnpj' => :'CNPJ',
    :'cpf' => :'CPF',
    :'x_nome' => :'xNome',
    :'x_fant' => :'xFant',
    :'ender_emit' => :'enderEmit',
    :'ie' => :'IE',
    :'iest' => :'IEST',
    :'im' => :'IM',
    :'cnae' => :'CNAE',
    :'crt' => :'CRT'
  }
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



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

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_nullableObject

List of attributes with nullable: true



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

def self.openapi_nullable
  Set.new([
    :'cnpj',
    :'cpf',
    :'x_nome',
    :'x_fant',
    :'ie',
    :'iest',
    :'im',
    :'cnae',
    :'crt'
  ])
end

.openapi_typesObject

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_emit.rb', line 70

def self.openapi_types
  {
    :'cnpj' => :'String',
    :'cpf' => :'String',
    :'x_nome' => :'String',
    :'x_fant' => :'String',
    :'ender_emit' => :'NfeSefazEnderEmi',
    :'ie' => :'String',
    :'iest' => :'String',
    :'im' => :'String',
    :'cnae' => :'String',
    :'crt' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



305
306
307
308
309
310
311
312
313
314
315
316
317
318
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_emit.rb', line 305

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cnpj == o.cnpj &&
      cpf == o.cpf &&
      x_nome == o.x_nome &&
      x_fant == o.x_fant &&
      ender_emit == o.ender_emit &&
      ie == o.ie &&
      iest == o.iest &&
      im == o.im &&
      cnae == o.cnae &&
      crt == o.crt
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



430
431
432
433
434
435
436
437
438
439
440
441
442
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_emit.rb', line 430

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


322
323
324
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_emit.rb', line 322

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



328
329
330
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_emit.rb', line 328

def hash
  [cnpj, cpf, x_nome, x_fant, ender_emit, ie, iest, im, cnae, crt].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



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

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_fant.nil? && @x_fant.to_s.length > 60
    invalid_properties.push('invalid value for "x_fant", the character length must be smaller than or equal to 60.')
  end

  if !@x_fant.nil? && @x_fant.to_s.length < 1
    invalid_properties.push('invalid value for "x_fant", 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

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

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



406
407
408
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_emit.rb', line 406

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



412
413
414
415
416
417
418
419
420
421
422
423
424
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_emit.rb', line 412

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



400
401
402
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_emit.rb', line 400

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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_emit.rb', line 206

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_fant.nil? && @x_fant.to_s.length > 60
  return false if !@x_fant.nil? && @x_fant.to_s.length < 1
  return false if !@ie.nil? && @ie.to_s.length > 14
  return false if !@iest.nil? && @iest.to_s.length > 14
  return false if !@im.nil? && @im.to_s.length > 15
  return false if !@im.nil? && @im.to_s.length < 1
  true
end