quaderno 2.1.3 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b72b840488a77aa9debc644d902aa6ce0aadbaa1019decc45f8e39647a15348
-  data.tar.gz: 9c9fb8d00bfa50a463a7becb9fb67dc604778f657f02f34e7b8723ad67978f4d
+  metadata.gz: 110d06dbefd7137c90b3446ba4fbd0e6cb967e215244de1c7a1f54d9beecf46c
+  data.tar.gz: 5f484fa04535448a06fd960e0656ab29b1abefea9db2dfa7e672f83511891af4
 SHA512:
-  metadata.gz: 78ac1a824eefa80f83c1b66f60cc3ea01ab4ef8788cab8a393cf840ccbbd3c1c2ff2cd8326eabd90baccf1731c10b4ae8fa00e372d03e50f883065e1dfdde604
-  data.tar.gz: 0e9fbc1193e4ecaf2b18fed0809ab3c0895bac882fed76fbcfe0ece38d969cc68ed534971eaf9120bb5d8984a921c96e56ebb1a03c996f1cbd9f8fcaf0c7d408
+  metadata.gz: 925cbcdacf1bfa00b11c3b3f3e9f5791da6295f550d1feac7dd37d00dc2d5963752840c66cfb9e88d9e56d6e6d1fe4175ba4a1c084b83ba295971862056e0d64
+  data.tar.gz: 5439f1cb10b38539450c5351a256117fa39d906245a985533fc56a49d78ce456634aa1963f97fcbef57ce0f28227082a717b154618d987e3f5cd857e4c434552

data/.github/workflows/test.yml

@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.5', '2.6', '2.7', '3.0']
+        ruby-version: ['2.7', '3.0']
 
     steps:
     - uses: actions/checkout@v2

data/.gitignore

@@ -1,3 +1,6 @@
+# byebug generated
+.byebug_history
+
 # rcov generated
 coverage
 coverage.data

data/README.md

@@ -1,8 +1,10 @@
 # quaderno-ruby
 
-Quaderno-ruby is a ruby wrapper for [Quaderno API] (https://github.com/quaderno/quaderno-api).
+Quaderno-ruby is a ruby wrapper for the [Quaderno API](https://developers.quaderno.io/api).
 
-Current version is 2.1.2 See the changelog [here](https://github.com/quaderno/quaderno-ruby/blob/master/changelog.md)
+Current version is 3.0.0 → See the changelog [here](https://github.com/quaderno/quaderno-ruby/blob/master/changelog.md).
+
+To learn more about our API and ecosystem, check [developers.quaderno.io](https://developers.quaderno.io).
 
 ## Installation & Configuration
 
@@ -23,7 +25,11 @@ To configure just add this to your initializers
   end
 ```
 
-**1.7.1 Breaking changes:** If you are using a configuration based on versions `< '1.7.1'`, you will notice that the old configuration no longer works, so please update your configuration or specify the `1.7.0` version.
+## Quaderno Sandbox
+
+Quaderno Sandbox is our public staging environment, a safe space to experiment with our set of APIs and products. As a complete separate environment, it has it's own URL https://sandbox-quadernoapp.com and credentials.
+
+It's perfect for your first steps with our tools. Please check https://developers.quaderno.io/dev_tools/sandbox to learn about its test data and limitations.
 
 ## Get authorization data
 
@@ -34,12 +40,13 @@ You can get your account subdomain by grabbing it from your account url or by ca
   response.identity # => {"id"=>737000, "name"=>"Walter White", "email"=>"cooking@br.bd", "href"=>"https://my_subdomain.quadernoapp.com/api/"}
 ```
 
-`environment` is an optional argument. By passing `:sandbox`, you will retrieve your credentials for the sandbox environment and not for production.
+Note that `environment` is an optional argument. By passing `:sandbox`, you will retrieve your credentials for the sandbox environment and not for production.
 
 This will return a hash with the information about your api url, which includes the account subdomain.
 
 ## Ping the service
- You can ping the service in order to check if it is up with:
+
+You can ping the service in order to check if it is up with:
 
 ```ruby
   response = Quaderno::Base.ping #=> Quaderno::Base
@@ -57,7 +64,7 @@ This will return `status: true` if the service is up or `status: false` if it is
 
 ```
 
-This will return a hash with information about the seconds until the rate limit reset and your remaining requests per minute ([check the API documentation for more information](https://github.com/quaderno/quaderno-api#rate-limiting)).
+This will return a hash with information about the seconds until the rate limit reset and your remaining requests per minute ([check the API documentation for more information](https://developers.quaderno.io/api#tag/API-features/Rate-Limiting)).
 
 You can also check the rate limit for each request by checking the `rate_limit_info` method on the response:
 
@@ -98,6 +105,7 @@ Quaderno-ruby parses all the json responses in human readable data, so you can a
 ## Managing contacts
 
 ### Getting contacts
+
 ```ruby
  Quaderno::Contact.all #=> Array
 ```
@@ -109,6 +117,7 @@ Quaderno-ruby parses all the json responses in human readable data, so you can a
 ```
 
 ### Finding a contact
+
 ```ruby
  Quaderno::Contact.find(id) #=> Quaderno::Contact
 ```
@@ -116,15 +125,15 @@ Quaderno-ruby parses all the json responses in human readable data, so you can a
 will return the contact with the id passed as parameter.
 
 ### Retrieving a contact by its payment gateway customer ID
+
 ```ruby
  Quaderno::Contact.retrieve(PAYMENT_GATEWAY_CUSTOMER_ID, PAYMENT_GATEWAY) #=> Quaderno::Contact
 ```
-will return the contact with the customer id passed as parameter.
-
-*_Note_: `Quaderno::Contact.retrieve_customer` has been deprecated in favor of `Quaderno::Contact.retrieve`
 
+will return the contact with the customer id passed as parameter.
 
 ### Creating a new contact
+
 ```ruby
  Quaderno::Contact.create(params) #=> Quaderno::Contact
 ```
@@ -132,6 +141,7 @@ will return the contact with the customer id passed as parameter.
 will create a contact using the information of the hash passed as parameter and return an instance of Quaderno::Contact with the created contact.
 
 ### Updating an existing contact
+
 ```ruby
  Quaderno::Contact.update(id, params) #=> Quaderno::Contact
 ```
@@ -139,6 +149,7 @@ will create a contact using the information of the hash passed as parameter and
 will update the specified contact with the data of the hash passed as second parameter.
 
 ### Deleting a contact
+
 ```ruby
   Quaderno::Contact.delete(id) #=> Quaderno::Contact
 ```
@@ -148,6 +159,7 @@ will delete the contact with the id passed as parameter. If the deletion was suc
 ## Managing items
 
 ### Getting items
+
 ```ruby
   Quaderno::Item.all #=> Array
 ```
@@ -155,6 +167,7 @@ will delete the contact with the id passed as parameter. If the deletion was suc
 will return an array with all your items.
 
 ### Finding an item
+
 ```ruby
   Quaderno::Item.find(id) #=> Quaderno::Item
 ```
@@ -162,6 +175,7 @@ will return an array with all your items.
 will return the items with the id passed as parameter.
 
 ### Creating a new item
+
 ```ruby
  Quaderno::Item.create(params) #=> Quaderno::Item
 ```
@@ -169,6 +183,7 @@ will return the items with the id passed as parameter.
 will create an item using the information of the hash passed as parameter and return an instance of Quaderno::Item with the created contact.
 
 ### Updating an existing item
+
 ```ruby
  Quaderno::Item.update(id, params) #=> Quaderno::Item
 ```
@@ -176,16 +191,27 @@ will create an item using the information of the hash passed as parameter and re
 will update the specified item with the data of the hash passed as second parameter.
 
 ### Deleting an item
+
 ```ruby
   Quaderno::Item.delete(id) #=> Quaderno::Item
 ```
 
 will delete the item with the id passed as parameter.  If the deletion was successful, an instance of `Quaderno::Item` with the `deleted` attribute set to `true` will be returned.
 
+## Managing transactions
+
+### Creating a new transaction
+
+```ruby
+  Quaderno::Transaction.create(params) #=> Quaderno::Transaction
+```
+
+will create a sale or refund transaction using the information of the hash passed as parameter.
 
 ## Managing invoices
 
 ### Getting invoices
+
 ```ruby
   Quaderno::Invoice.all #=> Array
 ```
@@ -193,6 +219,7 @@ will delete the item with the id passed as parameter.  If the deletion was succe
  will return an array with all your invoices. You can also pass query strings using the attribute :q in order to filter the results by contact name, :state to filter by state or :date to filter by date
 
 ### Finding an invoice
+
 ```ruby
   Quaderno::Invoice.find(id) #=> Quaderno::Invoice
 ```
@@ -200,11 +227,12 @@ will delete the item with the id passed as parameter.  If the deletion was succe
 will return the invoice with the id passed as parameter.
 
 ### Retrieving an invoice by its payment gateway transaction ID
+
 ```ruby
  Quaderno::Invoice.retrieve(PAYMENT_GATEWAY_TRANSACTION_ID, PAYMENT_GATEWAY) #=> Quaderno::Invoice
 ```
-will return the invoice with the transaction id passed as parameter.
 
+will return the invoice with the transaction id passed as parameter.
 
 ### Creating a new invoice
 
@@ -215,6 +243,7 @@ will return the invoice with the transaction id passed as parameter.
 will create an invoice using the information of the hash passed as parameter.
 
 ### Updating an existing invoice
+
 ```ruby
   Quaderno::Invoice.update(id, params) #=> Quaderno::Invoice
 ```
@@ -229,9 +258,9 @@ will update the specified invoice with the data of the hash passed as second par
 
 will delete the invoice with the id passed as parameter. If the deletion was successful, an instance of `Quaderno::Item` with the `deleted` attribute set to `true` will be returned.
 
+### Adding or removing a payment
 
-###Adding or removing a payment
- In order to  add a payment you will need the Invoice instance you want to update.
+In order to  add a payment you will need the Invoice instance you want to update.
 
 ```ruby
   invoice = Quaderno::Invoice.find(invoice_id)
@@ -261,6 +290,7 @@ In order to  remove a payment you will need the Invoice instance you want to upd
 ## Managing credits
 
 ### Getting credits
+
 ```ruby
   Quaderno::Credit.all #=> Array
 ```
@@ -268,6 +298,7 @@ In order to  remove a payment you will need the Invoice instance you want to upd
  will return an array with all your credit notes. You can also pass query strings using the attribute :q in order to filter the results by contact name, :state to filter by state or :date to filter by date
 
 ### Finding a credit
+
 ```ruby
   Quaderno::Credit.find(id) #=> Quaderno::Credit
 ```
@@ -275,9 +306,11 @@ In order to  remove a payment you will need the Invoice instance you want to upd
 will return the credit with the id passed as parameter.
 
 ### Retrieving a credit by its payment gateway transaction ID
+
 ```ruby
  Quaderno::Credit.retrieve(PAYMENT_GATEWAY_TRANSACTION_ID, PAYMENT_GATEWAY) #=> Quaderno::Credit
 ```
+
 will return the credit note with the transaction id passed as parameter.
 
 ### Creating a new credit
@@ -289,6 +322,7 @@ will return the credit note with the transaction id passed as parameter.
 will create a credit from the invoice specified in the parameter.
 
 ### Updating an existing credit
+
 ```ruby
   Quaderno::Credit.update(id, params) #=> Quaderno::Credit
 ```
@@ -303,8 +337,8 @@ will update the specified credit with the data of the hash passed as second para
 
 will delete the credit with the id passed as parameter. If the deletion was successful, an instance of `Quaderno::Credit` with the `deleted` attribute set to `true` will be returned.
 
-
 ### Adding or removing a payment
+
  In order to  add a payment you will need the Credit instance you want to update.
 
 ```ruby
@@ -334,11 +368,10 @@ If the deletion was successful, an instance of `Quaderno::Payment` with the `del
   result.success #=> Boolean
 ```
 
-
 ## Managing estimates
 
-
 ### Getting estimates
+
 ```ruby
   Quaderno::Estimate.all #=> Array
 ```
@@ -346,6 +379,7 @@ If the deletion was successful, an instance of `Quaderno::Payment` with the `del
  will return an array with all your estimates.
 
 ### Finding an estimate
+
 ```ruby
   Quaderno::Estimate.find(id) #=> Quaderno::Estimate
 ```
@@ -361,6 +395,7 @@ will return the estimate with the id passed as parameter.
 will create an estimate using the information of the hash passed as parameter.
 
 ### Updating an existing estimate
+
 ```ruby
   Quaderno::Estimate.update(id, params)
 ```
@@ -375,9 +410,9 @@ will update the specified estimate with the data of the hash passed as second pa
 
 will delete the estimate with the id passed as parameter. If the deletion was successful, an instance of `Quaderno::Contact` with the `deleted` attribute set to `true` will be returned.
 
+### Adding or removing a payment
 
-###Adding or removing a payment
- In order to add a payment you will need the estimate you want to update.
+In order to add a payment you will need the estimate you want to update.
 
 ```ruby
   estimate = Quaderno::Estimate.find(estimate_id)
@@ -394,7 +429,8 @@ In order to  remove a payment you will need the estimate you want to update.
 ```
 
 ### Delivering the estimate
-  In order to deliver the estimate to the default recipient you will need the estimate you want to send.
+
+In order to deliver the estimate to the default recipient you will need the estimate you want to send.
 
 ```ruby
   estimate = Quaderno::Estimate.find(estimate_id)
@@ -403,10 +439,10 @@ In order to  remove a payment you will need the estimate you want to update.
   result.success #=> Boolean
 ```
 
-
 ## Managing expenses
 
 ### Getting expenses
+
 ```ruby
  Quaderno::Expense.all #=> Array
 ```
@@ -414,6 +450,7 @@ In order to  remove a payment you will need the estimate you want to update.
  will return an array with all your expenses. You can also pass query strings using the attribute :q in order to filter the results by contact name, :state to filter by state or :date to filter by date.
 
 ### Finding an expense
+
 ```ruby
  Quaderno::Expense.find(id) #=> Quaderno::Expense
 ```
@@ -421,6 +458,7 @@ In order to  remove a payment you will need the estimate you want to update.
 will return the expense with the id passed as parameter.
 
 ### Creating a new expense
+
 ```ruby
  Quaderno::Expense.create(params) #=> Quaderno::Expense
 ```
@@ -428,6 +466,7 @@ will return the expense with the id passed as parameter.
 will create an expense using the information of the hash passed as parameter and return an instance of Quaderno::Expense with the created expense.
 
 ### Updating an existing expense
+
 ```ruby
  Quaderno::Expense.update(id, params) #=> Quaderno::Expense
 ```
@@ -435,16 +474,17 @@ will create an expense using the information of the hash passed as parameter and
 will update the specified expense with the data of the hash passed as second parameter.
 
 ### Deleting an expense
+
 ```ruby
   Quaderno::Expense.delete(id) #=> Quaderno::Expense
 ```
 
 will delete the expense with the id passed as parameter. If the deletion was successful, an instance of `Quaderno::Expense` with the `deleted` attribute set to `true` will be returned.
 
-
 ## Managing recurrings
 
 ### Getting recurrings
+
 ```ruby
   Quaderno::Recurring.all #=> Array
 ```
@@ -452,6 +492,7 @@ will delete the expense with the id passed as parameter. If the deletion was suc
  will return an array with all your recurring notes. You can also pass query strings using the attribute :q in order to filter the results by contact name, :state to filter by state or :date to filter by date
 
 ### Finding a recurring
+
 ```ruby
   Quaderno::Recurring.find(id) #=> Quaderno::Recurring
 ```
@@ -467,6 +508,7 @@ will return the recurring with the id passed as parameter.
 will create a recurring using the information of the hash passed as parameter.
 
 ### Updating an existing recurring
+
 ```ruby
   Quaderno::Recurring.update(id, params) #=> Quaderno::Recurring
 ```
@@ -481,10 +523,10 @@ will update the specified recurring with the data of the hash passed as second p
 
 will delete the recurring with the id passed as parameter. If the deletion was successful, an instance of `Quaderno::Recurring` with the `deleted` attribute set to `true` will be returned.
 
-
 ## Managing webhooks
 
 ### Getting webhooks
+
 ```ruby
  Quaderno::Webhook.all #=> Array
 ```
@@ -492,6 +534,7 @@ will delete the recurring with the id passed as parameter. If the deletion was s
  will return an array with all the webhooks you have subscribed.
 
 ### Finding a webhook
+
 ```ruby
  Quaderno::Webhook.find(id) #=> Quaderno::Webhook
 ```
@@ -499,6 +542,7 @@ will delete the recurring with the id passed as parameter. If the deletion was s
 will return the webhook with the id passed as parameter.
 
 ### Creating a new webhook
+
 ```ruby
  Quaderno::Webhook.create(params) #=> Quaderno::Webhook
 ```
@@ -506,6 +550,7 @@ will return the webhook with the id passed as parameter.
 will create a webhook using the information of the hash passed as parameter and return an instance of Quaderno::Webhook with the created webhook.
 
 ### Updating an existing webhook
+
 ```ruby
  Quaderno::Webhook.update(id, params) #=> Quaderno::Webhook
 ```
@@ -513,27 +558,108 @@ will create a webhook using the information of the hash passed as parameter and
 will update the specified webhook with the data of the hash passed as second parameter.
 
 ### Deleting a webhook
+
 ```ruby
   Quaderno::Webhook.delete(id) #=> Quaderno::Webhook
 ```
-will delete the webhook with the id passed as parameter. If the deletion was successful, an instance of `Quaderno::Webhook` with the `deleted` attribute set to `true` will be returned.
 
+will delete the webhook with the id passed as parameter. If the deletion was successful, an instance of `Quaderno::Webhook` with the `deleted` attribute set to `true` will be returned.
 
-## Taxes
+## Tax rates
 
 ### Calculating taxes
+
 ```ruby
- Quaderno::Tax.calculate(params) #=> Quaderno::Tax
+ Quaderno::TaxRate.calculate(params) #=> Quaderno::TaxRate
 ```
 
 will calculate the taxes applied for a customer based on the data pased as parameters.
 
-### Validate tax ID
+## Tax jurisdictions
+
+### Listing tax jurisdictions
+
+```ruby
+ Quaderno::TaxJurisdiction.all #=> Array
+```
+
+ will return an array with all the tax jurisdictions supported in Quaderno.
+
+### Finding a tax jurisdiction
+
+```ruby
+ Quaderno::TaxJurisdiction.find(id) #=> Quaderno::TaxJurisdiction
+```
+
+will return the tax jurisdiction with the id passed as parameter.
+
+## Tax codes
+
+### Listing tax codes
+
+```ruby
+ Quaderno::TaxCode.all #=> Array
+```
+
+ will return an array with all the tax codes supported in Quaderno.
+
+### Finding a tax jurisdiction
+
+```ruby
+ Quaderno::TaxCode.find(id) #=> Quaderno::TaxCode
+```
+
+will return the tax code with the id passed as parameter.
+
+## Managing Tax ids
+
+### Getting tax ids
+
+```ruby
+ Quaderno::TaxId.all #=> Array
+```
+
+ will return an array with all the tax ids in the target account.
+
+### Finding a tax id
+
+```ruby
+ Quaderno::TaxId.find(id) #=> Quaderno::TaxId
+```
+
+will return the tax id with the id passed as parameter.
+
+### Adding a new tax id
+
+```ruby
+ Quaderno::TaxId.create(params) #=> Quaderno::TaxId
+```
+
+will create a tax id using the information of the hash passed as parameter and return an instance of Quaderno::TaxId with the created tax id.
+
+### Updating an existing tax id
+
+```ruby
+ Quaderno::TaxId.update(id, params) #=> Quaderno::TaxId
+```
+
+will update the specified tax id with the data of the hash passed as second parameter.
+
+### Deleting a tax id
+
+```ruby
+  Quaderno::TaxId.delete(id) #=> Quaderno::TaxId
+```
+
+will delete the tax id with the id passed as parameter. If the deletion was successful, an instance of `Quaderno::TaxId` with the `deleted` attribute set to `true` will be returned.
+
+### Validate a tax id
+
 ```ruby
  country = 'IE'
  tax_id = 'IE6388047V'
 
- result = Quaderno::Tax.validate_tax_id(country, tax_id) #=> Quaderno::Tax
+ result = Quaderno::TaxId.validate(country, tax_id) #=> Quaderno::TaxId
 
  result.valid #=> Boolean or nil
 ```
@@ -543,6 +669,7 @@ will validate the tax ID or business number for the specified country.
 ## Evidences
 
 ### Creating location evidences
+
 ```ruby
  Quaderno::Evidence.create(params) #=> Quaderno::Evidence
 ```
@@ -559,6 +686,7 @@ will create an evidence based on the data pased as parameters.
  will return an array with all the checkout sessions in your account.
 
 ### Finding a checkout session
+
 ```ruby
  Quaderno::CheckoutSession.find(id) #=> Quaderno::CheckoutSession
 ```
@@ -566,6 +694,7 @@ will create an evidence based on the data pased as parameters.
 will return the checkout session with the id passed as parameter.
 
 ### Creating a new checkout session
+
 ```ruby
  Quaderno::CheckoutSession.create(params) #=> Quaderno::CheckoutSession
 ```
@@ -573,6 +702,7 @@ will return the checkout session with the id passed as parameter.
 will create a checkout session using the information of the hash passed as parameter and return an instance of Quaderno::CheckoutSession with the created checout session.
 
 ### Updating an existing checkout session
+
 ```ruby
  Quaderno::CheckoutSession.update(id, params) #=> Quaderno::CheckoutSession
 ```
@@ -580,14 +710,17 @@ will create a checkout session using the information of the hash passed as param
 will update the specified checkout session with the data of the hash passed as second parameter.
 
 ### Deleting a checkout session
+
 ```ruby
   Quaderno::CheckoutSession.delete(id) #=> Quaderno::CheckoutSession
 ```
+
 will delete the checkout session with the id passed as parameter. If the deletion was successful, an instance of `Quaderno::CheckoutSession` with the `deleted` attribute set to `true` will be returned.
 
 ## Managing report requests
 
 ### Getting report requests
+
 ```ruby
   Quaderno::ReportRequest.all #=> Array
 ```
@@ -595,6 +728,7 @@ will delete the checkout session with the id passed as parameter. If the deletio
  will return an array with all your report requests.
 
 ### Finding a report request
+
 ```ruby
   Quaderno::ReportRequest.find(id) #=> Quaderno::ReportRequest
 ```
@@ -609,7 +743,93 @@ will return the report request with the id passed as parameter.
 
 will create a report request using the information of the hash passed as parameter and return an instance of Quaderno::ReportRequest with the created report request.
 
+## Connect: Managing custom accounts
+
+### Getting custom accounts
+
+```ruby
+  Quaderno::Account.all #=> Array
+```
+
+ will return an array with all your custom accounts
+
+### Finding a custom account
+
+```ruby
+  Quaderno::Account.find(id) #=> Quaderno::Account
+```
+
+will return the account with the id passed as parameter.
+
+### Creating a new custom account
+
+```ruby
+  Quaderno::Account.create(params) #=> Quaderno::Account
+```
+
+will create a custom account using the information of the hash passed as parameter.
+
+### Updating an existing custom account
+
+```ruby
+  Quaderno::Account.update(id, params) #=> Quaderno::Account
+```
+
+will update the specified custom account with the data of the hash passed as second parameter.
+
+### Deactivating a custom account
+
+```ruby
+  Quaderno::Account.deactivate(id) #=> Quaderno::Account
+```
+
+will deactivate the custom account with the id passed as parameter.
+
+### Activating a custom account
+
+```ruby
+  Quaderno::Account.activate(id) #=> Quaderno::Account
+```
+
+will activate the custom account with the id passed as parameter.
+
+## Connect: Managing addresses
+
+### Getting addresses
+
+```ruby
+  Quaderno::Address.all(access_token: ACCESS_TOKEN) #=> Array
+```
+
+ will return an array with all the addresses of the target custom account
+
+### Finding a address
+
+```ruby
+  Quaderno::Address.find(id, access_token: ACCESS_TOKEN) #=> Quaderno::Address
+```
+
+will return the address with the id passed as parameter.
+
+### Creating a new address
+
+```ruby
+  Quaderno::Address.create(params.merge(access_token: ACCESS_TOKEN)) #=> Quaderno::Address
+```
+
+will add an address on the target custom account using the information of the hash passed as parameter.
+
+### Updating an existing address
+
+```ruby
+  Quaderno::Address.update(id, params.merge(access_token: ACCESS_TOKEN)) #=> Quaderno::Address
+```
+
+will update the specified address with the data of the hash passed as second parameter.
+
+
 ## Exceptions
+
 Quaderno-ruby exceptions raise depending on the type of error:
 
 ```ruby
@@ -619,6 +839,8 @@ Quaderno-ruby exceptions raise depending on the type of error:
 
   Quaderno::Exceptions::InvalidID # Raised when the requested resource by ID does not exist in the account context.
 
+  Quaderno::Exceptions::InvalidRequest # Raised when the requested requirements are not fulfilled.
+
   Quaderno::Exceptions::ThrottleLimitExceeded # Raised when the throttle limit is exceeded.
 
   Quaderno::Exceptions::RateLimitExceeded # Raised when the rate limit is exceeded.
@@ -632,7 +854,19 @@ Quaderno-ruby exceptions raise depending on the type of error:
 
 All those exceptions inherit from `Quaderno::Exceptions::BaseException`.
 
+You can inspect a the error response from the API by rescuing the exception and checking `response_body`:
+
+```ruby
+begin
+  Quaderno::Invoice.find WRONG_ID
+rescue Quaderno::Exceptions::BaseException => e
+  e.response_body # =>  {"error"=>"Unauthorized access or document does not exist."}
+end
+```
+
+
 ### Pagination information
+
 Whenever you call the `all` method on one of the classes, the result will be a `Quaderno::Collection`. For example:
 
 ```ruby
@@ -701,9 +935,14 @@ Quaderno::Invoice.delete(INVOICE_ID,
 
 ## More information
 
-Remember this is only a ruby wrapper for the original API. If you want more information about the API itself, head to the original [API documentation](https://quaderno.io/docs/api/).
+Remember this is only a ruby wrapper for the Quaderno API. Checkout our [OpenAPI documentation](https://developers.quaderno.io/api)!
+
+If you need examples of `params` objects, head to our tests. For instance, in case you're an online store and want to register your sales and refunds, [here](https://github.com/quaderno/quaderno-ruby/blob/master/spec/unit/test_quaderno_transaction.rb) you can get examples of parameters to use with this Ruby gem.
+
+---
 
 ## License
+
 (The MIT License)
 
 Copyright © 2013-2023 Quaderno

data/changelog.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 3.0.0
+* Added support for accounts API
+* Added support for addresses API
+* Added support for tax rates API
+* Added support for tax jurisdictions API
+* Added support for tax codes API
+* Clean parameters sent in the create request
+* Phase out legacy `Quaderno::Tax` class in favour of `Quaderno::TaxRate` (the class will be removed in the next release)
+* Relaxed httparty requirements
+* Detect and handle `bad_request` response codes
+* Added `Quaderno::Exceptions::InvalidRequest` to handle `not_acceptable` response codes
+* Added `Quaderno::Exceptions::BaseException#response_body` to check the API response error
+* Removed legacy `Quaderno::Contact.retrieve_customer` in favor of `Quaderno::Contact.retrieve`
+
+## 2.2.0
+* Added support for transactions API
+* Bumped webmock to 3.18
+
 ## 2.1.3
 * Bumped dependency httparty to 0.21.0 by [**adamgiounas**](https://github.com/adamgiounas): https://github.com/quaderno/quaderno-ruby/pull/28
 

data/lib/quaderno-ruby/account.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+class Quaderno::Account < Quaderno::Base
+  class << self
+    undef :delete
+  end
+
+  api_model Quaderno::Account
+  api_path 'accounts'
+
+  def self.activate(id, options = {})
+    setup_account('activate', id, options)
+  end
+
+  def self.deactivate(id, options = {})
+    setup_account('deactivate', id, options)
+  end
+
+  private_class_method def self.setup_account(mode, id, options)
+    authentication = get_authentication(options.merge(api_model: api_model))
+
+    response = put("#{authentication[:url]}#{api_model.api_path}/#{id}/#{mode}.json", {
+      basic_auth: authentication[:basic_auth],
+      headers: default_headers.merge(authentication[:headers]).merge('Content-Type' => 'application/json')
+    })
+
+    check_exception_for(response, { rate_limit: true, required_fields: true, subdomain_or_token: true, id: true })
+
+    hash = response.parsed_response
+    hash[:authentication_data] = authentication
+
+    object = new hash
+    object.rate_limit_info = response
+
+    object
+  end
+end

data/lib/quaderno-ruby/address.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class Quaderno::Address < Quaderno::Base
+  api_model Quaderno::Address
+  api_path 'addresses'
+
+  class << self
+    undef :delete
+  end
+end

data/lib/quaderno-ruby/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'httparty'
 require 'json'
 

data/lib/quaderno-ruby/behavior/crud.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module Quaderno::Behavior
   module Crud
-
     def self.included(receiver)
       receiver.send :extend, ClassMethods
     end
@@ -69,7 +70,7 @@ module Quaderno::Behavior
 
       def create(params = {})
         authentication = get_authentication(params.merge(api_model: api_model))
-        params.dup.delete_if { |k,v| %w(auth_token access_token api_url mode api_model').include? k.to_s }
+        params = params.dup.delete_if { |k, _| %w[auth_token access_token api_url mode api_model].include? k.to_s }
 
         response = post("#{authentication[:url]}#{api_model.api_path}.json",
           body: params.to_json,
@@ -91,7 +92,7 @@ module Quaderno::Behavior
 
       def update(id, params = {})
         authentication = get_authentication(params.merge(api_model: api_model))
-        params = params.dup.delete_if { |k,v| %w(auth_token access_token api_url mode api_model').include? k.to_s }
+        params = params.dup.delete_if { |k, _| %w[auth_token access_token api_url mode api_model].include? k.to_s }
 
         response = put("#{authentication[:url]}#{api_model.api_path}/#{id}.json",
           body: params.to_json,
@@ -114,7 +115,7 @@ module Quaderno::Behavior
       def delete(id, options = {})
         authentication = get_authentication(options.merge(api_model: api_model))
 
-        response = HTTParty.delete("#{authentication[:url]}#{ api_model.api_path }/#{ id }.json",
+        response = HTTParty.delete("#{authentication[:url]}#{api_model.api_path}/#{id}.json",
           basic_auth: authentication[:basic_auth],
           headers: default_headers.merge(authentication[:headers])
         )

data/lib/quaderno-ruby/behavior/retrieve.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module Quaderno::Behavior
   module Retrieve
-
     def self.included(receiver)
       receiver.send :extend, ClassMethods
     end
@@ -25,9 +26,9 @@ module Quaderno::Behavior
 
         object
       end
-      alias_method :retrieve_customer, :retrieve
 
       private
+
       def retrieve_path(path)
         @_retrieve_path = path
       end

data/lib/quaderno-ruby/exceptions/exceptions.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module Quaderno::Exceptions
   class BaseException < StandardError
     include Quaderno::Helpers::RateLimit
+    include Quaderno::Helpers::Response
   end
 
   class InvalidSubdomainOrToken < BaseException
@@ -9,6 +12,9 @@ module Quaderno::Exceptions
   class InvalidID < BaseException
   end
 
+  class InvalidRequest < BaseException
+  end
+
   class RateLimitExceeded < BaseException
   end
 
@@ -35,31 +41,42 @@ module Quaderno::Exceptions
     def check_exception_for(party_response, params = {})
       raise_exception(Quaderno::Exceptions::UnsupportedApiVersion, 'Unsupported API version', party_response) if !!(party_response.body =~ /Unsupported API version/)
 
-      if params[:throttle_limit].nil? == false && party_response.response.class == Net::HTTPServiceUnavailable
+      if params[:throttle_limit].nil? == false && party_response.response.instance_of?(Net::HTTPServiceUnavailable)
         raise_exception(Quaderno::Exceptions::ThrottleLimitExceeded, 'Throttle limit exceeded, please try again later', party_response)
       end
-      if params[:rate_limit].nil? == false && party_response.response.class == Net::HTTPForbidden
+
+      if params[:rate_limit].nil? == false && party_response.response.instance_of?(Net::HTTPForbidden)
         raise_exception(Quaderno::Exceptions::RateLimitExceeded, 'Rate limit exceeded', party_response)
       end
-      if params[:subdomain_or_token].nil? == false
-        raise_exception(Quaderno::Exceptions::InvalidSubdomainOrToken, 'Invalid subdomain or token', party_response) if party_response.response.class == Net::HTTPUnauthorized
+
+      if params[:subdomain_or_token].nil? == false && party_response.response.instance_of?(Net::HTTPUnauthorized)
+        raise_exception(Quaderno::Exceptions::InvalidSubdomainOrToken, 'Invalid subdomain or token', party_response)
+      end
+
+      if params[:id].nil? == false && (party_response.response.instance_of?(Net::HTTPInternalServerError) || party_response.response.instance_of?(Net::HTTPNotFound))
+        raise_exception(Quaderno::Exceptions::InvalidID, "Invalid #{api_model} instance identifier", party_response)
       end
-      if params[:id].nil? == false
-        raise_exception(Quaderno::Exceptions::InvalidID, "Invalid #{ api_model } instance identifier", party_response) if (party_response.response.class == Net::HTTPInternalServerError) || (party_response.response.class == Net::HTTPNotFound)
+
+      if params[:required_fields].nil? == false && party_response.response.instance_of?(Net::HTTPUnprocessableEntity)
+        raise_exception(Quaderno::Exceptions::RequiredFieldsEmptyOrInvalid, party_response.body, party_response)
       end
-      if params[:required_fields].nil? == false
-        raise_exception(Quaderno::Exceptions::RequiredFieldsEmptyOrInvalid, party_response.body, party_response) if party_response.response.class == Net::HTTPUnprocessableEntity
+
+      if party_response.response.instance_of?(Net::HTTPBadRequest)
+        raise_exception(Quaderno::Exceptions::RequiredFieldsEmptyOrInvalid, party_response.body, party_response)
       end
-      if params[:has_documents].nil? == false
-        raise_exception(Quaderno::Exceptions::HasAssociatedDocuments, party_response.body, party_response) if party_response.response.class == Net::HTTPClientError
+
+      if params[:has_documents].nil? == false && party_response.response.instance_of?(Net::HTTPClientError)
+        raise_exception(Quaderno::Exceptions::HasAssociatedDocuments, party_response.body, party_response)
       end
 
+      raise_exception(Quaderno::Exceptions::InvalidRequest, 'Invalid request', party_response) if party_response.response.instance_of?(Net::HTTPNotAcceptable)
       raise_exception(Quaderno::Exceptions::ServerError, 'Server error', party_response) if party_response.response.is_a?(Net::HTTPServerError)
     end
 
     def raise_exception(klass, message, response)
       exception = klass.new(message)
       exception.rate_limit_info = response
+      exception.response_body = response.parsed_response
 
       raise exception
     end

data/lib/quaderno-ruby/helpers/response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Quaderno::Helpers
+  module Response
+    def response_body=(response)
+      @response_body = response
+    end
+
+    def response_body
+      @response_body
+    end
+  end
+end

data/lib/quaderno-ruby/tax.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Quaderno::TaxReport < OpenStruct
 end
 
@@ -11,7 +13,7 @@ class Quaderno::Tax < Quaderno::Base
 
   def self.calculate(options = {})
     authentication = get_authentication(options.merge(api_model: api_model))
-    params = options.dup.delete_if { |k,v| %w(auth_token access_token api_url mode api_model).include? k.to_s }
+    params = options.dup.delete_if { |k, _| %w[auth_token access_token api_url mode api_model].include? k.to_s }
 
     response = get("#{authentication[:url]}tax_rates/calculate.json",
       query: params,
@@ -47,7 +49,7 @@ class Quaderno::Tax < Quaderno::Base
 
   def self.reports(options = {})
     authentication = get_authentication(options.merge(api_model: api_model))
-    params = options.dup.delete_if { |k,v| %w(auth_token access_token api_url mode api_model).include? k.to_s }
+    params = options.dup.delete_if { |k, _| %w[auth_token access_token api_url mode api_model].include? k.to_s }
 
     response = get("#{authentication[:url]}taxes/reports.json",
       query: params,

data/lib/quaderno-ruby/tax_code.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class Quaderno::TaxCode < Quaderno::Base
+  class << self
+    undef :create, :update, :delete, :parse_nested
+  end
+
+  api_model Quaderno::TaxCode
+  api_path 'tax_codes'
+end

data/lib/quaderno-ruby/tax_id.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class Quaderno::TaxId < Quaderno::Base
+  api_model Quaderno::TaxId
+  api_path 'tax_ids'
+  is_a_document? false
+
+  def self.validate(country, tax_id, options = {})
+    authentication = get_authentication(options.merge(api_model: api_model))
+
+    response = get("#{authentication[:url]}#{api_path}/validate.json",
+      query: { country: country, tax_id: tax_id },
+      basic_auth: authentication[:basic_auth],
+      headers: default_headers.merge(authentication[:headers])
+    )
+
+    check_exception_for(response, { rate_limit: true, subdomain_or_token: true, id: true })
+
+    data = new({ valid: response.parsed_response['valid'] })
+    data.rate_limit_info = response
+
+    data
+  end
+end

data/lib/quaderno-ruby/tax_jurisdiction.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class Quaderno::TaxJurisdiction < Quaderno::Base
+  class << self
+    undef :create, :update, :delete, :parse_nested
+  end
+
+  api_model Quaderno::TaxJurisdiction
+  api_path 'jurisdictions'
+end

data/lib/quaderno-ruby/tax_rate.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class Quaderno::TaxRate < Quaderno::Base
+  api_model Quaderno::TaxRate
+  api_path 'tax_rates'
+
+  def self.calculate(options = {})
+    authentication = get_authentication(options.merge(api_model: api_model))
+    params = options.dup.delete_if { |k, _| %w[auth_token access_token api_url mode api_model].include? k.to_s }
+
+    response = get("#{authentication[:url]}#{api_path}/calculate.json",
+      query: params,
+      basic_auth: authentication[:basic_auth],
+      headers: default_headers.merge(authentication[:headers])
+    )
+
+    check_exception_for(response, { rate_limit: true, subdomain_or_token: true, id: true })
+    data = new response.parsed_response
+    data.rate_limit_info = response
+
+    data
+  end
+end

data/lib/quaderno-ruby/transaction.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class Quaderno::Transaction < Quaderno::Base
+  api_model Quaderno::Transaction
+  api_path 'transactions'
+  is_a_document? true
+
+  class << self
+    undef :all, :find, :update, :delete
+  end
+end

data/lib/quaderno-ruby/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Quaderno
-  VERSION = "2.1.3"
+  VERSION = "3.0.0"
 end

data/lib/quaderno-ruby.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Quaderno
 end
 
@@ -5,9 +7,10 @@ require 'ostruct'
 
 require 'quaderno-ruby/version'
 require 'quaderno-ruby/helpers/rate_limit'
+require 'quaderno-ruby/helpers/response'
 require 'quaderno-ruby/exceptions/exceptions'
 require 'quaderno-ruby/helpers/authentication'
 require 'quaderno-ruby/collection'
 
-%w(block crud deliver payment retrieve).each { |filename| require "quaderno-ruby/behavior/#{filename}" }
-%w(base contact item invoice receipt credit income estimate expense recurring document_item report report_request evidence payment webhook tax checkout_session).each { |filename| require "quaderno-ruby/#{ filename }" }
+%w[block crud deliver payment retrieve].each { |filename| require "quaderno-ruby/behavior/#{filename}" }
+%w[base account address contact item transaction invoice receipt credit income estimate expense recurring document_item report report_request evidence payment webhook tax tax_id tax_rate tax_code tax_jurisdiction checkout_session].each { |filename| require "quaderno-ruby/#{filename}" }

data/quaderno.gemspec

@@ -21,12 +21,12 @@ Gem::Specification.new do |spec|
   spec.date = '2018-05-07'
   spec.extra_rdoc_files = %w(LICENSE.txt README.md)
 
-  spec.add_dependency('httparty', '~> 0.21.0')
-  spec.add_development_dependency('rdoc', '>= 6.3.1')
+  spec.add_dependency('httparty', '~> 0.21')
   spec.add_development_dependency('activesupport', '~> 4.2.0')
-  spec.add_development_dependency('webmock', '~> 1.22.6')
-  spec.add_development_dependency('vcr', '>= 0')
   spec.add_development_dependency('bundler', '~> 2.2')
   spec.add_development_dependency('rake', '>= 12.3.3')
+  spec.add_development_dependency('rdoc', '>= 6.3.1')
   spec.add_development_dependency('rspec', '~> 3.0')
+  spec.add_development_dependency('vcr', '>= 0')
+  spec.add_development_dependency('webmock', '~> 3.18')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quaderno
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 3.0.0
 platform: ruby
 authors:
 - Recrea
@@ -16,112 +16,112 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: '0.21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: '0.21'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.3.1
+        version: 4.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.3.1
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.22.6
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.22.6
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.3.1
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.18'
 description: " A ruby wrapper for Quaderno API "
 email: carlos@recrea.es
 executables: []
@@ -140,6 +140,8 @@ files:
 - Rakefile
 - changelog.md
 - lib/quaderno-ruby.rb
+- lib/quaderno-ruby/account.rb
+- lib/quaderno-ruby/address.rb
 - lib/quaderno-ruby/base.rb
 - lib/quaderno-ruby/behavior/block.rb
 - lib/quaderno-ruby/behavior/crud.rb
@@ -157,6 +159,7 @@ files:
 - lib/quaderno-ruby/expense.rb
 - lib/quaderno-ruby/helpers/authentication.rb
 - lib/quaderno-ruby/helpers/rate_limit.rb
+- lib/quaderno-ruby/helpers/response.rb
 - lib/quaderno-ruby/income.rb
 - lib/quaderno-ruby/invoice.rb
 - lib/quaderno-ruby/item.rb
@@ -166,6 +169,11 @@ files:
 - lib/quaderno-ruby/report.rb
 - lib/quaderno-ruby/report_request.rb
 - lib/quaderno-ruby/tax.rb
+- lib/quaderno-ruby/tax_code.rb
+- lib/quaderno-ruby/tax_id.rb
+- lib/quaderno-ruby/tax_jurisdiction.rb
+- lib/quaderno-ruby/tax_rate.rb
+- lib/quaderno-ruby/transaction.rb
 - lib/quaderno-ruby/version.rb
 - lib/quaderno-ruby/webhook.rb
 - quaderno.gemspec