belvo 0.20.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05a03ab57113f17e822b4f48dd813edf5206bacfb79a757332fce693a60db786
-  data.tar.gz: 2676ef16eabab4fcbd553ec28cf7378539eb468387954a2754b62d1c6642fe6e
+  metadata.gz: 92940ff5820a09ee1a7cd694581a1111f6161fe15ba34481c80b4f36c5dd4bfd
+  data.tar.gz: 6c34e09989c39e0f7e45d569ba359f4e02064b49bede2c8a40c6c4f3fbe71e52
 SHA512:
-  metadata.gz: 522bc53deacef6bc63010a44d837acc100560bd9cb5a3721eea94cde3b37abb3090c385c9c0c2d411ebfd39fe9c1c88fc905ba03dc6bf70cb2ed58899af0f1c8
-  data.tar.gz: 4bcee96d178f49fc23bac577725560f279f21e8a96670694b5d0f2918871e0ea5e332ba09b421769e24740217402e45c55f6e2bdfaaeda0c04caba00d0d92411
+  metadata.gz: 7dff5481b7fb7e757527821765e8d6da859b1ba4c737288eba95171363f6dfdb8763600e932271a72bbaa9da663f94d41889cb1d59e6aa60aef299103ed0f1c5
+  data.tar.gz: c902eecfffea0a1beaeb4fa968b19aa26b57b5fc319cfc73280401952a3c4abd25870a0ec3707e02c4bf39f127b449c8c663d466bfe3f67699f9269d162019e7

data/Gemfile.lock

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

data/README.md

@@ -53,7 +53,9 @@ begin
     
     belvo.accounts.retrieve(link: link_id)
 
-    puts belvo.accounts.list
+    belvo.accounts.list.each do |item|
+        puts item
+    end
 rescue Belvo::RequestError => e
     puts e.status_code
     puts e.detail
@@ -79,17 +81,31 @@ begin
         username: 'janedoe', 
         password: 'super-secret',
         options: { access_mode: Belvo::Link::AccessMode::SINGLE }
-        )
+    )
     
     belvo.accounts.retrieve(link: new_link['id'])
 
-    puts belvo.accounts.list
+    belvo.accounts.list.each do |item|
+        puts item
+    end
 rescue Belvo::RequestError => e
     puts e.status_code
     puts e.detail
 end
 ```
 
+## Pagination
+
+All `list` methods only return the first page of results. If you want to iterate by all pages, you will need to specify the `page` as a parameter:
+
+```ruby
+    #`api/transactions`
+    ...
+    belvo.transactions.list(params: {page: "2"})
+    ...
+```
+When the result of your call is `nil`, this indicates that there are no more pages to iterate over. 
+
 **Note:** If you create a `Link` without specifying [access_mode](https://docs.belvo.com/#operation/RegisterLink), the SDK will respect the default value from the API.
 
 ## Development

data/lib/belvo/http.rb

@@ -91,16 +91,8 @@ module Belvo
     # @raise [RequestError] If response code is different than 2XX
     def list(path, params: nil)
       params = {} if params.nil?
-      loop do
-        response = get(path, params: params)
-        response.body['results'].each do |item|
-          yield item if block_given?
-        end
-
-        break unless response.body['next']
-
-        params = Faraday::Utils.parse_query URI(response.body['next']).query
-      end
+      response = get(path, params: params)
+      response.body['results']
     end
 
     # Show specific resource details

data/lib/belvo/options.rb

@@ -152,9 +152,28 @@ module Belvo
   )
   end
 
+  # @!class TaxRetentionsOptions < Faraday::Options
+  # Contains configurable properties of a tax retention
+  # @!attribute save_data [rw] Indicates whether or not to persist the
+  # data in Belvo. By default, this is set to `true` and we return a
+  # 201 Created response. When set to `false`, the data won't be persisted
+  # and we return a 200 OK response.
+  # @!attribute attach_xml [rw] When set to `true`, you will receive the XML
+  # tax retention in the response.
+  class TaxRetentionsOptions < Faraday::Options.new(
+    :save_data,
+    :attach_xml,
+    :date_from,
+    :date_to
+  )
+  end
+
   # @!class TaxStatusOptions < Faraday::Options
   # Contains configurable properties of a TaxStatus
-  # @!attribute save_data [rw] Should data be persisted or not.
+  # @!attribute save_data [rw] Indicates whether or not to persist the data
+  # in Belvo. By default, this is set to `true` and we return a 201 Created
+  # response. When set to `false`, the data won't be persisted and we return
+  # a 200 OK response.
   # @!attribute token [rw] OTP token required by the institution
   # @!attribute attach_pdf [rw] Should the PDF file be included in the
   #   response or not.

data/lib/belvo/resources.rb

@@ -29,11 +29,7 @@ module Belvo
     # @yield [Hash] Each result to be processed individually.
     # @raise [RequestError] If response code is different than 2XX
     def list(params: nil)
-      results = block_given? ? nil : []
-      @session.list(@endpoint, params: params) do |item|
-        results.nil? ? yield(item) : results.push(item)
-      end
-      results
+      @session.list(@endpoint, params: params)
     end
 
     # Show specific resource details
@@ -476,6 +472,48 @@ module Belvo
     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.
+  class TaxRetentions < Resource
+    def initialize(session)
+      super(session)
+      @endpoint = 'api/tax-retentions/'
+    end
+
+    class TaxRetentionsType
+      INFLOW = 'inflow'
+      OUTFLOW = 'outflow'
+    end
+
+    # Retrieve tax retentions from a specific fiscal link.
+    # @param link [String] The `link.id` that you want to get information
+    # for (UUID).
+    # @param type [TaxRetentionsType] The type of tax retention in relation to
+    # the invoice (from the perspective of the Link owner). `OUTFLOW` relates
+    # to a tax retention for a sent invoice. `INFLOW` relates to a tax
+    # retention for a received invoice. (inflow or outflow)
+    # @param options [TaxRetentionsOptions] Configurable properties
+    def retrieve(link:, type:, options: nil)
+      options = TaxRetentionsOptions.from(options)
+      body = {
+        link: link,
+        date_from: options.date_from,
+        date_to: options.date_to,
+        save_data: options.save_data,
+        attach_xml: options.attach_xml,
+        type: type
+      }.merge(options)
+      body = clean body: body
+      @session.post(@endpoint, body)
+    end
+
+    def resume(_session_id, _token, _link: nil)
+      raise NotImplementedError \
+        'TaxRetentions does not support resuming a session'
+    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
@@ -502,7 +540,8 @@ module Belvo
     end
 
     def resume(_session_id, _token, _link: nil)
-      raise NotImplementedError 'TaxReturn does not support resuming a session.'
+      raise NotImplementedError \
+        'TaxRetentions does not support resuming a session.'
     end
   end
 

data/lib/belvo/utils.rb

@@ -2,13 +2,15 @@
 
 require 'base64'
 
-# Class with helper functions
-class Utils
-  def self.read_file_to_b64(path)
-    return if path.nil? || !File.file?(path)
+module Belvo
+  # Class with helper functions
+  class Utils
+    def self.read_file_to_b64(path)
+      return if path.nil? || !File.file?(path)
 
-    data = File.open(path).read
-    Base64.encode64(data)
+      data = File.open(path).read
+      Base64.encode64(data)
+    end
   end
 end
 

data/lib/belvo/version.rb

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

data/lib/belvo.rb

@@ -110,7 +110,13 @@ module Belvo
       @tax_status = TaxStatus.new @session
     end
 
-    # Provides access to Instituions resource
+    # Provides access to the TaxRetentions resource
+    # @return [TaxRetentions]
+    def tax_retentions
+      @tax_retentions = TaxRetentions.new @session
+    end
+
+    # Provides access to the Institutions resource
     # @return [Institution]
     def institutions
       @institutions = Institution.new @session

metadata

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