dear_inventory 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d2cff2061b63178640316ee94c2d2f755e00f6840c9c95254eff1da695dfdfe
-  data.tar.gz: da3f9d8d7bae5cb2626e69c17a26ed4eec5c3684246a84857ecbfbc8c0ee1d05
+  metadata.gz: 4517ad48f4b5c66087e36b25e56af1319fd404d9872f2aa1d205293e69f5dfb7
+  data.tar.gz: 03cf1a5cfb5f3e823368073bdeab88032fc365574617364a706fca5c44b283f7
 SHA512:
-  metadata.gz: 6b0c98e95c9674ed1f3179a6f95f955b9dfd27456fb708e703f01e421e6c6be18290a630e7be574a5d30befe92f7ac23af2090572b48aba6b7cd48b2e1bb11a8
-  data.tar.gz: b5602ee55a9dd359de1ddd8de3e5185ccf85283a53de760bfa78b60b3d6e5febbdd57a8dd4a8b048d76f3d8d10ca22de8620fe87066d8d6bda6403e5941a0d22
+  metadata.gz: 4568639a86a8aa82a7a75f8d51de75354107a04ac306cdf7383a4d78160f14210dbbecba98ff1974554f809fc74c4f0cb9c59822101ee82047fcd01040132e19
+  data.tar.gz: e7cbb91397ac2fe478b4d4f4f10da7fcd2823412bf89c9579f2e5b50c93ce622aa627b6a9e2f033351de780aa8fbecde44666bb2f1a7f25454dce22487050ff7

data/dear_inventory.gemspec

@@ -28,12 +28,13 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "http", ">= 4.0.0", "< 5.0"
+  spec.add_dependency "http", ">= 5.0", "< 6.0"
   spec.add_dependency "sorbet-runtime"
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rubocop", "~> 0.71"

data/docs/resources/sale.md

@@ -87,3 +87,31 @@ response.fields # [:id, :customer, :customer_id, :contact, :phone, :email, :defa
 id = response.id # abcdef01-2345-6789-abcd-ef0123456789
 ```
 
+
+
+## Delete DELETE
+
+```ruby
+DearInventory::Sale.delete
+```
+
+### Parameters
+
+| Name | Type | Required | Default |
+| --- | --- | --- | --- |
+| id | String | true | N/A |
+| void | Boolean | false | false |
+
+### Response
+
+A new copy of the record is returned. To see what data is available in the
+response, you can call the `field` method:
+
+```ruby
+response = DearInventory::Sale.delete(
+  id: "abcdef01-2345-6789-abcd-ef0123456789",
+  void: true
+)
+response.fields # [:id, :customer, :customer_id, :contact, :phone, :email, :default_account, :skip_quote, :billing_address, :shipping_address, :base_currency, :customer_currency, :tax_rule, :tax_calculation, :terms, :price_tier, :ship_by, :location, :sale_order_date, :last_modified_on, :note, :customer_reference, :cogs_amount, :status, :combined_picking_status, :combined_packing_status, :combined_shipping_status, :fulfilment_status, :combined_invoice_status, :combined_payment_status, :combined_tracking_numbers, :carrier, :currency_rate, :sales_representative, :type, :source_channel, :external_id, :service_only, :quote, :order, :fulfilments, :invoices, :credit_notes, :manual_journals, :additional_attributes, :attachments, :inventory_movements, :transactions]
+id = response.id # abcdef01-2345-6789-abcd-ef0123456789
+```

data/lib/dear_inventory/lib/request.rb

@@ -58,7 +58,7 @@ module DearInventory
         returns(T::Hash[Symbol, T::Hash[Symbol, T.untyped]])
     end
     def request_params(action, params)
-      if action == :get
+      if %i[get delete].include?(action)
         { params: params.to_h }
       else
         { json: params.to_h }

data/lib/dear_inventory/parameters/sale/delete.rb

@@ -0,0 +1,25 @@
+# typed: strict
+# frozen_string_literal: true
+
+module DearInventory
+  class Parameters
+    module Sale
+      class Delete < DearInventory::Parameters
+        extend T::Sig
+
+        fields(
+          id: {
+            property: :ID,
+            type: :String,
+            required: true,
+          },
+          void: {
+            property: :Void,
+            type: :Boolean,
+            required: false,
+          }
+        )
+      end
+    end
+  end
+end

data/lib/dear_inventory/resources/sale.rb

@@ -41,6 +41,23 @@ module DearInventory
           params: params
         )
       end
+
+      # Sale
+      #
+      # @param params [Hash] URL query string parameters that conform to
+      #   DearInventory::Parameters::Sale::Delete
+      sig do
+        params(params: T::Hash[Symbol, T.untyped]).
+          returns(DearInventory::Response)
+      end
+      def delete(params = {})
+        new.request(
+          :delete,
+          endpoint: "delete",
+          model: DearInventory::Models::Sale,
+          params: params
+        )
+      end
     end
 
     private
@@ -49,9 +66,9 @@ module DearInventory
     def resource_uri(endpoint)
       case endpoint
       when "index"
-        self.class.const_get(:URI_BASE) + "/salelist"
-      when "show"
-        self.class.const_get(:URI_BASE) + "/sale"
+        "#{self.class.const_get(:URI_BASE)}/salelist"
+      when "show", "delete"
+        "#{self.class.const_get(:URI_BASE)}/sale"
       end
     end
   end

data/lib/dear_inventory/version.rb

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

data/lib/dear_inventory.rb

@@ -106,6 +106,7 @@ require "dear_inventory/parameters/product/index"
 require "dear_inventory/parameters/product_availability/index"
 require "dear_inventory/parameters/purchase/index"
 require "dear_inventory/parameters/purchase/show"
+require "dear_inventory/parameters/sale/delete"
 require "dear_inventory/parameters/sale/index"
 require "dear_inventory/parameters/sale/show"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dear_inventory
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Adam Rice
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-18 00:00:00.000000000 Z
+date: 2022-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +86,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -312,6 +326,7 @@ files:
 - lib/dear_inventory/parameters/product_availability/index.rb
 - lib/dear_inventory/parameters/purchase/index.rb
 - lib/dear_inventory/parameters/purchase/show.rb
+- lib/dear_inventory/parameters/sale/delete.rb
 - lib/dear_inventory/parameters/sale/index.rb
 - lib/dear_inventory/parameters/sale/show.rb
 - lib/dear_inventory/resource.rb
@@ -381,7 +396,7 @@ homepage: https://morningcoffee.com.au
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -396,8 +411,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.8.11
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Library for connecting to the DEAR Inventory API
 test_files: []