Class: NuvemfiscalSdkRuby::NfseLoteDpsPedidoEmissao

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NfseLoteDpsPedidoEmissao

Initializes the object



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfse_lote_dps_pedido_emissao.rb', line 86

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

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

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

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

Instance Attribute Details

#ambiente ⇒ Object

Identificação do Ambiente.



22
23
24
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfse_lote_dps_pedido_emissao.rb', line 22

def ambiente
  @ambiente
end

#documentos ⇒ Object

Lista com as informações das DPS relativas aos serviços prestados.



28
29
30
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfse_lote_dps_pedido_emissao.rb', line 28

def documentos
  @documentos
end

#provedor ⇒ Object

Default: ‘"padrao"` Identificação do provedor para transmissão da DPS: * `"padrao"`: Provedor padrão da prefeitura. * `"nacional"`: Ambiente de Dados Nacional (ADN) do <a href="www.gov.br/nfse/pt-br" target="blank">Sistema Nacional NFS-e</a>.



19
20
21
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfse_lote_dps_pedido_emissao.rb', line 19

def provedor
  @provedor
end

#referencia ⇒ Object

Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.



25
26
27
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfse_lote_dps_pedido_emissao.rb', line 25

def referencia
  @referencia
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



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

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



63
64
65
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfse_lote_dps_pedido_emissao.rb', line 63

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

def self.attribute_map
  {
    :'provedor' => :'provedor',
    :'ambiente' => :'ambiente',
    :'referencia' => :'referencia',
    :'documentos' => :'documentos'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfse_lote_dps_pedido_emissao.rb', line 223

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



78
79
80
81
82
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfse_lote_dps_pedido_emissao.rb', line 78

def self.openapi_nullable
  Set.new([
    :'ambiente',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfse_lote_dps_pedido_emissao.rb', line 68

def self.openapi_types
  {
    :'provedor' => :'String',
    :'ambiente' => :'String',
    :'referencia' => :'String',
    :'documentos' => :'Array<NfseDpsPedidoEmissao>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



199
200
201
202
203
204
205
206
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfse_lote_dps_pedido_emissao.rb', line 199

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      provedor == o.provedor &&
      ambiente == o.ambiente &&
      referencia == o.referencia &&
      documentos == o.documentos
end

#_to_hash(value) ⇒ Hash

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



318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfse_lote_dps_pedido_emissao.rb', line 318

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


210
211
212
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfse_lote_dps_pedido_emissao.rb', line 210

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



216
217
218
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfse_lote_dps_pedido_emissao.rb', line 216

def hash
  [provedor, ambiente, referencia, documentos].hash
end

#list_invalid_properties ⇒ Object

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



122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfse_lote_dps_pedido_emissao.rb', line 122

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

  if !@documentos.nil? && @documentos.length > 50
    invalid_properties.push('invalid value for "documentos", number of items must be less than or equal to 50.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



294
295
296
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfse_lote_dps_pedido_emissao.rb', line 294

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfse_lote_dps_pedido_emissao.rb', line 300

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



288
289
290
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfse_lote_dps_pedido_emissao.rb', line 288

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfse_lote_dps_pedido_emissao.rb', line 138

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  provedor_validator = EnumAttributeValidator.new('String', ["padrao", "nacional"])
  return false unless provedor_validator.valid?(@provedor)
  ambiente_validator = EnumAttributeValidator.new('String', ["homologacao", "producao"])
  return false unless ambiente_validator.valid?(@ambiente)
  return false if !@referencia.nil? && @referencia.to_s.length > 50
  return false if !@documentos.nil? && @documentos.length > 50
  true
end