belvo 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7c835bc36e3ffa4aed0c08effb1c7a7ec0f64b46955f4fb59bd9bd4aabd6e98
-  data.tar.gz: 24fa5cb7a3ec5b0581eac4b04b2e58ffa9a08bd332d91512b0d33641a3185264
+  metadata.gz: a629a7752ddbb1913f5313eeab072774c4ecd36748fb3cdf306a78f2bd4f6bbb
+  data.tar.gz: fd1d6c751d71663622e94f076ab1b4fbd606fdafdfc62ca5e1574d6cf4b17ef4
 SHA512:
-  metadata.gz: 7f7843ca0c81834407decbcccc5a136ad29800041c4d5a090cfae523a27521e0aa0e8a44abd69310ad01aa403a80114341e7735ac9168fa53f6345eb1336146e
-  data.tar.gz: 1fc654b148a1c0ff31480f593741064371baefef276d7e7df2f70d74fbe95dd8e31e15cf49e109f0468e48060d05d2b923b6a375675cf7c78d6771c1265ef0c3
+  metadata.gz: 2d2c41f8f976ec9a67622b12ed5f5ff1ef5373b1f7d170cd17a85f341e1313028be9f323f57102fc8f5c105c56f4572e1960fc45f051ed4fe210e0c90c13d195
+  data.tar.gz: ff9552fe45ccf2ea98bf53c2392b8e68120e4c965aa9f2843132f664bf24bfd7c7b9ad5c60eb54e8b0f29d7dda2dddf2d14a25b44890939127a5e1066ada95ab

data/.github/workflows/danger-pr-reviews.yml

@@ -14,10 +14,11 @@ jobs:
           fetch-depth: 10
 
       # Setup ruby
-      - name: Set up Ruby 2.6
-        uses: actions/setup-ruby@v1
+      - name: Set up Ruby 3.2
+        uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.6
+          ruby-version: 3.2
+          bundler-cache: true
 
       # Install the right bundler version
       - name: Install bundler

data/Gemfile.lock

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

data/lib/belvo/options.rb

@@ -152,6 +152,19 @@ module Belvo
   )
   end
 
+  # @!class TaxDeclarationOptions < Faraday::Options
+  # Contains configurable properties of a TaxDeclaration
+  # @!attribute save_data [rw] Should data be persisted or not.
+  # @!attribute token [rw] OTP token required by the institution
+  # @!attribute attach_pdf [rw] Should the PDF file be included in the
+  #   response or not.
+  class TaxDeclarationOptions < Faraday::Options.new(
+    :token,
+    :save_data,
+    :attach_pdf
+  )
+  end
+
   # @!class TaxRetentionsOptions < Faraday::Options
   # Contains configurable properties of a tax retention
   # @!attribute save_data [rw] Indicates whether or not to persist the
@@ -201,16 +214,4 @@ module Belvo
   # @!attribute token [rw] OTP token required by the institution
   class InvestmentsPortfolioOptions < Faraday::Options.new(:token, :save_data)
   end
-
-  # @!class InvestmentsTransactionOptions < Faraday::Options
-  # Contains configurable properties of an InvestmentsTransaction
-  # @!attribute date_to [rw] Date string (YYYY-MM-DD)
-  # @!attribute save_data [rw] Should data be persisted or not.
-  # @!attribute token [rw] OTP token required by the institution
-  class InvestmentsTransactionOptions < Faraday::Options.new(
-    :date_to,
-    :token,
-    :save_data
-  )
-  end
 end

data/lib/belvo/resources.rb

@@ -491,6 +491,37 @@ module Belvo
     end
   end
 
+  # A Tax declaration is the representation of the tax declaration document sent
+  # every year by a person or a business to the tax authority in the country.
+  class TaxDeclaration < Resource
+    def initialize(session)
+      super(session)
+      @endpoint = 'api/tax-declarations/'
+    end
+
+    # Retrieve tax declaration information for a specific fiscal link.
+    # @param link [String] Link UUID
+    # @param year_from [Integer]
+    # @param year_to [Integer]
+    # @param options [TaxDeclarationOptions] Configurable properties
+    # @return [Hash] created tax declarations details
+    # @raise [RequestError] If response code is different than 2XX
+    def retrieve(link:, year_from:, year_to:, options: nil)
+      options = TaxDeclarationOptions.from(options)
+      body = {
+        link: link,
+        year_from: year_from,
+        year_to: year_to,
+        token: options.token,
+        save_data: options.save_data || true,
+        attach_pdf: options.attach_pdf
+      }.merge(options)
+
+      body = clean body: body
+      @session.post(@endpoint, body)
+    end
+  end
+
   # A tax retention is the amount of money that the payer must deduct from the
   # total amount of a purchase invoice, according to the regulations of the
   # fiscal institution.
@@ -624,32 +655,4 @@ module Belvo
       @session.post(@endpoint, body)
     end
   end
-
-  # A InvestmentsTransaction gets the existing transactions for an instrument
-  class InvestmentsTransaction < Resource
-    def initialize(session)
-      super(session)
-      @endpoint = 'investments/transactions/'
-    end
-
-    # Retrieve investments transactions from an existing link
-    # @param link [String] Link UUID
-    # @param date_from [String] Date string (YYYY-MM-DD)
-    # @param options [InvestmentsTransactionOptions] Configurable properties
-    # @return [Hash] created investments transactions details
-    # @raise [RequestError] If response code is different than 2XX
-    def retrieve(link:, date_from:, options: nil)
-      options = InvestmentsTransactionOptions.from(options)
-      date_to = options.date_to || Date.today.to_s
-      body = {
-        link: link,
-        date_from: date_from,
-        date_to: date_to,
-        token: options.token,
-        save_data: options.save_data || true
-      }.merge(options)
-      body = clean body: body
-      @session.post(@endpoint, body)
-    end
-  end
 end

data/lib/belvo/version.rb

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

data/lib/belvo.rb

@@ -104,6 +104,12 @@ module Belvo
       @tax_returns = TaxReturn.new @session
     end
 
+    # Provides access to TaxDeclarations resource
+    # @return [TaxDeclaration]
+    def tax_declarations
+      @tax_declarations = TaxDeclaration.new @session
+    end
+
     # Provides access to TaxStatus resource
     # @return [TaxStatus]
     def tax_status
@@ -133,11 +139,5 @@ module Belvo
     def investments_portfolio
       @investments_portfolio = InvestmentsPortfolio.new @session
     end
-
-    # Provides access to InvestmentsTransaction resource
-    # @return [InvestmentsTransaction]
-    def investments_transaction
-      @investments_transaction = InvestmentsTransaction.new @session
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belvo
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Belvo Finance S.L.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-28 00:00:00.000000000 Z
+date: 2023-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -195,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.11
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: The Ruby gem for the Belvo API