belvo 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50dc56e84a0e3da9460063b4d5589044ad4d88d29f8182ac21d106953e169d55
-  data.tar.gz: 50d11079afd1b518d03e30b75d5b1dc5a44e725d7c449cf0036ecc36294a404e
+  metadata.gz: ff048795b869d8968a35be333ebbd05e4455b11324c0112e936bb864c2ed6b54
+  data.tar.gz: 5cbe5998bc9c47cd37918a1f7d511608316076ac95fa8b5219c6f5a5fa6e56fe
 SHA512:
-  metadata.gz: '01414806db87f0512b9c8fe0ff9c611e2e248edb18c24a368173b35b439da0a7fa10b29e25d8e5c86048e4b67936e1d2359b886d94cb2a55ffb558bcc05f1cb0'
-  data.tar.gz: 97053b093f9ac116decbad414b859da65de6b3ee2d18a53dfca5bd896db2a302be3c15f8d3c2823d144d7078ab14f92d09775cc16e1249d24e2113c3cf081c42
+  metadata.gz: 7823be7ba6522dd1e137d0cb74afe0e732384f18bbc887e617320693de58511c51fdad8db8c4582d013c897a38505662a938f4412e92acc068c0804b9bcc3237
+  data.tar.gz: a3ff06d08002a13e6ea8107d1c5d8e89c3ef3ae881b601b8dd1b0c5e95d8c986e51140d53400537d75bbe347d376f30a270955bc59ad53a9a4615616527d210c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    belvo (0.3.1)
+    belvo (0.4.0)
       faraday
       faraday_middleware
       typhoeus

data/lib/belvo.rb

@@ -75,6 +75,12 @@ module Belvo
       @tax_returns = TaxReturn.new @session
     end
 
+    # Provides access to TaxStatus resource
+    # @return [TaxStatus]
+    def tax_status
+      @tax_status = TaxStatus.new @session
+    end
+
     # Provides access to Instituions resource
     # @return [Institution]
     def institutions

data/lib/belvo/options.rb

@@ -8,10 +8,12 @@ module Belvo
   # @!attribute access_mode [rw] Link access mode (SINGLE or RECURRENT)
   # @!attribute token [rw] OTP token required by the institution
   # @!attribute encryption_key [rw] Custom encryption key
+  # @!attribute username_type [rw] Type of the username provided
   class LinkOptions < Faraday::Options.new(
     :access_mode,
     :token,
-    :encryption_key
+    :encryption_key,
+    :username_type
   )
   end
 
@@ -111,4 +113,19 @@ module Belvo
     :attach_pdf
   )
   end
+
+  # @!class TaxStatusOptions < Faraday::Options
+  # Contains configurable properties of a TaxStatus
+  # @!attribute save_data [rw] Should data be persisted or not.
+  # @!attribute token [rw] OTP token required by the institution
+  # @!attribute encryption_key [rw] Custom encryption key
+  # @!attribute attach_pdf [rw] Should the PDF file be included in the
+  #   response or not.
+  class TaxStatusOptions < Faraday::Options.new(
+    :token,
+    :encryption_key,
+    :save_data,
+    :attach_pdf
+  )
+  end
 end

data/lib/belvo/resources.rb

@@ -95,7 +95,8 @@ module Belvo
         password2: password2,
         token: options.token,
         encryption_key: options.encryption_key,
-        access_mode: options.access_mode || AccessMode::SINGLE
+        access_mode: options.access_mode || AccessMode::SINGLE,
+        username_type: options.username_type
       }.merge(options)
       body = clean body: body
       @session.post(@endpoint, body)
@@ -132,7 +133,7 @@ module Belvo
     # Retrieve accounts from an existing link
     # @param link [String] Link UUID
     # @param options [AccountOptions] Configurable properties
-    # @return [Hash] created link details
+    # @return [Hash] created accounts details
     # @raise [RequestError] If response code is different than 2XX
     def retrieve(link:, options: nil)
       options = AccountOptions.from(options)
@@ -159,7 +160,7 @@ module Belvo
     # @param link [String] Link UUID
     # @param date_from [String] Date string (YYYY-MM-DD)
     # @param options [TransactionOptions] Configurable properties
-    # @return [Hash] created link details
+    # @return [Hash] created transactions details
     # @raise [RequestError] If response code is different than 2XX
     def retrieve(link:, date_from:, options: nil)
       options = TransactionOptions.from(options)
@@ -189,7 +190,7 @@ module Belvo
     # Retrieve owners from an existing link
     # @param link [String] Link UUID
     # @param options [OwnerOptions] Configurable properties
-    # @return [Hash] created link details
+    # @return [Hash] created owners details
     # @raise [RequestError] If response code is different than 2XX
     def retrieve(link:, options: nil)
       options = OwnerOptions.from(options)
@@ -216,7 +217,7 @@ module Belvo
     # @param link [String] Link UUID
     # @param date_from [String] Date string (YYYY-MM-DD)
     # @param options [BalanceOptions] Configurable properties
-    # @return [Hash] created link details
+    # @return [Hash] created balances details
     # @raise [RequestError] If response code is different than 2XX
     def retrieve(link:, date_from:, options: nil)
       options = BalanceOptions.from(options)
@@ -247,7 +248,7 @@ module Belvo
     # @param year [Integer]
     # @param month [Integer]
     # @param options [StatementOptions] Configurable properties
-    # @return [Hash] created link details
+    # @return [Hash] created statement details
     # @raise [RequestError] If response code is different than 2XX
     def retrieve(link:, account:, year:, month:, options: nil)
       options = StatementOptions.from(options)
@@ -279,7 +280,7 @@ module Belvo
     # @param date_from [String] Date string (YYYY-MM-DD)
     # @param date_to [String] Date string (YYYY-MM-DD)
     # @param options [InvoiceOptions] Configurable properties
-    # @return [Hash] created link details
+    # @return [Hash] created invoices details
     # @raise [RequestError] If response code is different than 2XX
     def retrieve(link:, date_from:, date_to:, type:, options: nil)
       options = InvoiceOptions.from(options)
@@ -311,7 +312,7 @@ module Belvo
     # @param year_from [Integer]
     # @param year_to [Integer]
     # @param options [TaxReturnOptions] Configurable properties
-    # @return [Hash] created link details
+    # @return [Hash] created tax returns details
     # @raise [RequestError] If response code is different than 2XX
     def retrieve(link:, year_from:, year_to:, options: nil)
       options = TaxReturnOptions.from(options)
@@ -333,6 +334,37 @@ module Belvo
     end
   end
 
+  # A Tax status is the representation of the tax situation of a person or a
+  # business to the tax authority in the country.
+  class TaxStatus < Resource
+    def initialize(session)
+      super(session)
+      @endpoint = 'tax-status/'
+    end
+
+    # Retrieve tax status information from a specific fiscal link.
+    # @param link [String] Link UUID
+    # @param options [TaxStatusOptions] Configurable properties
+    # @return [Hash] created tax status details
+    # @raise [RequestError] If response code is different than 2XX
+    def retrieve(link:, options: nil)
+      options = TaxStatusOptions.from(options)
+      body = {
+        link: link,
+        token: options.token,
+        encryption_key: options.encryption_key,
+        save_data: options.save_data || true,
+        attach_pdf: options.attach_pdf
+      }.merge(options)
+      body = clean body: body
+      @session.post(@endpoint, body)
+    end
+
+    def resume(_session_id, _token, _link: nil)
+      raise NotImplementedError 'TaxReturn does not support resuming a session.'
+    end
+  end
+
   # An Institution is an entity that Belvo can access information from. It can
   # be a bank or fiscal type of institutions such as the SAT in Mexico.
   class Institution < Resource

data/lib/belvo/version.rb

@@ -2,5 +2,5 @@
 
 module Belvo
   # belvo-ruby current version
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belvo
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Belvo Finance S.L.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-09 00:00:00.000000000 Z
+date: 2020-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -190,7 +190,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: The Ruby gem for the Belvo API