dear_inventory 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b445769028c6b81e655cd7bd902dc8327504d77303029b826895cf5dce296e66
-  data.tar.gz: eeee1b7960670891118de2e27082f17ef81bbc2b51b2fda75eea4c744e03128d
+  metadata.gz: 4e7b894db20c76cbb175167334ce5abaa5c019fceae1389bb27bdf3fbf1a0d6e
+  data.tar.gz: 9bb10673c10deda7b5e7a10267c88b5a7486f0c7727fa96ef1b84e0b32280edc
 SHA512:
-  metadata.gz: 4c816c72d227162ec60f542eccad61194c4e509584118995dae0172ca4d62acee792734ee10bfd12f45c86f26faa2e46c186da0f515ab80d18dbf892f90cb8b5
-  data.tar.gz: 864070cd75c5024a548ef1e2712d0051c5a1aab1d9dcc56806731bb0295fdf31efc1a7a23ecfce46f8cbfd79e37b3d8f6104869312ba6216bbaa90626d3b05d5
+  metadata.gz: e39397309918ad91208cdb5d8973deb3e4f32d281fa902e652e9870e9c2081addea6fa9bec3721056585252c01428560c6df721d4e7a710f8cce13871103018d
+  data.tar.gz: 3e744705693565470431673b54b4aff46db15fc1779e7fbeeaacb98511b4c1e19ddad11f8dc06d78c2e0aa30b4e4fcf31a1d16b22933359c4f0dce057bea9a14

data/lib/dear_inventory.rb

@@ -21,7 +21,10 @@ require "dear_inventory/model"
 require "dear_inventory/models/additional_attributes"
 require "dear_inventory/models/address"
 require "dear_inventory/models/attachment"
+require "dear_inventory/models/bill_of_materials_product"
+require "dear_inventory/models/bill_of_materials_service"
 require "dear_inventory/models/inventory_movement"
+require "dear_inventory/models/products/movement"
 require "dear_inventory/models/purchase_list"
 require "dear_inventory/models/purchase_lists"
 require "dear_inventory/models/purchases/additional_charge"
@@ -34,6 +37,7 @@ require "dear_inventory/models/purchases/manual_journal"
 require "dear_inventory/models/purchases/stock_line"
 require "dear_inventory/models/purchases/stock"
 require "dear_inventory/models/purchases/unstock_line"
+require "dear_inventory/models/reorder_level"
 require "dear_inventory/models/sale_list"
 require "dear_inventory/models/sales/additional_charge"
 require "dear_inventory/models/sales/invoice_additional_charge"
@@ -45,6 +49,7 @@ require "dear_inventory/models/sales/order"
 require "dear_inventory/models/sales/payment_line"
 require "dear_inventory/models/sales/quote"
 require "dear_inventory/models/shipping_address"
+require "dear_inventory/models/supplier"
 require "dear_inventory/models/transaction"
 require "dear_inventory/models/sales/fulfilments/pick_pack_line"
 require "dear_inventory/models/sales/fulfilments/pick_pack"
@@ -52,6 +57,9 @@ require "dear_inventory/models/sales/fulfilments/ship_line"
 require "dear_inventory/models/sales/fulfilments/ship"
 require "dear_inventory/models/sales/fulfilment"
 require "dear_inventory/models/sale_lists"
+
+require "dear_inventory/models/product"
+require "dear_inventory/models/products"
 require "dear_inventory/models/purchases/credit_note"
 require "dear_inventory/models/purchases/invoice"
 require "dear_inventory/models/purchases/order"
@@ -71,12 +79,14 @@ require "dear_inventory/validators/string"
 require "dear_inventory/validators/time"
 
 require "dear_inventory/parameters"
+require "dear_inventory/parameters/product/index"
 require "dear_inventory/parameters/purchase/index"
 require "dear_inventory/parameters/purchase_list/index"
 require "dear_inventory/parameters/sale/index"
 require "dear_inventory/parameters/sale_list/index"
 
 require "dear_inventory/resource"
+require "dear_inventory/resources/product"
 require "dear_inventory/resources/purchase"
 require "dear_inventory/resources/purchase_list"
 require "dear_inventory/resources/sale"

data/lib/dear_inventory/model.rb

@@ -63,14 +63,7 @@ module DearInventory
           T::Hash[T.any(String, Symbol), T.untyped],
         specifications:
           T::Hash[Symbol, T.any(Symbol, T.class_of(DearInventory::Model))]
-      ).returns(
-        T.nilable(
-          T.any(
-            Date, DateTime, String, Numeric, T::Boolean,
-            DearInventory::Model, T::Array[DearInventory::Model]
-          )
-        )
-      )
+      ).returns(T.untyped)
     end
     def field_value(response_name, values, specifications)
       model = T.cast(
@@ -80,6 +73,8 @@ module DearInventory
       value = values[response_name.to_s]
 
       case specifications[:type]
+      when :BigDecimal
+        value.to_d
       when :Date
         ::Date.parse(value) unless value.nil?
       when :DateTime

data/lib/dear_inventory/models/bill_of_materials_product.rb

@@ -0,0 +1,41 @@
+# typed: strong
+# frozen_string_literal: true
+
+module DearInventory
+  module Models
+    class BillOfMaterialsProduct < DearInventory::Model
+      extend T::Sig
+
+      fields(
+        ComponentProductID: {
+          name: :component_product_id,
+          type: :Guid,
+        },
+        ProductCode: {
+          name: :product_code,
+          type: :String,
+        },
+        Name: {
+          name: :name,
+          type: :String,
+        },
+        Quantity: {
+          name: :quantity,
+          type: :Float,
+        },
+        WastagePercent: {
+          name: :wastage_percent,
+          type: :Float,
+        },
+        WastageQuantity: {
+          name: :wastage_quantity,
+          type: :Float,
+        },
+        CostPercentage: {
+          name: :cost_percentage,
+          type: :Float,
+        }
+      )
+    end
+  end
+end

data/lib/dear_inventory/models/bill_of_materials_service.rb

@@ -0,0 +1,33 @@
+# typed: strong
+# frozen_string_literal: true
+
+module DearInventory
+  module Models
+    class BillOfMaterialsService < DearInventory::Model
+      extend T::Sig
+
+      fields(
+        ComponentProductID: {
+          name: :component_product_id,
+          type: :Guid,
+        },
+        Name: {
+          name: :name,
+          type: :String,
+        },
+        Quantity: {
+          name: :quantity,
+          type: :Float,
+        },
+        ExpenseAccount: {
+          name: :expense_account,
+          type: :String,
+        },
+        PriceTier: {
+          name: :price_tier,
+          type: :Integer,
+        }
+      )
+    end
+  end
+end

data/lib/dear_inventory/models/product.rb

@@ -0,0 +1,295 @@
+# typed: strong
+# frozen_string_literal: true
+
+module DearInventory
+  module Models
+    class Product < DearInventory::Model
+      extend T::Sig
+
+      fields(
+        ID: {
+          name: :id,
+          type: :Guid,
+        },
+        SKU: {
+          name: :sku,
+          type: :String,
+        },
+        Name: {
+          name: :name,
+          type: :String,
+        },
+        Category: {
+          name: :category,
+          type: :String,
+        },
+        Brand: {
+          name: :brand,
+          type: :String,
+        },
+        Type: {
+          name: :type,
+          type: :String,
+        },
+        CostingMethod: {
+          name: :costing_method,
+          type: :String,
+        },
+        DropShipMode: {
+          name: :drop_ship_mode,
+          type: :String,
+        },
+        DefaultLocation: {
+          name: :default_location,
+          type: :String,
+        },
+        Length: {
+          name: :length,
+          type: :Float,
+        },
+        Width: {
+          name: :width,
+          type: :Float,
+        },
+        Height: {
+          name: :height,
+          type: :Float,
+        },
+        Weight: {
+          name: :weight,
+          type: :Float,
+        },
+        UOM: {
+          name: :uom,
+          type: :String,
+        },
+        WeightUnits: {
+          name: :weight_units,
+          type: :String,
+        },
+        DimensionsUnits: {
+          name: :dimensions_units,
+          type: :String,
+        },
+        Barcode: {
+          name: :barcode,
+          type: :String,
+        },
+        MinimumBeforeReorder: {
+          name: :minimum_before_reorder,
+          type: :Float,
+        },
+        ReorderQuantity: {
+          name: :reorder_quantity,
+          type: :Float,
+        },
+        PriceTier1: {
+          name: :price_tier_1,
+          type: :BigDecimal,
+        },
+        PriceTier2: {
+          name: :price_tier_2,
+          type: :BigDecimal,
+        },
+        PriceTier3: {
+          name: :price_tier_3,
+          type: :BigDecimal,
+        },
+        PriceTier4: {
+          name: :price_tier_4,
+          type: :BigDecimal,
+        },
+        PriceTier5: {
+          name: :price_tier_5,
+          type: :BigDecimal,
+        },
+        PriceTier6: {
+          name: :price_tier_6,
+          type: :BigDecimal,
+        },
+        PriceTier7: {
+          name: :price_tier_7,
+          type: :BigDecimal,
+        },
+        PriceTier8: {
+          name: :price_tier_8,
+          type: :BigDecimal,
+        },
+        PriceTier9: {
+          name: :price_tier_9,
+          type: :BigDecimal,
+        },
+        PriceTier10: {
+          name: :price_tier_10,
+          type: :BigDecimal,
+        },
+        PriceTiers: {
+          name: :price_tiers,
+          type: :Untyped
+        },
+        AverageCost: {
+          name: :average_cost,
+          type: :BigDecimal,
+        },
+        ShortDescription: {
+          name: :short_description,
+          type: :String,
+        },
+        Description: {
+          name: :description,
+          type: :String,
+        },
+        AdditionalAttribute1: {
+          name: :additional_attribute_1,
+          type: :String,
+        },
+        AdditionalAttribute2: {
+          name: :additional_attribute_2,
+          type: :String,
+        },
+        AdditionalAttribute3: {
+          name: :additional_attribute_3,
+          type: :String,
+        },
+        AdditionalAttribute4: {
+          name: :additional_attribute_4,
+          type: :String,
+        },
+        AdditionalAttribute5: {
+          name: :additional_attribute_5,
+          type: :String,
+        },
+        AdditionalAttribute6: {
+          name: :additional_attribute_6,
+          type: :String,
+        },
+        AdditionalAttribute7: {
+          name: :additional_attribute_7,
+          type: :String,
+        },
+        AdditionalAttribute8: {
+          name: :additional_attribute_8,
+          type: :String,
+        },
+        AdditionalAttribute9: {
+          name: :additional_attribute_9,
+          type: :String,
+        },
+        AdditionalAttribute10: {
+          name: :additional_attribute_10,
+          type: :String,
+        },
+        AttributeSet: {
+          name: :attribute_set,
+          type: :String,
+        },
+        DiscountRule: {
+          name: :discount_rule,
+          type: :String,
+        },
+        Tags: {
+          name: :tags,
+          type: :String,
+        },
+        Status: {
+          name: :status,
+          type: :String,
+        },
+        StockLocator: {
+          name: :stock_locator,
+          type: :String,
+        },
+        COGSAccount: {
+          name: :cogs_account,
+          type: :String,
+        },
+        RevenueAccount: {
+          name: :revenue_account,
+          type: :String,
+        },
+        ExpenseAccount: {
+          name: :expense_account,
+          type: :String,
+        },
+        InventoryAccount: {
+          name: :inventory_account,
+          type: :String,
+        },
+        PurchaseTaxRule: {
+          name: :purchase_tax_rule,
+          type: :String,
+        },
+        SaleTaxRule: {
+          name: :sale_tax_rule,
+          type: :String,
+        },
+        LastModifiedOn: {
+          name: :last_modified_on,
+          type: :DateTime,
+        },
+        Sellable: {
+          name: :sellable,
+          type: :Boolean,
+        },
+        PickZones: {
+          name: :pick_zones,
+          type: :String,
+        },
+        BillOfMaterial: {
+          name: :bill_of_material,
+          type: :Boolean,
+        },
+        AutoAssembly: {
+          name: :auto_assembly,
+          type: :Boolean,
+        },
+        AutoDisassembly: {
+          name: :auto_disassembly,
+          type: :Boolean,
+        },
+        QuantityToProduce: {
+          name: :quantity_to_produce,
+          type: :Float,
+        },
+        AssemblyInstructionURL: {
+          name: :assembly_instruction_url,
+          type: :String,
+        },
+        AssemblyCostEstimationMethod: {
+          name: :assembly_cost_estimation_method,
+          type: :String,
+        },
+        Suppliers: {
+          name: :suppliers,
+          type: :Array,
+          model: DearInventory::Models::Supplier,
+        },
+        ReorderLevels: {
+          name: :reorder_levels,
+          type: :Array,
+          model: DearInventory::Models::ReorderLevel,
+        },
+        BillOfMaterialsProducts: {
+          name: :bill_of_materials_products,
+          type: :Array,
+          model: DearInventory::Models::BillOfMaterialsProduct,
+        },
+        BillOfMaterialsServices: {
+          name: :bill_of_materials_services,
+          type: :Array,
+          model: DearInventory::Models::BillOfMaterialsService,
+        },
+        Movements: {
+          name: :movements,
+          type: :Array,
+          model: DearInventory::Models::Products::Movement,
+        },
+        Attachments: {
+          name: :attachments,
+          type: :Array,
+          model: DearInventory::Models::Attachment,
+        }
+      )
+    end
+  end
+end

data/lib/dear_inventory/models/products.rb

@@ -0,0 +1,26 @@
+# typed: strong
+# frozen_string_literal: true
+
+module DearInventory
+  module Models
+    class Products < DearInventory::Model
+      extend T::Sig
+
+      fields(
+        Total: {
+          name: :total,
+          type: :Integer,
+        },
+        Page: {
+          name: :page,
+          type: :Integer,
+        },
+        Products: {
+          name: :products,
+          type: :Array,
+          model: DearInventory::Models::Product,
+        }
+      )
+    end
+  end
+end

data/lib/dear_inventory/models/products/movement.rb

@@ -0,0 +1,65 @@
+# typed: strong
+# frozen_string_literal: true
+
+# This model has been designed to match the Dear API documentation, however,
+# some of the field types don't make sense. Unfortunately, when trying to check
+# what is being sent by the API, it turns out Dear is responding with an empty
+# array even in situations where a movement exists for a product. The model will
+# remain here incase the API is ever fixed but it will need to be reviewed in
+# that case
+module DearInventory
+  module Models
+    class Products < DearInventory::Model
+      class Movement < DearInventory::Model
+        extend T::Sig
+
+        fields(
+          TaskID: {
+            name: :task_id,
+            type: :Guid,
+          },
+          Type: {
+            name: :type,
+            type: :String,
+          },
+          Date: {
+            name: :date,
+            type: :DateTime,
+          },
+          Number: {
+            name: :number,
+            type: :String,
+          },
+          Status: {
+            name: :status,
+            type: :Integer,
+          },
+          Quantity: {
+            name: :quantity,
+            type: :Float,
+          },
+          Amount: {
+            name: :amount,
+            type: :BigDecimal,
+          },
+          Location: {
+            name: :location,
+            type: :Float,
+          },
+          BatchSN: {
+            name: :batch_sn,
+            type: :Float,
+          },
+          ExpiryDate: {
+            name: :expiry_date,
+            type: :DateTime,
+          },
+          FromTo: {
+            name: :from_to,
+            type: :String,
+          }
+        )
+      end
+    end
+  end
+end

data/lib/dear_inventory/models/reorder_level.rb

@@ -0,0 +1,37 @@
+# typed: strong
+# frozen_string_literal: true
+
+module DearInventory
+  module Models
+    class ReorderLevel < DearInventory::Model
+      extend T::Sig
+
+      fields(
+        LocationID: {
+          name: :location_id,
+          type: :Guid,
+        },
+        LocationName: {
+          name: :location_name,
+          type: :String,
+        },
+        MinimumBeforeReorder: {
+          name: :minimum_before_reorder,
+          type: :Float,
+        },
+        ReorderQuantity: {
+          name: :reorder_quantity,
+          type: :Float,
+        },
+        StockLocator: {
+          name: :stock_locator,
+          type: :String,
+        },
+        PickZones: {
+          name: :pick_zones,
+          type: :String,
+        }
+      )
+    end
+  end
+end

data/lib/dear_inventory/models/supplier.rb

@@ -0,0 +1,49 @@
+# typed: strong
+# frozen_string_literal: true
+
+module DearInventory
+  module Models
+    class Supplier < DearInventory::Model
+      extend T::Sig
+
+      fields(
+        SupplierID: {
+          name: :supplier_id,
+          type: :Guid,
+        },
+        SupplierName: {
+          name: :supplier_name,
+          type: :String,
+        },
+        SupplierInventoryCode: {
+          name: :supplier_inventory_code,
+          type: :String,
+        },
+        SupplierProductName: {
+          name: :supplier_product_name,
+          type: :String,
+        },
+        Cost: {
+          name: :cost,
+          type: :BigDecimal,
+        },
+        FixedCost: {
+          name: :fixed_cost,
+          type: :BigDecimal,
+        },
+        Currency: {
+          name: :currency,
+          type: :String,
+        },
+        DropShip: {
+          name: :drop_ship,
+          type: :Boolean,
+        },
+        URL: {
+          name: :url,
+          type: :String,
+        }
+      )
+    end
+  end
+end

data/lib/dear_inventory/parameters/product/index.rb

@@ -0,0 +1,75 @@
+# typed: strict
+# frozen_string_literal: true
+
+module DearInventory
+  class Parameters
+    module Product
+      class Index < DearInventory::Parameters
+        extend T::Sig
+
+        fields(
+          id: {
+            property: :ID,
+            type: :String,
+            required: false,
+          },
+          page: {
+            property: :Page,
+            type: :Integer,
+            required: false,
+          },
+          limit: {
+            property: :Limit,
+            type: :Integer,
+            required: false,
+          },
+          name: {
+            property: :Name,
+            type: :String,
+            required: false,
+          },
+          sku: {
+            property: :Sku,
+            type: :String,
+            required: false,
+          },
+          modified_since: {
+            property: :ModifiedSince,
+            type: :DateTime,
+            required: false,
+          },
+          include_deprecated: {
+            property: :IncludeDeprecated,
+            type: :Boolean,
+            required: false,
+          },
+          include_bom: {
+            property: :IncludeBOM,
+            type: :Boolean,
+            required: false,
+          },
+          include_suppliers: {
+            property: :IncludeSuppliers,
+            type: :Boolean,
+            required: false,
+          },
+          include_movements: {
+            property: :IncludeMovements,
+            type: :Boolean,
+            required: false,
+          },
+          include_attachments: {
+            property: :IncludeAttachments,
+            type: :Boolean,
+            required: false,
+          },
+          include_reorder_levels: {
+            property: :IncludeReorderLevels,
+            type: :Boolean,
+            required: false,
+          }
+        )
+      end
+    end
+  end
+end

data/lib/dear_inventory/resources/product.rb

@@ -0,0 +1,24 @@
+# typed: strict
+# frozen_string_literal: true
+
+module DearInventory
+  class Product < Resource
+    class << self
+      extend T::Sig
+
+      # Product
+      #
+      # @param params [Hash] URL query string parameters that conform to
+      #   DearInventory::Parameters::Product::Index
+      sig do
+        params(params: T::Hash[Symbol, T.untyped]).
+          returns(DearInventory::Response)
+      end
+      def index(params = {})
+        new.request(
+          :get, params: params, model: DearInventory::Models::Products
+        )
+      end
+    end
+  end
+end

data/lib/dear_inventory/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module DearInventory
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dear_inventory
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Adam Rice
@@ -233,7 +233,12 @@ files:
 - lib/dear_inventory/models/additional_attributes.rb
 - lib/dear_inventory/models/address.rb
 - lib/dear_inventory/models/attachment.rb
+- lib/dear_inventory/models/bill_of_materials_product.rb
+- lib/dear_inventory/models/bill_of_materials_service.rb
 - lib/dear_inventory/models/inventory_movement.rb
+- lib/dear_inventory/models/product.rb
+- lib/dear_inventory/models/products.rb
+- lib/dear_inventory/models/products/movement.rb
 - lib/dear_inventory/models/purchase.rb
 - lib/dear_inventory/models/purchase_list.rb
 - lib/dear_inventory/models/purchase_lists.rb
@@ -250,6 +255,7 @@ files:
 - lib/dear_inventory/models/purchases/stock.rb
 - lib/dear_inventory/models/purchases/stock_line.rb
 - lib/dear_inventory/models/purchases/unstock_line.rb
+- lib/dear_inventory/models/reorder_level.rb
 - lib/dear_inventory/models/request.rb
 - lib/dear_inventory/models/sale.rb
 - lib/dear_inventory/models/sale_list.rb
@@ -271,13 +277,16 @@ files:
 - lib/dear_inventory/models/sales/payment_line.rb
 - lib/dear_inventory/models/sales/quote.rb
 - lib/dear_inventory/models/shipping_address.rb
+- lib/dear_inventory/models/supplier.rb
 - lib/dear_inventory/models/transaction.rb
 - lib/dear_inventory/parameters.rb
+- lib/dear_inventory/parameters/product/index.rb
 - lib/dear_inventory/parameters/purchase/index.rb
 - lib/dear_inventory/parameters/purchase_list/index.rb
 - lib/dear_inventory/parameters/sale/index.rb
 - lib/dear_inventory/parameters/sale_list/index.rb
 - lib/dear_inventory/resource.rb
+- lib/dear_inventory/resources/product.rb
 - lib/dear_inventory/resources/purchase.rb
 - lib/dear_inventory/resources/purchase_list.rb
 - lib/dear_inventory/resources/sale.rb