belvo 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8ddc3b560df375b13cdfba4173c362979192231a40cc3c248bd3436f6c19790
-  data.tar.gz: a8a03709a98a0b0a1d59f57255a45e14631684199b1ebf1c5844d56da66b3860
+  metadata.gz: 77535d19fd4a624ef494fa4c6354fc427bbfa388122398bace8dbe011207a006
+  data.tar.gz: e7655524ec6125db8fadb1f1b7fbee29e82685a4ead7edfecaec56a618f09bda
 SHA512:
-  metadata.gz: 21f0eff9a499c6d7de8aa2b730224853eee43abdc91ac2e8a1cd3e700e3238f6c969f5fa75f3b129405d437123c65e2dd1ffac9bcabad01f6140790adbd67d58
-  data.tar.gz: 8aa63d37ed8b551b83483b0cd1ca08f9c72b477ee45781ad6a0baceb81c1be03adb689aa1fbc1105e299ead79f8b814e6d5676753fcf26deae2efc8563ed8299
+  metadata.gz: 6366c18991ba3ff5b24efbfde467560a05d52d1392f349cf8a38c0515a59bba430fa2456e0fbcf35fdc89a0a28cdd43756371e5bc0dcc106afc6e03e3f845bac
+  data.tar.gz: 2ea9b99bd9dba5890256ca1c3404943d08b606187f8ecf6453f133d047955fca96691224b98d816699144bb6110353902b71e3543934e858d1834c76762630db

data/Gemfile.lock

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

data/README.md

@@ -81,7 +81,7 @@ begin
         username: 'janedoe', 
         password: 'super-secret',
         options: { access_mode: Belvo::Link::AccessMode::SINGLE }
-        )
+    )
     
     belvo.accounts.retrieve(link: new_link['id'])
 
@@ -94,6 +94,18 @@ rescue Belvo::RequestError => e
 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/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

@@ -472,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
@@ -498,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/version.rb

@@ -2,5 +2,5 @@
 
 module Belvo
   # belvo-ruby current version
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 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: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Belvo Finance S.L.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-13 00:00:00.000000000 Z
+date: 2022-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday