Class: NuvemfiscalSdkRuby::DfeContribuinteInfCons

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

Overview

Dados do Resultado do Dados do Pedido de Consulta de cadastro de contribuintes.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DfeContribuinteInfCons

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#cnpj ⇒ Object

CNPJ do contribuinte.



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

def cnpj
  @cnpj
end

#codigo_status ⇒ Object

Código do status da mensagem enviada.



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

def codigo_status
  @codigo_status
end

#cpf ⇒ Object

CPF do contribuinte.



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

def cpf
  @cpf
end

#data_consulta ⇒ Object

Data da Consulta.



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

def data_consulta
  @data_consulta
end

#ie ⇒ Object

Inscrição Estadual do contribuinte.



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

def ie
  @ie
end

#informacoes_cadastrais ⇒ Object

Returns the value of attribute informacoes_cadastrais.



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

def informacoes_cadastrais
  @informacoes_cadastrais
end

#motivo_status ⇒ Object

Descrição literal do status do serviço solicitado.



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

def motivo_status
  @motivo_status
end

#uf ⇒ Object

sigla da UF consultada, utilizar SU para SUFRAMA.



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

def uf
  @uf
end

#uf_atendimento ⇒ Object

código da UF de atendimento.



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

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



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
313
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_contribuinte_inf_cons.rb', line 276

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_contribuinte_inf_cons.rb', line 46

def self.attribute_map
  {
    :'codigo_status' => :'codigo_status',
    :'motivo_status' => :'motivo_status',
    :'uf' => :'uf',
    :'ie' => :'ie',
    :'cnpj' => :'cnpj',
    :'cpf' => :'cpf',
    :'data_consulta' => :'data_consulta',
    :'uf_atendimento' => :'uf_atendimento',
    :'informacoes_cadastrais' => :'informacoes_cadastrais'
  }
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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_contribuinte_inf_cons.rb', line 252

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



81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_contribuinte_inf_cons.rb', line 81

def self.openapi_nullable
  Set.new([
    :'codigo_status',
    :'motivo_status',
    :'uf',
    :'ie',
    :'cnpj',
    :'cpf',
    :'data_consulta',
    :'uf_atendimento',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_contribuinte_inf_cons.rb', line 66

def self.openapi_types
  {
    :'codigo_status' => :'Integer',
    :'motivo_status' => :'String',
    :'uf' => :'String',
    :'ie' => :'String',
    :'cnpj' => :'String',
    :'cpf' => :'String',
    :'data_consulta' => :'Time',
    :'uf_atendimento' => :'Integer',
    :'informacoes_cadastrais' => :'Array<DfeContribuinteInfCad>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_contribuinte_inf_cons.rb', line 223

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      codigo_status == o.codigo_status &&
      motivo_status == o.motivo_status &&
      uf == o.uf &&
      ie == o.ie &&
      cnpj == o.cnpj &&
      cpf == o.cpf &&
      data_consulta == o.data_consulta &&
      uf_atendimento == o.uf_atendimento &&
      informacoes_cadastrais == o.informacoes_cadastrais
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



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

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


239
240
241
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_contribuinte_inf_cons.rb', line 239

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



245
246
247
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_contribuinte_inf_cons.rb', line 245

def hash
  [codigo_status, motivo_status, uf, ie, cnpj, cpf, data_consulta, uf_atendimento, informacoes_cadastrais].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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_contribuinte_inf_cons.rb', line 160

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

  if @codigo_status < 0
    invalid_properties.push('invalid value for "codigo_status", must be greater than or equal to 0.')
  end

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

  if @motivo_status.to_s.length < 1
    invalid_properties.push('invalid value for "motivo_status", 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



323
324
325
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_contribuinte_inf_cons.rb', line 323

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



329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_contribuinte_inf_cons.rb', line 329

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



317
318
319
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_contribuinte_inf_cons.rb', line 317

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



184
185
186
187
188
189
190
191
 
# File 'lib/nuvemfiscal_sdk_ruby/models/dfe_contribuinte_inf_cons.rb', line 184

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @codigo_status > 999
  return false if @codigo_status < 0
  return false if @motivo_status.to_s.length > 255
  return false if @motivo_status.to_s.length < 1
  true
end