dear-inventory-ruby 0.2.2 → 0.2.5

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

@@ -0,0 +1,229 @@
+=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 SaleList
+    # Total
+    attr_accessor :total
+
+    # Page
+    attr_accessor :page
+
+    # Array of SaleItem
+    attr_accessor :sale_list
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'total' => :'Total',
+        :'page' => :'Page',
+        :'sale_list' => :'SaleList'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'total' => :'Float',
+        :'page' => :'Float',
+        :'sale_list' => :'Array<SaleItem>'
+      }
+    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::SaleList` 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::SaleList`. 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?(:'total')
+        self.total = attributes[:'total']
+      end
+
+      if attributes.key?(:'page')
+        self.page = attributes[:'page']
+      end
+
+      if attributes.key?(:'sale_list')
+        if (value = attributes[:'sale_list']).is_a?(Array)
+          self.sale_list = value
+        end
+      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
+      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?
+      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 &&
+          total == o.total &&
+          page == o.page &&
+          sale_list == o.sale_list
+    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
+      [total, page, sale_list].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/webhook_type.rb

@@ -0,0 +1,54 @@
+=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 WebhookType
+    SALE_QUOTE_AUTHORISED = "Sale/QuoteAuthorised".freeze
+    SALE_ORDER_AUTHORISED = "Sale/OrderAuthorised".freeze
+    SALE_VOIDED = "Sale/Voided".freeze
+    SALE_BACKORDERED = "Sale/Backordered".freeze
+    SALE_SHIPMENT_AUTHORISED = "Sale/ShipmentAuthorised".freeze
+    SALE_INVOICE_AUTHORISED = "Sale/InvoiceAuthorised".freeze
+    SALE_PICK_AUTHORISED = "Sale/PickAuthorised".freeze
+    SALE_PACK_AUTHORISED = "Sale/PackAuthorised".freeze
+    SALE_CREDIT_NOTE_AUTHORISED = "Sale/CreditNoteAuthorised".freeze
+    SALE_UNDO = "Sale/Undo".freeze
+    SALE_PARTIAL_PAYMENT_RECEIVED = "Sale/PartialPaymentReceived".freeze
+    SALE_FULL_PAYMENT_RECEIVED = "Sale/FullPaymentReceived".freeze
+    SALE_SHIPMENT_TRACKING_NUMBER_CHANGED = "Sale/ShipmentTrackingNumberChanged".freeze
+    PURCHASE_ORDER_AUTHORISED = "Purchase/OrderAuthorised".freeze
+    PURCHASE_INVOICE_AUTHORISED = "Purchase/InvoiceAuthorised".freeze
+    PURCHASE_STOCK_RECEIVED_AUTHORISED = "Purchase/StockReceivedAuthorised".freeze
+    PURCHASE_CREDIT_NOTE_AUTHORISED = "Purchase/CreditNoteAuthorised".freeze
+    CUSTOMER_UPDATED = "Customer/Updated".freeze
+    SUPPLIER_UPDATED = "Supplier/Updated".freeze
+    STOCK_AVAILABLE_STOCK_LEVEL_CHANGED = "Stock/AvailableStockLevelChanged".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = WebhookType.constants.select { |c| WebhookType::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #WebhookType" if constantValues.empty?
+      value
+    end
+  end
+end

data/lib/dear-inventory-ruby/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.3.1
 =end
 
 module DearInventoryRuby
-  VERSION = '0.2.2'
+  VERSION = '0.2.5'
 end

data/lib/dear-inventory-ruby.rb

@@ -20,6 +20,7 @@ require 'dear-inventory-ruby/configuration'
 require 'dear-inventory-ruby/models/account'
 require 'dear-inventory-ruby/models/accounts'
 require 'dear-inventory-ruby/models/address'
+require 'dear-inventory-ruby/models/authorization_type'
 require 'dear-inventory-ruby/models/contact'
 require 'dear-inventory-ruby/models/customer'
 require 'dear-inventory-ruby/models/customers'
@@ -30,6 +31,7 @@ require 'dear-inventory-ruby/models/payment_term'
 require 'dear-inventory-ruby/models/payment_terms'
 require 'dear-inventory-ruby/models/price_tier'
 require 'dear-inventory-ruby/models/price_tiers'
+require 'dear-inventory-ruby/models/sale'
 require 'dear-inventory-ruby/models/sale_additional_charge'
 require 'dear-inventory-ruby/models/sale_invoice'
 require 'dear-inventory-ruby/models/sale_invoice_additional_charge'
@@ -37,6 +39,8 @@ require 'dear-inventory-ruby/models/sale_invoice_delete'
 require 'dear-inventory-ruby/models/sale_invoice_line'
 require 'dear-inventory-ruby/models/sale_invoice_post'
 require 'dear-inventory-ruby/models/sale_invoices'
+require 'dear-inventory-ruby/models/sale_item'
+require 'dear-inventory-ruby/models/sale_list'
 require 'dear-inventory-ruby/models/sale_order'
 require 'dear-inventory-ruby/models/sale_order_line'
 require 'dear-inventory-ruby/models/sale_payment'
@@ -49,6 +53,7 @@ require 'dear-inventory-ruby/models/tax'
 require 'dear-inventory-ruby/models/tax_component'
 require 'dear-inventory-ruby/models/taxes'
 require 'dear-inventory-ruby/models/webhook'
+require 'dear-inventory-ruby/models/webhook_type'
 require 'dear-inventory-ruby/models/webhooks'
 
 # APIs

data/spec/api/inventory_api_spec.rb

@@ -133,7 +133,7 @@ describe 'InventoryApi' do
   # @param webhook a webhook object with properties to create
   # @param [Hash] opts the optional parameters
   # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors
-  # @return [Webhooks]
+  # @return [Webhook]
   describe 'create_webhook test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -266,6 +266,20 @@ describe 'InventoryApi' do
     end
   end
 
+  # unit tests for get_sale
+  # Allows you to retrieve the Sale
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :id Default is nil
+  # @option opts [Boolean] :combine_additional_charges Show additional charges in 'Lines' array
+  # @option opts [Boolean] :hide_inventory_movements Hide inventory movements (Default = false)
+  # @option opts [Boolean] :include_transactions Show related transactions (Default = false)
+  # @return [Sale]
+  describe 'get_sale test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for get_sale_invoices
   # Allows you to retrieve the sale invoices
   # @param [Hash] opts the optional parameters
@@ -279,6 +293,33 @@ describe 'InventoryApi' do
     end
   end
 
+  # unit tests for get_sale_list
+  # Allows you to retrieve the Sales based on conditions
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :page Default is 1
+  # @option opts [String] :limit Default is 100
+  # @option opts [String] :search Only return sales with search value contained in one of these fields: OrderNumber, Status, Customer, invoiceNumber, CustomerReference, CreditNoteNumber
+  # @option opts [DateTime] :created_since Only return sales created after specified date. Date must follow ISO 8601 format.
+  # @option opts [DateTime] :updated_since Only return sales changed after specified date. Date must follow ISO 8601 format.
+  # @option opts [DateTime] :ship_by Only return sales with Ship By date on or before specified date, with not authorised Shipment. Date must follow ISO 8601 format.
+  # @option opts [String] :quote_status Only return sales with specified quote status
+  # @option opts [String] :order_status Only return sales with specified order status
+  # @option opts [String] :combined_pick_status Only return sales with specified CombinedPickingStatus
+  # @option opts [String] :combined_pack_status Only return sales with specified CombinedPackingStatus
+  # @option opts [String] :combined_shipping_status Only return sales with specified CombinedShippingStatus
+  # @option opts [String] :combined_invoice_status Only return sales with specified CombinedInvoiceStatus
+  # @option opts [String] :credit_note_status Only return sales with specified credit note status
+  # @option opts [String] :external_id Only return sales with specified External ID
+  # @option opts [String] :status Default is nil
+  # @option opts [Boolean] :ready_for_shipping Only return sales with 'Authorised' pack and not 'Authorised' shipping
+  # @option opts [String] :order_location_id Only return sales with specified Order Location ID
+  # @return [SaleList]
+  describe 'get_sale_list test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for get_sale_order
   # Allows you to retrieve the Sale Order
   # @param [Hash] opts the optional parameters
@@ -409,7 +450,7 @@ describe 'InventoryApi' do
   # @param webhook a webhook object with properties to update
   # @param [Hash] opts the optional parameters
   # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors
-  # @return [Webhooks]
+  # @return [Webhook]
   describe 'update_webhook test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/models/authorization_type_spec.rb

@@ -0,0 +1,35 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for DearInventoryRuby::AuthorizationType
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AuthorizationType' do
+  before do
+    # run before each test
+    @instance = DearInventoryRuby::AuthorizationType.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AuthorizationType' do
+    it 'should create an instance of AuthorizationType' do
+      expect(@instance).to be_instance_of(DearInventoryRuby::AuthorizationType)
+    end
+  end
+end

data/spec/models/sale_item_spec.rb

@@ -0,0 +1,221 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for DearInventoryRuby::SaleItem
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'SaleItem' do
+  before do
+    # run before each test
+    @instance = DearInventoryRuby::SaleItem.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SaleItem' do
+    it 'should create an instance of SaleItem' do
+      expect(@instance).to be_instance_of(DearInventoryRuby::SaleItem)
+    end
+  end
+  describe 'test attribute "sale_id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "order_number"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "status"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "order_date"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "invoice_date"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "customer"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "customer_id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "invoice_number"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "customer_reference"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "invoice_amount"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "paid_amount"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "invoice_due_date"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "ship_by"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "base_currency"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "customer_currency"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "credit_note_number"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "updated"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "quote_status"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "order_status"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "combined_picking_status"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "combined_packing_status"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "combined_shipping_status"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "ful_filment_status"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "combined_invoice_status"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "credit_note_status"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "combined_payment_status"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "type"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "combined_tracking_numbers"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "source_channel"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "external_id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "order_location_id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end