erp_integration 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad3730a4402988984abd10fe810f4865cfee54f4dbc432bfbd43aaf8417153ec
-  data.tar.gz: 1735fdccbea6c4b29ab44f01d8a07965f0acf0c5d4c30ae55a5a082b8fd2df1d
+  metadata.gz: 19d5fb57d7ca6ad94580985e3e975ef8555b6714eacd49d7f2bb66e41e9a7543
+  data.tar.gz: 22deb33aa1b45b3b335148833bdf94005eea41dda91fd1fc36bb1982c2718b8a
 SHA512:
-  metadata.gz: 4cb38e50117fe3ac7ce1da2a3bcddd7446d34aa51b75401bf9f188fab95a7f641a4cc308420bdbd018501633683c4fc96ebb258feb037cda7e3bd6b3315f5b46
-  data.tar.gz: 314fab0d17387b28df68fc5686c54902d5a73e6b646e460abaadfcca940fb719ffc013af602064f5923c15ab37604612d45e81ad39b7cf966d64cb06ad87b4eb
+  metadata.gz: 2969f577bdcd23953294f8cdc8a241d155df50c5c80b07a306dec6c4475b0b8cf9174533c1400f66301431ed135a8278eea8b3852fec5fc8774efb6c5f5574c4
+  data.tar.gz: f54f021988ac6cbd26f17456be8cdb6ff82a9bbf5e89435e94c9cde319ada19da63b61ae08e081020653feeefa1fc9cabde894394d0f82f4bc47458021fe9f05

data/lib/erp_integration/configuration.rb

@@ -43,16 +43,16 @@ module ErpIntegration
     # @return [Symbol] The configured adapter for the bill_of_material.
     attr_writer :bill_of_material_output_adapter
 
-    # Allows configuring an adapter for the `Country` resource. When
-    # none is configured, it will default to Fulfil.
-    # @return [Symbol] The configured adapter for the country.
-    attr_writer :country_adapter
-
     # Allows configuring an adapter for the `ChannelListing` resource. When
     # none is configured, it will default to Fulfil.
     # @return [Symbol] The configured adapter for the channel_listing.
     attr_writer :channel_listing_adapter
 
+    # Allows configuring an adapter for the `Country` resource. When
+    # none is configured, it will default to Fulfil.
+    # @return [Symbol] The configured adapter for the country.
+    attr_writer :country_adapter
+
     # Allows configuring an adapter for the `CustomerShipment` resource. When
     # none is configured, it will default to Fulfil.
     # @return [Symbol] The configured adapter for the customer shipment.
@@ -63,6 +63,11 @@ module ErpIntegration
     # @return [Symbol] The configured adapter for the customer shipment.
     attr_writer :customer_shipment_return_adapter
 
+    # Allows configuring an adapter for the `GiftCard` resource. When
+    # none is configured, it will default to Fulfil.
+    # @return [Symbol] The configured adapter for the gift card.
+    attr_writer :gift_card_adapter
+
     # Allows configuring an adapter for the `InternalShipment` resource.
     # When none is configured, it will default to Fulfil.
     # @return [Symbol] The configured adapter for the internal shipment.
@@ -73,6 +78,11 @@ module ErpIntegration
     # @return [Symbol] The configured adapter for the location.
     attr_writer :location_adapter
 
+    # Allows configuring an adapter for the `PartyAddress` resource. When
+    # none is configured, it will default to Fulfil.
+    # @return [Symbol] The configured adapter for the party address.
+    attr_writer :party_address_adapter
+
     # Allows configuring an adapter for the `Product` resource. When none is
     # configured, it will default to Fulfil.
     # @return [Symbol] The configured adapter for the products.
@@ -83,6 +93,11 @@ module ErpIntegration
     # @return [Symbol] The configured adapter for the product category.
     attr_writer :product_category_adapter
 
+    # Allows configuring an adapter for the `ProductOption` resource. When
+    # none is configured, it will default to Fulfil.
+    # @return [Symbol] The configured adapter for the product option.
+    attr_writer :product_option_adapter
+
     # Allows configuring an adapter for the `ProductTemplate` resource. When none is
     # configured, it will default to Fulfil.
     # @return [Symbol] The configured adapter for the product templates.
@@ -105,7 +120,7 @@ module ErpIntegration
 
     # Allows configuring an adapter for the `PurchaseProductSupplier` resource. When
     # none is configured, it will default to Fulfil.
-    # @return [Symbol] The configured adapter for the purchase order lines.
+    # @return [Symbol] The configured adapter for the purchase product supplier.
     attr_writer :purchase_product_supplier_adapter
 
     # Allows configuring an adapter for the `PurchaseRequest` resource. When
@@ -113,6 +128,11 @@ module ErpIntegration
     # @return [Symbol] The configured adapter for the purchase request.
     attr_writer :purchase_request_adapter
 
+    # Allows configuring an adapter for the `SaleLineOption` resource. When
+    # none is configured, it will default to Fulfil.
+    # @return [Symbol] The configured adapter for the sales line option.
+    attr_writer :sales_line_option_adapter
+
     # Allows configuring an adapter for the `SalesOrder` resource. When none is
     # configured, it will default to Fulfil.
     # @return [Symbol] The configured adapter for the sales orders
@@ -120,19 +140,14 @@ module ErpIntegration
 
     # Allows configuring an adapter for the `SalesOrderLine` resource. When none is
     # configured, it will default to Fulfil.
-    # @return [Symbol] The configured adapter for the order lines.
+    # @return [Symbol] The configured adapter for the sales order lines.
     attr_writer :sales_order_line_adapter
 
     # Allows configuring an adapter for the `SalesReturnReason` resource. When none is
     # configured, it will default to Fulfil.
-    # @return [Symbol] The configured adapter for the order lines.
+    # @return [Symbol] The configured adapter for the sales return reason.
     attr_writer :sales_return_reason_adapter
 
-    # Allows configuring an adapter for the `SupplierShipment` resource. When
-    # none is configured, it will default to Fulfil.
-    # @return [Symbol] The configured adapter for the supplier shipment.
-    attr_writer :supplier_shipment_adapter
-
     # Allows configuring an adapter for the `StockBinTransfer` resource. When
     # none is configured, it will default to Fulfil.
     # @return [Symbol] The configured adapter for the stock bin transfer.
@@ -143,6 +158,11 @@ module ErpIntegration
     # @return [Symbol] The configured adapter for the stock move.
     attr_writer :stock_move_adapter
 
+    # Allows configuring an adapter for the `SupplierShipment` resource. When
+    # none is configured, it will default to Fulfil.
+    # @return [Symbol] The configured adapter for the supplier shipment.
+    attr_writer :supplier_shipment_adapter
+
     # Allows configuring an adapter for the `Task` resource. When
     # none is configured, it will default to Fulfil.
     # @return [Symbol] The configured adapter for the task.
@@ -153,26 +173,6 @@ module ErpIntegration
     # @return [Symbol] The configured adapter for the tracking number.
     attr_writer :tracking_number_adapter
 
-    # Allows configuring an adapter for the `GiftCard` resource. When
-    # none is configured, it will default to Fulfil.
-    # @return [Symbol] The configured adapter for the tracking number.
-    attr_writer :gift_card_adapter
-
-    # Allows configuring an adapter for the `SaleLineOption` resource. When
-    # none is configured, it will default to Fulfil.
-    # @return [Symbol] The configured adapter for the tracking number.
-    attr_writer :sales_line_option_adapter
-
-    # Allows configuring an adapter for the `PartyAddress` resource. When
-    # none is configured, it will default to Fulfil.
-    # @return [Symbol] The configured adapter for the tracking number.
-    attr_writer :party_address_adapter
-
-    # Allows configuring an adapter for the `ProductOption` resource. When
-    # none is configured, it will default to Fulfil.
-    # @return [Symbol] The configured adapter for the tracking number.
-    attr_writer :product_option_adapter
-
     def initialize(**options)
       options.each_pair do |key, value|
         public_send("#{key}=", value) if respond_to?("#{key}=")
@@ -183,14 +183,6 @@ module ErpIntegration
       @api_key_rotation_threshold = threshold || 0
     end
 
-    def carrier_adapter
-      @carrier_adapter || :fulfil
-    end
-
-    def carrier_service_adapter
-      @carrier_service_adapter || :fulfil
-    end
-
     def bill_of_material_adapter
       @bill_of_material_adapter || :fulfil
     end
@@ -207,14 +199,22 @@ module ErpIntegration
       @box_type_adapter || :fulfil
     end
 
-    def country_adapter
-      @country_adapter || :fulfil
+    def carrier_adapter
+      @carrier_adapter || :fulfil
+    end
+
+    def carrier_service_adapter
+      @carrier_service_adapter || :fulfil
     end
 
     def channel_listing_adapter
       @channel_listing_adapter || :fulfil
     end
 
+    def country_adapter
+      @country_adapter || :fulfil
+    end
+
     def customer_shipment_adapter
       @customer_shipment_adapter || :fulfil
     end
@@ -223,14 +223,34 @@ module ErpIntegration
       @customer_shipment_return_adapter || :fulfil
     end
 
+    def gift_card_adapter
+      @gift_card_adapter || :fulfil
+    end
+
     def internal_shipment_adapter
       @internal_shipment_adapter || :fulfil
     end
 
+    def inventory_by_location_report_adapter
+      @inventory_by_location_report_adapter || :fulfil
+    end
+
     def location_adapter
       @location_adapter || :fulfil
     end
 
+    def logger
+      @logger || Logger.new(nil)
+    end
+
+    def logger=(logger)
+      @logger = Logger.new(logger)
+    end
+
+    def party_address_adapter
+      @party_address_adapter || :fulfil
+    end
+
     def product_adapter
       @product_adapter || :fulfil
     end
@@ -239,6 +259,10 @@ module ErpIntegration
       @product_category_adapter || :fulfil
     end
 
+    def product_option_adapter
+      @product_option_adapter || :fulfil
+    end
+
     def product_template_adapter
       @product_template_adapter || :fulfil
     end
@@ -263,20 +287,32 @@ module ErpIntegration
       @purchase_request_adapter || :fulfil
     end
 
-    def sales_order_line_adapter
-      @sales_order_line_adapter || :fulfil
+    # Rate limiters that will be used for HTTP operations on Client
+    # to manage the number of requests made to avoid rate limiting by the API provider.
+    def rate_limiters
+      @rate_limiters ||= []
+    end
+
+    # Sets the rate limiters that will be used
+    # @raise [MissingMethodError] if the rate limiter object doesn't respond to the required methods.
+    def rate_limiters=(rate_limiters)
+      @rate_limiters = (rate_limiters || []).each { |limiter| RateLimiter.validate!(limiter) }
+    end
+
+    def sales_line_option_adapter
+      @sales_line_option_adapter || :fulfil
     end
 
     def sales_order_adapter
       @sales_order_adapter || :fulfil
     end
 
-    def sales_return_reason_adapter
-      @sales_return_reason_adapter || :fulfil
+    def sales_order_line_adapter
+      @sales_order_line_adapter || :fulfil
     end
 
-    def supplier_shipment_adapter
-      @supplier_shipment_adapter || :fulfil
+    def sales_return_reason_adapter
+      @sales_return_reason_adapter || :fulfil
     end
 
     def stock_bin_transfer_adapter
@@ -287,6 +323,10 @@ module ErpIntegration
       @stock_move_adapter || :fulfil
     end
 
+    def supplier_shipment_adapter
+      @supplier_shipment_adapter || :fulfil
+    end
+
     def task_adapter
       @task_adapter || :fulfil
     end
@@ -298,42 +338,6 @@ module ErpIntegration
     def webhook_adapter
       @webhook_adapter || :fulfil
     end
-
-    def gift_card_adapter
-      @gift_card_adapter || :fulfil
-    end
-
-    def sales_line_option_adapter
-      @sales_line_option_adapter || :fulfil
-    end
-
-    def party_address_adapter
-      @party_address_adapter || :fulfil
-    end
-
-    def product_option_adapter
-      @product_option_adapter || :fulfil
-    end
-
-    # Rate limiters that will be used for HTTP operations on Client
-    # to manage the number of requests made to avoid rate limiting by the API provider.
-    def rate_limiters
-      @rate_limiters ||= []
-    end
-
-    # Sets the rate limiters that will be used
-    # @raise [MissingMethodError] if the rate limiter object doesn't respond to the required methods.
-    def rate_limiters=(rate_limiters)
-      @rate_limiters = (rate_limiters || []).each { |limiter| RateLimiter.validate!(limiter) }
-    end
-
-    def logger
-      @logger || Logger.new(nil)
-    end
-
-    def logger=(logger)
-      @logger = Logger.new(logger)
-    end
   end
 
   # Returns ERP Integration's configuration.

data/lib/erp_integration/fulfil/resources/location.rb

@@ -7,6 +7,26 @@ module ErpIntegration
     module Resources
       class Location < ApiResource
         self.model_name = 'stock.location'
+
+        # Retrieve the inventory by location report.
+        #
+        # @param options [Hash] The options for the inventory by location report.
+        # @see https://docs.fulfil.io/developers/rest-api/examples/inventory-by-location
+        # @example
+        #   {
+        #     category: 123,
+        #     company: 1,
+        #     warehouse: 456,
+        #     product: 789,
+        #     level: "product",
+        #     variant: 000
+        #   }
+        #   report.execute(options)
+        #
+        # @return [Hash] The inventory by location report.
+        def inventory_by_location(options)
+          client.put('model/inventory.by_location.report/execute', [options])
+        end
       end
     end
   end

data/lib/erp_integration/location.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module ErpIntegration
-  # The `ErpIntegration::GiftCard` exposes an uniformed API for interaction with
+  # The `ErpIntegration:::Location` exposes an uniformed API for interaction with
   # third-party ERP vendors.
   class Location < Resource
     attr_accessor :id, :name, :parent, :type

data/lib/erp_integration/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ErpIntegration
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erp_integration
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Stefan Vermaas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-19 00:00:00.000000000 Z
+date: 2025-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport