gocardless_pro 2.29.0 → 2.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae7ce2e7f276bbb9d36b64093e6be341e1f76325a7ced35710e8276360c2df22
-  data.tar.gz: 554e6c6c947c94c76d250fafabdc3867b65ca218269ce70395fe5a0079fdb5e5
+  metadata.gz: 1591576f071daabb20a04e9e91a7e802be0efed1b3e71910e33c35335589cdf4
+  data.tar.gz: 763c87329cc80eba691ae417c58b3344abbc7ffc48fe554be85fedcc24c1e80d
 SHA512:
-  metadata.gz: fb5865c593f89c21fe7b1d9ea930c2683286753f9635dcb0e70350ac4fd5af02345a6c472c8b9940484242f6f39cfd05fcdbca0c5a96c3e7cad66f2bf5cf42e6
-  data.tar.gz: 55605f88d457f5a0e8bb3445b9a796dbe1332a94eb3c1ab86318c4bce49d4ab88fcaf6a27ed67c01e4195f6b73eb40ede88d86f3f5998b09b348eb5e5a7a26d0
+  metadata.gz: 7b8552085fb1ec811f6398ed9f52990853a48c4836e8f6092273366dcd0a9e1f27e4399cc8489322a726e94153dd221e1a4cd20b68f72a0c371d4b62984ac0bb
+  data.tar.gz: ec4ab730899aad19e7a670b5da2378e651db3bb1e88734e9794967ef33ac764e973b70e7c2a61613065a8284a1cf8afbf6879e8c7eaa13cda53a3176527be200

data/lib/gocardless_pro/client.rb

@@ -198,7 +198,7 @@ module GoCardlessPro
           'User-Agent' => user_agent.to_s,
           'Content-Type' => 'application/json',
           'GoCardless-Client-Library' => 'gocardless-pro-ruby',
-          'GoCardless-Client-Version' => '2.29.0',
+          'GoCardless-Client-Version' => '2.30.0',
         },
       }
     end

data/lib/gocardless_pro/resources/billing_request.rb

@@ -24,6 +24,7 @@ module GoCardlessPro
     class BillingRequest
       attr_reader :actions
       attr_reader :created_at
+      attr_reader :fallback_enabled
       attr_reader :id
       attr_reader :mandate_request
       attr_reader :metadata
@@ -38,6 +39,7 @@ module GoCardlessPro
 
         @actions = object['actions']
         @created_at = object['created_at']
+        @fallback_enabled = object['fallback_enabled']
         @id = object['id']
         @links = object['links']
         @mandate_request = object['mandate_request']

data/lib/gocardless_pro/resources/billing_request_flow.rb

@@ -19,12 +19,14 @@ module GoCardlessPro
       attr_reader :authorisation_url
       attr_reader :auto_fulfil
       attr_reader :created_at
+      attr_reader :exit_uri
       attr_reader :expires_at
       attr_reader :id
       attr_reader :lock_bank_account
       attr_reader :lock_customer_details
       attr_reader :redirect_uri
       attr_reader :session_token
+      attr_reader :show_redirect_buttons
 
       # Initialize a billing_request_flow resource instance
       # @param object [Hash] an object returned from the API
@@ -34,6 +36,7 @@ module GoCardlessPro
         @authorisation_url = object['authorisation_url']
         @auto_fulfil = object['auto_fulfil']
         @created_at = object['created_at']
+        @exit_uri = object['exit_uri']
         @expires_at = object['expires_at']
         @id = object['id']
         @links = object['links']
@@ -41,6 +44,7 @@ module GoCardlessPro
         @lock_customer_details = object['lock_customer_details']
         @redirect_uri = object['redirect_uri']
         @session_token = object['session_token']
+        @show_redirect_buttons = object['show_redirect_buttons']
         @response = response
       end
 

data/lib/gocardless_pro/resources/block.rb

@@ -12,17 +12,27 @@ module GoCardlessPro
   module Resources
     # Represents an instance of a block resource returned from the API
 
-    # A block object is a simple rule, when matched, pushes a newly created
-    # mandate to a blocked state. These details can be an exact match, like a
-    # bank account
-    # or an email, or a more generic match such as an email domain. New block
-    # types may be added
-    # over time. Payments and subscriptions can't be created against mandates in
-    # blocked state.
+    # Blocks are created to prevent certain customer details from being used
+    # when creating
+    # mandates.
+    #
+    # The details used to create blocks can be exact matches, like a bank
+    # account or an email,
+    # or a more generic match such as an email domain. New block types may be
+    # added over time.
+    #
+    # A block object is in essence a simple rule that is used to match against
+    # details in a
+    # newly created mandate. If there is a successful match then the mandate is
+    # transitioned
+    # to a "blocked" state.
+    #
+    # Payments and subscriptions cannot be created against a mandate in blocked
+    # state.
+    #
+    # A mandate can never be transitioned out of the blocked state.
     #
     # <p class="notice">
-    #   Client libraries have not yet been updated for this API but will be
-    # released soon.
     #   This API is currently only available for approved integrators - please
     # <a href="mailto:help@gocardless.com">get in touch</a> if you would like to
     # use this API.

data/lib/gocardless_pro/resources/institution.rb

@@ -13,7 +13,11 @@ module GoCardlessPro
     # Represents an instance of a institution resource returned from the API
 
     # Institutions that are supported when creating [Bank
-    # Authorisations](#billing-requests-bank-authorisations).
+    # Authorisations](#billing-requests-bank-authorisations) for a particular
+    # country or purpose.
+    #
+    # Not all institutions support both Payment Initiation (PIS) and Account
+    # Information (AIS) services.
     class Institution
       attr_reader :country_code
       attr_reader :icon_url

data/lib/gocardless_pro/resources/payer_authorisation.rb

@@ -13,12 +13,12 @@ module GoCardlessPro
     # Represents an instance of a payer_authorisation resource returned from the API
 
     # <p class="restricted-notice">
-    #   Payer Authorisations is deprecated in favour of
+    #   Don't use Payer Authorisations for new integrations.
+    #   It is deprecated in favour of
     #   <a
     # href="https://developer.gocardless.com/getting-started/billing-requests/overview/">
-    #   Billing Requests</a>. Please consider using Billing Requests to build
-    # any
-    #   future integrations.
+    #   Billing Requests</a>. Use Billing Requests to build any future
+    # integrations.
     # </p>
     #
     # Payer Authorisation resource acts as a wrapper for creating customer, bank

data/lib/gocardless_pro/resources/redirect_flow.rb

@@ -94,6 +94,10 @@ module GoCardlessPro
           @links = links || {}
         end
 
+        def billing_request
+          @links['billing_request']
+        end
+
         def creditor
           @links['creditor']
         end

data/lib/gocardless_pro/services/billing_request_flows_service.rb

@@ -34,7 +34,7 @@ module GoCardlessPro
       # integrations that manipulate the flow.
       # Example URL: /billing_request_flows/:identity/actions/initialise
       #
-      # @param identity       # Unique identifier, beginning with "BRQ".
+      # @param identity       # Unique identifier, beginning with "BRF".
       # @param options [Hash] parameters as a hash, under a params key.
       def initialise(identity, options = {})
         path = sub_url('/billing_request_flows/:identity/actions/initialise', 'identity' => identity)

data/lib/gocardless_pro/services/billing_requests_service.rb

@@ -11,7 +11,7 @@ module GoCardlessPro
     # Service for making requests to the BillingRequest endpoints
     class BillingRequestsService < BaseService
       # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
-      # billing_requests.
+      # billing requests.
       # Example URL: /billing_requests
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -218,7 +218,7 @@ module GoCardlessPro
         Resources::BillingRequest.new(unenvelope_body(response.body), response)
       end
 
-      # This is needed when you have mandate_request. As a scheme compliance rule we
+      # This is needed when you have a mandate request. As a scheme compliance rule we
       # are required to
       # allow the payer to crosscheck the details entered by them and confirm it.
       # Example URL: /billing_requests/:identity/actions/confirm_payer_details
@@ -334,6 +334,44 @@ module GoCardlessPro
         Resources::BillingRequest.new(unenvelope_body(response.body), response)
       end
 
+      # Triggers a fallback from the open-banking flow to direct debit. Note, the
+      # billing request must have fallback enabled.
+      # Example URL: /billing_requests/:identity/actions/fallback
+      #
+      # @param identity       # Unique identifier, beginning with "BRQ".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def fallback(identity, options = {})
+        path = sub_url('/billing_requests/:identity/actions/fallback', 'identity' => identity)
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params]['data'] = params
+
+        options[:retry_failures] = false
+
+        begin
+          response = make_request(:post, path, options)
+
+          # Response doesn't raise any errors until #body is called
+          response.tap(&:body)
+        rescue InvalidStateError => e
+          if e.idempotent_creation_conflict?
+            case @api_service.on_idempotency_conflict
+            when :raise
+              raise IdempotencyConflict, e.error
+            when :fetch
+              return get(e.conflicting_resource_id)
+            end
+          end
+
+          raise e
+        end
+
+        return if response.body.nil?
+
+        Resources::BillingRequest.new(unenvelope_body(response.body), response)
+      end
+
       private
 
       # Unenvelope the response of the body using the service's `envelope_key`

data/lib/gocardless_pro/services/institutions_service.rb

@@ -10,7 +10,7 @@ module GoCardlessPro
   module Services
     # Service for making requests to the Institution endpoints
     class InstitutionsService < BaseService
-      # Returns a list of all supported institutions.
+      # Returns a list of supported institutions.
       # Example URL: /institutions
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})

data/lib/gocardless_pro/version.rb

@@ -4,5 +4,5 @@ end
 
 module GoCardlessPro
   # Current version of the GC gem
-  VERSION = '2.29.0'.freeze
+  VERSION = '2.30.0'.freeze
 end

data/spec/resources/billing_request_flow_spec.rb

@@ -18,6 +18,7 @@ describe GoCardlessPro::Resources::BillingRequestFlow do
           'authorisation_url' => 'authorisation_url-input',
           'auto_fulfil' => 'auto_fulfil-input',
           'created_at' => 'created_at-input',
+          'exit_uri' => 'exit_uri-input',
           'expires_at' => 'expires_at-input',
           'id' => 'id-input',
           'links' => 'links-input',
@@ -25,6 +26,7 @@ describe GoCardlessPro::Resources::BillingRequestFlow do
           'lock_customer_details' => 'lock_customer_details-input',
           'redirect_uri' => 'redirect_uri-input',
           'session_token' => 'session_token-input',
+          'show_redirect_buttons' => 'show_redirect_buttons-input',
         }
       end
 
@@ -37,6 +39,7 @@ describe GoCardlessPro::Resources::BillingRequestFlow do
                 'authorisation_url' => 'authorisation_url-input',
                 'auto_fulfil' => 'auto_fulfil-input',
                 'created_at' => 'created_at-input',
+                'exit_uri' => 'exit_uri-input',
                 'expires_at' => 'expires_at-input',
                 'id' => 'id-input',
                 'links' => 'links-input',
@@ -44,6 +47,7 @@ describe GoCardlessPro::Resources::BillingRequestFlow do
                 'lock_customer_details' => 'lock_customer_details-input',
                 'redirect_uri' => 'redirect_uri-input',
                 'session_token' => 'session_token-input',
+                'show_redirect_buttons' => 'show_redirect_buttons-input',
               },
             }
           ).
@@ -56,6 +60,7 @@ describe GoCardlessPro::Resources::BillingRequestFlow do
                   'authorisation_url' => 'authorisation_url-input',
                   'auto_fulfil' => 'auto_fulfil-input',
                   'created_at' => 'created_at-input',
+                  'exit_uri' => 'exit_uri-input',
                   'expires_at' => 'expires_at-input',
                   'id' => 'id-input',
                   'links' => 'links-input',
@@ -63,6 +68,7 @@ describe GoCardlessPro::Resources::BillingRequestFlow do
                   'lock_customer_details' => 'lock_customer_details-input',
                   'redirect_uri' => 'redirect_uri-input',
                   'session_token' => 'session_token-input',
+                  'show_redirect_buttons' => 'show_redirect_buttons-input',
                 },
 
             }.to_json,
@@ -108,6 +114,7 @@ describe GoCardlessPro::Resources::BillingRequestFlow do
           'authorisation_url' => 'authorisation_url-input',
           'auto_fulfil' => 'auto_fulfil-input',
           'created_at' => 'created_at-input',
+          'exit_uri' => 'exit_uri-input',
           'expires_at' => 'expires_at-input',
           'id' => 'id-input',
           'links' => 'links-input',
@@ -115,6 +122,7 @@ describe GoCardlessPro::Resources::BillingRequestFlow do
           'lock_customer_details' => 'lock_customer_details-input',
           'redirect_uri' => 'redirect_uri-input',
           'session_token' => 'session_token-input',
+          'show_redirect_buttons' => 'show_redirect_buttons-input',
         }
       end
 
@@ -156,12 +164,14 @@ describe GoCardlessPro::Resources::BillingRequestFlow do
       # /billing_request_flows/%v/actions/initialise
       stub_url = '/billing_request_flows/:identity/actions/initialise'.gsub(':identity', resource_id)
       stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+
         body: {
           'billing_request_flows' => {
 
             'authorisation_url' => 'authorisation_url-input',
             'auto_fulfil' => 'auto_fulfil-input',
             'created_at' => 'created_at-input',
+            'exit_uri' => 'exit_uri-input',
             'expires_at' => 'expires_at-input',
             'id' => 'id-input',
             'links' => 'links-input',
@@ -169,8 +179,10 @@ describe GoCardlessPro::Resources::BillingRequestFlow do
             'lock_customer_details' => 'lock_customer_details-input',
             'redirect_uri' => 'redirect_uri-input',
             'session_token' => 'session_token-input',
+            'show_redirect_buttons' => 'show_redirect_buttons-input',
           },
         }.to_json,
+
         headers: response_headers
       )
     end
@@ -202,6 +214,7 @@ describe GoCardlessPro::Resources::BillingRequestFlow do
                 'authorisation_url' => 'authorisation_url-input',
                 'auto_fulfil' => 'auto_fulfil-input',
                 'created_at' => 'created_at-input',
+                'exit_uri' => 'exit_uri-input',
                 'expires_at' => 'expires_at-input',
                 'id' => 'id-input',
                 'links' => 'links-input',
@@ -209,6 +222,7 @@ describe GoCardlessPro::Resources::BillingRequestFlow do
                 'lock_customer_details' => 'lock_customer_details-input',
                 'redirect_uri' => 'redirect_uri-input',
                 'session_token' => 'session_token-input',
+                'show_redirect_buttons' => 'show_redirect_buttons-input',
               },
             }.to_json,
             headers: response_headers