dear-inventory-ruby 0.1.19.1 → 0.2.3

data/lib/dear-inventory-ruby/models/sale_quote.rb

@@ -0,0 +1,326 @@
+=begin
+#DEAR Inventory API
+
+#This specifing endpoints for DEAR Inventory API
+
+The version of the OpenAPI document: 2.0.0
+Contact: nnhansg@gmail.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module DearInventoryRuby
+  class SaleQuote
+    # Unique DEAR Sale ID
+    attr_accessor :sale_id
+
+    # If `true` then `additional charges` lines displayed in `Lines` array
+    attr_accessor :combine_additional_charges
+
+    # Additional information for Quote.
+    attr_accessor :memo
+
+    # Quote Status. Possible Values are values. For POST only `DRAFT` and `AUTHORISED` values accepted
+    attr_accessor :status
+
+    attr_accessor :lines
+
+    attr_accessor :additional_charges
+
+    # Decimal with up to 4 decimal places. Sum of quote lines and additional charges without taxes. Not required for POST.
+    attr_accessor :total_before_tax
+
+    # Decimal with up to 4 decimal places. Sum of quote lines and additional charges taxes. Not required for POST.
+    attr_accessor :tax
+
+    # Decimal with up to 4 decimal places. Sum of quote lines and additional charges with taxes. Not required for POST.
+    attr_accessor :total
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'sale_id' => :'SaleID',
+        :'combine_additional_charges' => :'CombineAdditionalCharges',
+        :'memo' => :'Memo',
+        :'status' => :'Status',
+        :'lines' => :'Lines',
+        :'additional_charges' => :'AdditionalCharges',
+        :'total_before_tax' => :'TotalBeforeTax',
+        :'tax' => :'Tax',
+        :'total' => :'Total'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'sale_id' => :'String',
+        :'combine_additional_charges' => :'Boolean',
+        :'memo' => :'String',
+        :'status' => :'String',
+        :'lines' => :'Array<SaleQuoteLine>',
+        :'additional_charges' => :'Array<SaleAdditionalCharge>',
+        :'total_before_tax' => :'Float',
+        :'tax' => :'Float',
+        :'total' => :'Float'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DearInventoryRuby::SaleQuote` 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::SaleQuote`. 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?(:'sale_id')
+        self.sale_id = attributes[:'sale_id']
+      end
+
+      if attributes.key?(:'combine_additional_charges')
+        self.combine_additional_charges = attributes[:'combine_additional_charges']
+      else
+        self.combine_additional_charges = false
+      end
+
+      if attributes.key?(:'memo')
+        self.memo = attributes[:'memo']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'lines')
+        if (value = attributes[:'lines']).is_a?(Array)
+          self.lines = value
+        end
+      end
+
+      if attributes.key?(:'additional_charges')
+        if (value = attributes[:'additional_charges']).is_a?(Array)
+          self.additional_charges = value
+        end
+      end
+
+      if attributes.key?(:'total_before_tax')
+        self.total_before_tax = attributes[:'total_before_tax']
+      end
+
+      if attributes.key?(:'tax')
+        self.tax = attributes[:'tax']
+      end
+
+      if attributes.key?(:'total')
+        self.total = attributes[:'total']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @sale_id.nil?
+        invalid_properties.push('invalid value for "sale_id", sale_id cannot be nil.')
+      end
+
+      if @combine_additional_charges.nil?
+        invalid_properties.push('invalid value for "combine_additional_charges", combine_additional_charges cannot be nil.')
+      end
+
+      if @memo.nil?
+        invalid_properties.push('invalid value for "memo", memo cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @total_before_tax.nil?
+        invalid_properties.push('invalid value for "total_before_tax", total_before_tax cannot be nil.')
+      end
+
+      if @tax.nil?
+        invalid_properties.push('invalid value for "tax", tax cannot be nil.')
+      end
+
+      if @total.nil?
+        invalid_properties.push('invalid value for "total", total cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @sale_id.nil?
+      return false if @combine_additional_charges.nil?
+      return false if @memo.nil?
+      return false if @status.nil?
+      return false if @total_before_tax.nil?
+      return false if @tax.nil?
+      return false if @total.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          sale_id == o.sale_id &&
+          combine_additional_charges == o.combine_additional_charges &&
+          memo == o.memo &&
+          status == o.status &&
+          lines == o.lines &&
+          additional_charges == o.additional_charges &&
+          total_before_tax == o.total_before_tax &&
+          tax == o.tax &&
+          total == o.total
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [sale_id, combine_additional_charges, memo, status, lines, additional_charges, total_before_tax, tax, total].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # 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
+    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
+  end
+end

data/lib/dear-inventory-ruby/models/sale_quote_line.rb

@@ -0,0 +1,322 @@
+=begin
+#DEAR Inventory API
+
+#This specifing endpoints for DEAR Inventory API
+
+The version of the OpenAPI document: 2.0.0
+Contact: nnhansg@gmail.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module DearInventoryRuby
+  class SaleQuoteLine
+    # Product identifier referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false
+    attr_accessor :product_id
+
+    # Product SKU referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false
+    attr_accessor :sku
+
+    # Product Name referenced by this Line
+    attr_accessor :name
+
+    # Product or service quantity. Minimal value is 1.
+    attr_accessor :quantity
+
+    # Price per unit in Customer currency
+    attr_accessor :price
+
+    # Discount. Value between 0 and 100. For free items discount is 100. Default value is 0
+    attr_accessor :discount
+
+    # Tax
+    attr_accessor :tax
+
+    # Average product cost
+    attr_accessor :average_cost
+
+    # Line Tax Rule name.
+    attr_accessor :tax_rule
+
+    # Comment for this line
+    attr_accessor :comment
+
+    # Line Total. For validation
+    attr_accessor :total
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'product_id' => :'ProductID',
+        :'sku' => :'SKU',
+        :'name' => :'Name',
+        :'quantity' => :'Quantity',
+        :'price' => :'Price',
+        :'discount' => :'Discount',
+        :'tax' => :'Tax',
+        :'average_cost' => :'AverageCost',
+        :'tax_rule' => :'TaxRule',
+        :'comment' => :'Comment',
+        :'total' => :'Total'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'product_id' => :'String',
+        :'sku' => :'String',
+        :'name' => :'String',
+        :'quantity' => :'Float',
+        :'price' => :'Float',
+        :'discount' => :'Float',
+        :'tax' => :'Float',
+        :'average_cost' => :'Float',
+        :'tax_rule' => :'String',
+        :'comment' => :'String',
+        :'total' => :'Float'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DearInventoryRuby::SaleQuoteLine` 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::SaleQuoteLine`. 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?(:'product_id')
+        self.product_id = attributes[:'product_id']
+      end
+
+      if attributes.key?(:'sku')
+        self.sku = attributes[:'sku']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'quantity')
+        self.quantity = attributes[:'quantity']
+      end
+
+      if attributes.key?(:'price')
+        self.price = attributes[:'price']
+      end
+
+      if attributes.key?(:'discount')
+        self.discount = attributes[:'discount']
+      end
+
+      if attributes.key?(:'tax')
+        self.tax = attributes[:'tax']
+      end
+
+      if attributes.key?(:'average_cost')
+        self.average_cost = attributes[:'average_cost']
+      end
+
+      if attributes.key?(:'tax_rule')
+        self.tax_rule = attributes[:'tax_rule']
+      end
+
+      if attributes.key?(:'comment')
+        self.comment = attributes[:'comment']
+      end
+
+      if attributes.key?(:'total')
+        self.total = attributes[:'total']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @quantity.nil?
+        invalid_properties.push('invalid value for "quantity", quantity cannot be nil.')
+      end
+
+      if @price.nil?
+        invalid_properties.push('invalid value for "price", price cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @name.nil?
+      return false if @quantity.nil?
+      return false if @price.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          product_id == o.product_id &&
+          sku == o.sku &&
+          name == o.name &&
+          quantity == o.quantity &&
+          price == o.price &&
+          discount == o.discount &&
+          tax == o.tax &&
+          average_cost == o.average_cost &&
+          tax_rule == o.tax_rule &&
+          comment == o.comment &&
+          total == o.total
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [product_id, sku, name, quantity, price, discount, tax, average_cost, tax_rule, comment, total].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # 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
+    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
+  end
+end