belvo 1.1.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92940ff5820a09ee1a7cd694581a1111f6161fe15ba34481c80b4f36c5dd4bfd
-  data.tar.gz: 6c34e09989c39e0f7e45d569ba359f4e02064b49bede2c8a40c6c4f3fbe71e52
+  metadata.gz: 2451a25febe9bcc2e507d13977720f0886f89da8ff9e65d639846ca029717a53
+  data.tar.gz: 0ab5eb4ff9f6196ebc876011f3485e4bcba7a7888cbd20264f0abaaf9380e158
 SHA512:
-  metadata.gz: 7dff5481b7fb7e757527821765e8d6da859b1ba4c737288eba95171363f6dfdb8763600e932271a72bbaa9da663f94d41889cb1d59e6aa60aef299103ed0f1c5
-  data.tar.gz: c902eecfffea0a1beaeb4fa968b19aa26b57b5fc319cfc73280401952a3c4abd25870a0ec3707e02c4bf39f127b449c8c663d466bfe3f67699f9269d162019e7
+  metadata.gz: 0ecbbb2a7c36121c8f9bfffdb5dddc4e4d2eb9065e3405ae0574736c808b2d24796c292dfc98a2b50d3431875d8b25bf6db5aea9946f765f5a1dca3acf5fd4d9
+  data.tar.gz: 90490528e75a6cca01484b74094c750368191b726ad36530912c27dc560c49ae85b19856cb462947d6da9f07bce3eff5169265cb206e07a938eead59d3bd9ab1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    belvo (1.1.1)
+    belvo (1.3.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

data/lib/belvo/resources.rb

@@ -3,6 +3,7 @@
 require 'date'
 require 'belvo/options'
 require 'belvo/utils'
+require 'belvo/exceptions'
 
 module Belvo
   # Represents a consumable REST resource from Belvo API
@@ -185,6 +186,24 @@ module Belvo
       @endpoint = 'api/transactions/'
     end
 
+    # List all transactions for specific link id
+    # @param id [String] Resource ID
+    # @param params [Hash] Extra parameters sent as query strings.
+    # @return [Array] List of results when no block is passed.
+    # @yield [Hash] Each result to be processed individually.
+    # @raise [RequestError] If response code is different than 2XX
+    def list(params: nil)
+      params = {} if params.nil?
+      unless params.key?(:link)
+        raise RequestError.new(
+          'Link id required',
+          400,
+          'A link ID is required to list transactions'
+        )
+      end
+      @session.list(@endpoint, params: params)
+    end
+
     # Retrieve transactions from an existing link
     # @param link [String] Link UUID
     # @param date_from [String] Date string (YYYY-MM-DD)
@@ -472,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.

data/lib/belvo/version.rb

@@ -2,5 +2,5 @@
 
 module Belvo
   # belvo-ruby current version
-  VERSION = '1.1.1'
+  VERSION = '1.3.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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belvo
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Belvo Finance S.L.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-03 00:00:00.000000000 Z
+date: 2022-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday