Class: NuvemfiscalSdkRuby::CteSefazInfCarga

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

Overview

Informações da Carga do CT-e.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CteSefazInfCarga

Initializes the object

Parameters:

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

    Model attributes in the form of hash



72
73
74
75
76
77
78
79
80
81
82
83
84
85
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
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_inf_carga.rb', line 72

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

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

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

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

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

Instance Attribute Details

#inf_q ⇒ Object

Returns the value of attribute inf_q.



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

def inf_q
  @inf_q
end

#pro_pred ⇒ Object

Produto predominante. Informar a descrição do produto predominante.



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

def pro_pred
  @pro_pred
end

#v_carga ⇒ Object

Valor total da carga. Dever ser informado para todos os modais, com exceção para o Dutoviário.



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

def v_carga
  @v_carga
end

#v_carga_averb ⇒ Object

Valor da Carga para efeito de averbação. Normalmente igual ao valor declarado da mercadoria, diferente por exemplo, quando a mercadoria transportada é isenta de tributos nacionais para exportação, onde é preciso averbar um valor maior, pois no caso de indenização, o valor a ser pago será maior.



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

def v_carga_averb
  @v_carga_averb
end

#x_out_cat ⇒ Object

Outras características da carga. "FRIA", "GRANEL", "REFRIGERADA", "Medidas: 12X12X12".



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

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



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
314
315
316
317
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_inf_carga.rb', line 280

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_inf_carga.rb', line 34

def self.attribute_map
  {
    :'v_carga' => :'vCarga',
    :'pro_pred' => :'proPred',
    :'x_out_cat' => :'xOutCat',
    :'inf_q' => :'infQ',
    :'v_carga_averb' => :'vCargaAverb'
  }
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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_inf_carga.rb', line 256

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



61
62
63
64
65
66
67
68
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_inf_carga.rb', line 61

def self.openapi_nullable
  Set.new([
    :'v_carga',
    :'pro_pred',
    :'x_out_cat',
    :'v_carga_averb'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_inf_carga.rb', line 50

def self.openapi_types
  {
    :'v_carga' => :'Float',
    :'pro_pred' => :'String',
    :'x_out_cat' => :'String',
    :'inf_q' => :'Array<CteSefazInfQ>',
    :'v_carga_averb' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



231
232
233
234
235
236
237
238
239
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_inf_carga.rb', line 231

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      v_carga == o.v_carga &&
      pro_pred == o.pro_pred &&
      x_out_cat == o.x_out_cat &&
      inf_q == o.inf_q &&
      v_carga_averb == o.v_carga_averb
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



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_inf_carga.rb', line 351

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


243
244
245
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_inf_carga.rb', line 243

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



249
250
251
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_inf_carga.rb', line 249

def hash
  [v_carga, pro_pred, x_out_cat, inf_q, v_carga_averb].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



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@v_carga.nil? && @v_carga < 0
    invalid_properties.push('invalid value for "v_carga", must be greater than or equal to 0.')
  end

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

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

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

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

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

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

  if !@v_carga_averb.nil? && @v_carga_averb <= 0
    invalid_properties.push('invalid value for "v_carga_averb", must be greater than 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



327
328
329
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_inf_carga.rb', line 327

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



333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_inf_carga.rb', line 333

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



321
322
323
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_inf_carga.rb', line 321

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



154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_inf_carga.rb', line 154

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@v_carga.nil? && @v_carga < 0
  return false if @pro_pred.to_s.length > 60
  return false if @pro_pred.to_s.length < 1
  return false if !@x_out_cat.nil? && @x_out_cat.to_s.length > 30
  return false if !@x_out_cat.nil? && @x_out_cat.to_s.length < 1
  return false if @inf_q.nil?
  return false if @inf_q.length < 1
  return false if !@v_carga_averb.nil? && @v_carga_averb <= 0
  true
end