Class: NuvemfiscalSdkRuby::BeneficioMunicipal

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

Overview

Benefício Municipal

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BeneficioMunicipal

Initializes the object



68
69
70
71
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
 
# File 'lib/nuvemfiscal_sdk_ruby/models/beneficio_municipal.rb', line 68

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

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

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

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

Instance Attribute Details

#n_bm ⇒ Object

Identificador do benefício municipal parametrizado pelo município.



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

def n_bm
  @n_bm
end

#p_red_bcbm ⇒ Object

Valor percentual informado pelo emitente para redução da base de cálculo (BC) do ISSQN devido a um Benefício Municipal (BM).



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

def p_red_bcbm
  @p_red_bcbm
end

#tp_bm ⇒ Object

Tipo do Benefício Municipal: * 1 - Alíquota Diferenciada * 2 - Redução da BC * 3 - Isenção



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

def tp_bm
  @tp_bm
end

#v_red_bcbm ⇒ Object

Valor monetário informado pelo emitente para redução da base de cálculo (BC) do ISSQN devido a um Benefício Municipal (BM).



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

def v_red_bcbm
  @v_red_bcbm
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
231
232
233
234
 
# File 'lib/nuvemfiscal_sdk_ruby/models/beneficio_municipal.rb', line 197

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
 
# File 'lib/nuvemfiscal_sdk_ruby/models/beneficio_municipal.rb', line 32

def self.attribute_map
  {
    :'tp_bm' => :'tpBM',
    :'n_bm' => :'nBM',
    :'v_red_bcbm' => :'vRedBCBM',
    :'p_red_bcbm' => :'pRedBCBM'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/nuvemfiscal_sdk_ruby/models/beneficio_municipal.rb', line 173

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



57
58
59
60
61
62
63
64
 
# File 'lib/nuvemfiscal_sdk_ruby/models/beneficio_municipal.rb', line 57

def self.openapi_nullable
  Set.new([
    :'tp_bm',
    :'n_bm',
    :'v_red_bcbm',
    :'p_red_bcbm'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
 
# File 'lib/nuvemfiscal_sdk_ruby/models/beneficio_municipal.rb', line 47

def self.openapi_types
  {
    :'tp_bm' => :'Integer',
    :'n_bm' => :'String',
    :'v_red_bcbm' => :'Float',
    :'p_red_bcbm' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



149
150
151
152
153
154
155
156
 
# File 'lib/nuvemfiscal_sdk_ruby/models/beneficio_municipal.rb', line 149

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      tp_bm == o.tp_bm &&
      n_bm == o.n_bm &&
      v_red_bcbm == o.v_red_bcbm &&
      p_red_bcbm == o.p_red_bcbm
end

#_to_hash(value) ⇒ Hash

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



268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/nuvemfiscal_sdk_ruby/models/beneficio_municipal.rb', line 268

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


160
161
162
 
# File 'lib/nuvemfiscal_sdk_ruby/models/beneficio_municipal.rb', line 160

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



166
167
168
 
# File 'lib/nuvemfiscal_sdk_ruby/models/beneficio_municipal.rb', line 166

def hash
  [tp_bm, n_bm, v_red_bcbm, p_red_bcbm].hash
end

#list_invalid_properties ⇒ Object

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



104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/nuvemfiscal_sdk_ruby/models/beneficio_municipal.rb', line 104

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

  if !@p_red_bcbm.nil? && @p_red_bcbm < 0
    invalid_properties.push('invalid value for "p_red_bcbm", 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)



244
245
246
 
# File 'lib/nuvemfiscal_sdk_ruby/models/beneficio_municipal.rb', line 244

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/nuvemfiscal_sdk_ruby/models/beneficio_municipal.rb', line 250

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



238
239
240
 
# File 'lib/nuvemfiscal_sdk_ruby/models/beneficio_municipal.rb', line 238

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



120
121
122
123
124
125
 
# File 'lib/nuvemfiscal_sdk_ruby/models/beneficio_municipal.rb', line 120

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@v_red_bcbm.nil? && @v_red_bcbm < 0
  return false if !@p_red_bcbm.nil? && @p_red_bcbm < 0
  true
end