qbo_api 2.0.2 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 162fa8b773e3b73b82ea03e73d06ded342f6ac3bc7daafc9c02cc6a965a34aa7
-  data.tar.gz: a074c58fe2826531c2fe7a04cee0fecaf4021aac7e2c9a64fc30062fd3602fd5
+  metadata.gz: a9e249e7e48339a74b585f7afd97711407c8b814c0670e417b4792b465e59515
+  data.tar.gz: ef17013bf8fd40513f0f4ddb7ffa9653baa2b686f7091a1ba82a8f0cfb79e9ed
 SHA512:
-  metadata.gz: 29a5b45354f2dbd9978fee3498dbfa96b660c6c747b93432b00836079f64e35d1448463ba13f055fc866e85804981f0a8110b6a429f23fc118da8a9f732d003b
-  data.tar.gz: f733937e458917500539ad443c8bfe61d29584b00caa2d8b7824d525170d2058806a7ad5e6a6a485ac05a6adf45be18feed8afff53372a7b7f643dd1fa1d40c2
+  metadata.gz: c31a1c1e627e8f1677323d74e959bb377338984c8cd73c49ebdb95253a97986e7634e20ced251a67e18321bda1827d67e759add75dece2bcb052b2411132bcba
+  data.tar.gz: b8c46643f89b9be3e285dd4d8e9bf030af7b75b3872e21937afc6d0c5bfbe59c23038e9bc4431f1efa762888f408d240dd0149c4035f9e19a35ee63c1dbf2847

data/README.md

@@ -372,8 +372,8 @@ for how to install ngrok and what it is.
   Add the token to your .env as QBO_API_VERIFIER_TOKEN
 
 - In another tab, create a customer via the API:
-  `bundle exec ruby -rqbo_api -rdotenv -e 'Dotenv.load; p QboApi.new(access_token: ENV.fetch("QBO_API_OAUTH2_ACCESS_TOKEN"), realm_id: ENV.fetch("QBO_API_COMPANY_ID")).create(:customer, payload: { DisplayName: "TestCustomer" })'`
-  (You'll also need to have added the QBO_API_COMPANY_ID and QBO_API_OAUTH2_ACCESS_TOKEN to your .env)
+  `bundle exec ruby -rqbo_api -rdotenv -e 'Dotenv.load; p QboApi.new(access_token: ENV.fetch("QBO_API_ACCESS_TOKEN"), realm_id: ENV.fetch("QBO_API_COMPANY_ID")).create(:customer, payload: { DisplayName: "TestCustomer" })'`
+  (You'll also need to have added the QBO_API_COMPANY_ID and QBO_API_ACCESS_TOKEN to your .env)
 
   There could be a delay of up to a minute before the webhook fires.
 

data/example/base.rb

@@ -3,6 +3,7 @@ BASE_GEMS = proc do
   # This app
   gem 'sinatra'
   gem 'sinatra-contrib'
+  gem 'puma'
 
   # Creds from ../.env
   gem 'dotenv'

data/lib/qbo_api/api_methods.rb

@@ -58,6 +58,14 @@ class QboApi
       request(:post, entity: entity, path: entity_path(entity), payload: payload)
     end
 
+    def void(entity, id:)
+      err_msg = "Void is only for voidable transaction entities. Use .delete or .deactivate instead"
+      raise QboApi::NotImplementedError.new, err_msg unless is_voidable_transaction_entity?(entity)
+      path = add_params_to_path(path: entity_path(entity), params: { operation: :void })
+      payload = set_update(entity, id)
+      request(:post, entity: entity, path: path, payload: payload)
+    end
+
     private
 
     def get_query_str(entity, query_filter_args)

data/lib/qbo_api/entity.rb

@@ -20,6 +20,19 @@ class QboApi
       sym.to_s.split('_').collect(&:capitalize).join
     end
 
+    def is_voidable_transaction_entity?(entity)
+      voidable_transaction_entities.include?(singular(entity))
+    end
+
+    def voidable_transaction_entities
+      %w{
+        BillPayment
+        Invoice
+        Payment
+        SalesReceipt
+      }
+    end
+
     def is_transaction_entity?(entity)
       transaction_entities.include?(singular(entity))
     end

data/lib/qbo_api/version.rb

@@ -1,3 +1,3 @@
 class QboApi
-  VERSION = "2.0.2"
+  VERSION = "2.1.1"
 end

data/qbo_api.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'dotenv'
   spec.add_development_dependency 'vcr'
   spec.add_development_dependency 'amazing_print'
-  spec.add_runtime_dependency 'faraday'
+  spec.add_runtime_dependency 'faraday', '~> 1.10.0'
   spec.add_runtime_dependency 'faraday_middleware'
   spec.add_runtime_dependency 'faraday-detailed_logger'
   spec.add_runtime_dependency 'nokogiri'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qbo_api
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.1
 platform: ruby
 authors:
 - Christian Pelczarski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-13 00:00:00.000000000 Z
+date: 2022-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,16 +112,16 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.10.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement