Class: NuvemfiscalSdkRuby::CteSefazCompl

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

Overview

Dados complementares do CT-e para fins operacionais ou comerciais.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CteSefazCompl

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#dest_calc ⇒ Object

Município de destino para efeito de cálculo do frete.



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

def dest_calc
  @dest_calc
end

#entrega ⇒ Object

Returns the value of attribute entrega.



30
31
32
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_compl.rb', line 30

def entrega
  @entrega
end

#fluxo ⇒ Object

Returns the value of attribute fluxo.



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

def fluxo
  @fluxo
end

#obs_cont ⇒ Object

Returns the value of attribute obs_cont.



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

def obs_cont
  @obs_cont
end

#obs_fisco ⇒ Object

Returns the value of attribute obs_fisco.



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

def obs_fisco
  @obs_fisco
end

#orig_calc ⇒ Object

Município de origem para efeito de cálculo do frete.



33
34
35
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_compl.rb', line 33

def orig_calc
  @orig_calc
end

#x_carac_ad ⇒ Object

Característica adicional do transporte. Texto livre: REENTREGA DEVOLUÇÃO REFATURAMENTO etc.



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

def x_carac_ad
  @x_carac_ad
end

#x_carac_ser ⇒ Object

Característica adicional do serviço. Texto livre: ENTREGA EXPRESSA LOGÍSTICA REVERSA CONVENCIONAL EMERGENCIAL etc.



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

def x_carac_ser
  @x_carac_ser
end

#x_emi ⇒ Object

Funcionário emissor do CTe.



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

def x_emi
  @x_emi
end

#x_obs ⇒ Object

Observações Gerais.



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

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



407
408
409
410
411
412
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
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_compl.rb', line 407

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



62
63
64
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_compl.rb', line 62

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
59
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_compl.rb', line 46

def self.attribute_map
  {
    :'x_carac_ad' => :'xCaracAd',
    :'x_carac_ser' => :'xCaracSer',
    :'x_emi' => :'xEmi',
    :'fluxo' => :'fluxo',
    :'entrega' => :'Entrega',
    :'orig_calc' => :'origCalc',
    :'dest_calc' => :'destCalc',
    :'x_obs' => :'xObs',
    :'obs_cont' => :'ObsCont',
    :'obs_fisco' => :'ObsFisco'
  }
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



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_compl.rb', line 383

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



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

def self.openapi_nullable
  Set.new([
    :'x_carac_ad',
    :'x_carac_ser',
    :'x_emi',
    :'orig_calc',
    :'dest_calc',
    :'x_obs',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'x_carac_ad' => :'String',
    :'x_carac_ser' => :'String',
    :'x_emi' => :'String',
    :'fluxo' => :'CteSefazFluxo',
    :'entrega' => :'CteSefazEntrega',
    :'orig_calc' => :'String',
    :'dest_calc' => :'String',
    :'x_obs' => :'String',
    :'obs_cont' => :'Array<CteSefazObsCont>',
    :'obs_fisco' => :'Array<CteSefazObsFisco>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_compl.rb', line 353

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      x_carac_ad == o.x_carac_ad &&
      x_carac_ser == o.x_carac_ser &&
      x_emi == o.x_emi &&
      fluxo == o.fluxo &&
      entrega == o.entrega &&
      orig_calc == o.orig_calc &&
      dest_calc == o.dest_calc &&
      x_obs == o.x_obs &&
      obs_cont == o.obs_cont &&
      obs_fisco == o.obs_fisco
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



478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_compl.rb', line 478

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


370
371
372
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_compl.rb', line 370

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [x_carac_ad, x_carac_ser, x_emi, fluxo, entrega, orig_calc, dest_calc, x_obs, obs_cont, obs_fisco].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



156
157
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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_compl.rb', line 156

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

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

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

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

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

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

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

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

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

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

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

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

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

  if !@obs_fisco.nil? && @obs_fisco.length > 10
    invalid_properties.push('invalid value for "obs_fisco", number of items must be less than or equal to 10.')
  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



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

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



460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_compl.rb', line 460

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



448
449
450
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_compl.rb', line 448

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



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/nuvemfiscal_sdk_ruby/models/cte_sefaz_compl.rb', line 220

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@x_carac_ad.nil? && @x_carac_ad.to_s.length > 15
  return false if !@x_carac_ad.nil? && @x_carac_ad.to_s.length < 1
  return false if !@x_carac_ser.nil? && @x_carac_ser.to_s.length > 30
  return false if !@x_carac_ser.nil? && @x_carac_ser.to_s.length < 1
  return false if !@x_emi.nil? && @x_emi.to_s.length > 20
  return false if !@x_emi.nil? && @x_emi.to_s.length < 1
  return false if !@orig_calc.nil? && @orig_calc.to_s.length > 40
  return false if !@orig_calc.nil? && @orig_calc.to_s.length < 2
  return false if !@dest_calc.nil? && @dest_calc.to_s.length > 40
  return false if !@dest_calc.nil? && @dest_calc.to_s.length < 2
  return false if !@x_obs.nil? && @x_obs.to_s.length > 2000
  return false if !@x_obs.nil? && @x_obs.to_s.length < 1
  return false if !@obs_cont.nil? && @obs_cont.length > 10
  return false if !@obs_fisco.nil? && @obs_fisco.length > 10
  true
end