class DearInventoryRuby::Tax
Attributes
ChartOfAccount Code with Class == `LIABILITY` && Status == `ACTIVE`
List of Tax
Components
Unique ID
Points that tax is Active
Points that tax is used for Purchase
Points that tax is used for Sale
Tax
Name
Points that tax is Inclusive
Tax
percentage, should be between 0 and 100. Read-only
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/dear-inventory-ruby/models/tax.rb, line 45 def self.attribute_map { :'id' => :'ID', :'name' => :'Name', :'account' => :'Account', :'is_active' => :'IsActive', :'tax_inclusive' => :'TaxInclusive', :'tax_percent' => :'TaxPercent', :'is_tax_for_sale' => :'IsTaxForSale', :'is_tax_for_purchase' => :'IsTaxForPurchase', :'components' => :'Components' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/dear-inventory-ruby/models/tax.rb, line 249 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/dear-inventory-ruby/models/tax.rb, line 82 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `DearInventoryRuby::Tax` 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 `DearInventoryRuby::Tax`. 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?(:'id') self.id = attributes[:'id'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'account') self.account = attributes[:'account'] end if attributes.key?(:'is_active') self.is_active = attributes[:'is_active'] else self.is_active = true end if attributes.key?(:'tax_inclusive') self.tax_inclusive = attributes[:'tax_inclusive'] else self.tax_inclusive = true end if attributes.key?(:'tax_percent') self.tax_percent = attributes[:'tax_percent'] end if attributes.key?(:'is_tax_for_sale') self.is_tax_for_sale = attributes[:'is_tax_for_sale'] else self.is_tax_for_sale = true end if attributes.key?(:'is_tax_for_purchase') self.is_tax_for_purchase = attributes[:'is_tax_for_purchase'] else self.is_tax_for_purchase = true end if attributes.key?(:'components') if (value = attributes[:'components']).is_a?(Array) self.components = value end end end
List of attributes with nullable: true
# File lib/dear-inventory-ruby/models/tax.rb, line 75 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/dear-inventory-ruby/models/tax.rb, line 60 def self.openapi_types { :'id' => :'String', :'name' => :'String', :'account' => :'String', :'is_active' => :'Boolean', :'tax_inclusive' => :'Boolean', :'tax_percent' => :'Float', :'is_tax_for_sale' => :'Boolean', :'is_tax_for_purchase' => :'Boolean', :'components' => :'Array<TaxComponent>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/dear-inventory-ruby/models/tax.rb, line 220 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && account == o.account && is_active == o.is_active && tax_inclusive == o.tax_inclusive && tax_percent == o.tax_percent && is_tax_for_sale == o.is_tax_for_sale && is_tax_for_purchase == o.is_tax_for_purchase && components == o.components end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/dear-inventory-ruby/models/tax.rb, line 277 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.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 DearInventoryRuby.const_get(type).build_from_hash(value) end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/dear-inventory-ruby/models/tax.rb, line 346 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/dear-inventory-ruby/models/tax.rb, line 256 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if 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[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end
@see the `==` method @param [Object] Object to be compared
# File lib/dear-inventory-ruby/models/tax.rb, line 236 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/dear-inventory-ruby/models/tax.rb, line 242 def hash [id, name, account, is_active, tax_inclusive, tax_percent, is_tax_for_sale, is_tax_for_purchase, components].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/dear-inventory-ruby/models/tax.rb, line 144 def list_invalid_properties invalid_properties = Array.new if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end if @name.to_s.length > 50 invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 50.') end if @account.nil? invalid_properties.push('invalid value for "account", account cannot be nil.') end if @is_active.nil? invalid_properties.push('invalid value for "is_active", is_active cannot be nil.') end if @tax_inclusive.nil? invalid_properties.push('invalid value for "tax_inclusive", tax_inclusive cannot be nil.') end if !@tax_percent.nil? && @tax_percent > 100 invalid_properties.push('invalid value for "tax_percent", must be smaller than or equal to 100.') end if !@tax_percent.nil? && @tax_percent < 0 invalid_properties.push('invalid value for "tax_percent", must be greater than or equal to 0.') end invalid_properties end
Custom attribute writer method with validation @param [Object] name Value to be assigned
# File lib/dear-inventory-ruby/models/tax.rb, line 192 def name=(name) if name.nil? fail ArgumentError, 'name cannot be nil' end if name.to_s.length > 50 fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 50.' end @name = name end
Custom attribute writer method with validation @param [Object] tax_percent
Value to be assigned
# File lib/dear-inventory-ruby/models/tax.rb, line 206 def tax_percent=(tax_percent) if !tax_percent.nil? && tax_percent > 100 fail ArgumentError, 'invalid value for "tax_percent", must be smaller than or equal to 100.' end if !tax_percent.nil? && tax_percent < 0 fail ArgumentError, 'invalid value for "tax_percent", must be greater than or equal to 0.' end @tax_percent = tax_percent end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/dear-inventory-ruby/models/tax.rb, line 328 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/dear-inventory-ruby/models/tax.rb, line 316 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/dear-inventory-ruby/models/tax.rb, line 179 def valid? return false if @name.nil? return false if @name.to_s.length > 50 return false if @account.nil? return false if @is_active.nil? return false if @tax_inclusive.nil? return false if !@tax_percent.nil? && @tax_percent > 100 return false if !@tax_percent.nil? && @tax_percent < 0 true end