Class: NuvemfiscalSdkRuby::NfeSefazCana

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

Overview

Informações de registro aquisições de cana.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NfeSefazCana

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_cana.rb', line 100

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#deduc ⇒ Object

Returns the value of attribute deduc.



36
37
38
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_cana.rb', line 36

def deduc
  @deduc
end

#for_dia ⇒ Object

Returns the value of attribute for_dia.



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

def for_dia
  @for_dia
end

#q_tot_ant ⇒ Object

Total Anterior.



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

def q_tot_ant
  @q_tot_ant
end

#q_tot_ger ⇒ Object

Total Geral.



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

def q_tot_ger
  @q_tot_ger
end

#q_tot_mes ⇒ Object

Total do mês.



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

def q_tot_mes
  @q_tot_mes
end

#ref ⇒ Object

Mês e Ano de Referência, formato: MM/AAAA.



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

def ref
  @ref
end

#safra ⇒ Object

Identificação da safra.



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

def safra
  @safra
end

#v_for ⇒ Object

Valor dos fornecimentos.



39
40
41
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_cana.rb', line 39

def v_for
  @v_for
end

#v_liq_for ⇒ Object

Valor Líquido dos fornecimentos.



45
46
47
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_cana.rb', line 45

def v_liq_for
  @v_liq_for
end

#v_tot_ded ⇒ Object

Valor Total das Deduções.



42
43
44
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_cana.rb', line 42

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



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
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_cana.rb', line 413

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



64
65
66
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_cana.rb', line 64

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'safra' => :'safra',
    :'ref' => :'ref',
    :'for_dia' => :'forDia',
    :'q_tot_mes' => :'qTotMes',
    :'q_tot_ant' => :'qTotAnt',
    :'q_tot_ger' => :'qTotGer',
    :'deduc' => :'deduc',
    :'v_for' => :'vFor',
    :'v_tot_ded' => :'vTotDed',
    :'v_liq_for' => :'vLiqFor'
  }
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



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_cana.rb', line 389

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



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

def self.openapi_nullable
  Set.new([
    :'safra',
    :'ref',
    :'q_tot_mes',
    :'q_tot_ant',
    :'q_tot_ger',
    :'v_for',
    :'v_tot_ded',
    :'v_liq_for'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'safra' => :'String',
    :'ref' => :'String',
    :'for_dia' => :'Array<NfeSefazForDia>',
    :'q_tot_mes' => :'Float',
    :'q_tot_ant' => :'Float',
    :'q_tot_ger' => :'Float',
    :'deduc' => :'Array<NfeSefazDeduc>',
    :'v_for' => :'Float',
    :'v_tot_ded' => :'Float',
    :'v_liq_for' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_cana.rb', line 359

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      safra == o.safra &&
      ref == o.ref &&
      for_dia == o.for_dia &&
      q_tot_mes == o.q_tot_mes &&
      q_tot_ant == o.q_tot_ant &&
      q_tot_ger == o.q_tot_ger &&
      deduc == o.deduc &&
      v_for == o.v_for &&
      v_tot_ded == o.v_tot_ded &&
      v_liq_for == o.v_liq_for
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



484
485
486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_cana.rb', line 484

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


376
377
378
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_cana.rb', line 376

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



382
383
384
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_cana.rb', line 382

def hash
  [safra, ref, for_dia, q_tot_mes, q_tot_ant, q_tot_ger, deduc, v_for, v_tot_ded, v_liq_for].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



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
229
230
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_cana.rb', line 178

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

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

  if @for_dia.nil?
    invalid_properties.push('invalid value for "for_dia", for_dia cannot be nil.')
  end

  if @for_dia.length > 31
    invalid_properties.push('invalid value for "for_dia", number of items must be less than or equal to 31.')
  end

  if @for_dia.length < 1
    invalid_properties.push('invalid value for "for_dia", number of items must be greater than or equal to 1.')
  end

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

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

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

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

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

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

  if @v_liq_for < 0
    invalid_properties.push('invalid value for "v_liq_for", must be greater than or equal to 0.')
  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



460
461
462
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_cana.rb', line 460

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



466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_cana.rb', line 466

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



454
455
456
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_cana.rb', line 454

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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_cana.rb', line 234

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @safra.to_s.length > 9
  return false if @safra.to_s.length < 4
  return false if @for_dia.nil?
  return false if @for_dia.length > 31
  return false if @for_dia.length < 1
  return false if @q_tot_mes < 0
  return false if @q_tot_ant < 0
  return false if @q_tot_ger < 0
  return false if !@deduc.nil? && @deduc.length > 10
  return false if @v_for < 0
  return false if @v_tot_ded < 0
  return false if @v_liq_for < 0
  true
end