gocardless_pro 3.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e7c9c7f865d0173f9fc0f2a577c04178c49f5aea6dcb15499dec10f97eaf2b8
-  data.tar.gz: fe2d4c30469b84f035028d73a9d3edd4f8298306c0f35b3c0eef09653f235182
+  metadata.gz: d491b212bf75a7f70a1191be6b0d7d94eb4fb6cfd2d319047d62d0e2e9adf94b
+  data.tar.gz: e473a9b05df7ec6b70e48f2b426a7fae6585ed0c919a3963d91431d6fe5bd4a4
 SHA512:
-  metadata.gz: a705da86320bda9c898ead0194d23350adbc8280048b0bb01f4f75b5cac1fc010869dbee793f507424640521aea3eb3a26e6d9d988a60809d17a042f1123d085
-  data.tar.gz: 756f6bddc3ba9d8aa5fd944f20427b74990e2dae69f2d30ca378f06ef4007c786d152e98abf8dc95000079261c28965436f0d63faeb096eb7e98f1ffacb8fe83
+  metadata.gz: b605624bcbbace950cf6ad9c4558a0b06abc9da731c85e934645716918cd9b9b9a5b25649e7a3e9fab57d8ca38f4facb8a221276062a1671e168eaff294d94e6
+  data.tar.gz: eeb013ab2a0278f9f56ccb437b0f61107d7afdbdbb9670a58aff1c6afea7086b319f9a349996401d64c68281c9be743a27d1e1e7318d6ae0a6681325e438a6d1

data/lib/gocardless_pro/client.rb

@@ -233,7 +233,7 @@ module GoCardlessPro
           'User-Agent' => "#{user_agent}",
           'Content-Type' => 'application/json',
           'GoCardless-Client-Library' => 'gocardless-pro-ruby',
-          'GoCardless-Client-Version' => '3.0.0'
+          'GoCardless-Client-Version' => '3.2.0'
         }
       }
     end

data/lib/gocardless_pro/resources/billing_request.rb

@@ -10,18 +10,20 @@ module GoCardlessPro
   module Resources
     # Represents an instance of a billing_request resource returned from the API
 
-    # Billing Requests help create resources that require input or action from a
-    # customer. An example of required input might be additional customer
-    # billing
-    # details, while an action would be asking a customer to authorise a payment
-    # using their mobile banking app.
+    #  Billing Requests help create resources that require input or action from
+    # a customer. An example of required input might be additional customer
+    # billing details, while an action would be asking a customer to authorise a
+    # payment using their mobile banking app.
     #
     # See [Billing Requests:
     # Overview](https://developer.gocardless.com/getting-started/billing-requests/overview/)
-    # for how-to's, explanations and tutorials.
+    # for how-to's, explanations and tutorials. <p
+    # class="notice"><strong>Important</strong>: All properties associated with
+    # `subscription_request` and `instalment_schedule_request` are only
+    # supported for ACH and PAD schemes.</p>
     class BillingRequest
-      attr_reader :actions, :created_at, :fallback_enabled, :id, :mandate_request, :metadata, :payment_request,
-                  :purpose_code, :resources, :status, :subscription_request
+      attr_reader :actions, :created_at, :fallback_enabled, :fallback_occurred, :id, :instalment_schedule_request,
+                  :mandate_request, :metadata, :payment_request, :purpose_code, :resources, :status, :subscription_request
 
       # Initialize a billing_request resource instance
       # @param object [Hash] an object returned from the API
@@ -31,7 +33,9 @@ module GoCardlessPro
         @actions = object['actions']
         @created_at = object['created_at']
         @fallback_enabled = object['fallback_enabled']
+        @fallback_occurred = object['fallback_occurred']
         @id = object['id']
+        @instalment_schedule_request = object['instalment_schedule_request']
         @links = object['links']
         @mandate_request = object['mandate_request']
         @metadata = object['metadata']
@@ -82,6 +86,14 @@ module GoCardlessPro
           @links['customer_billing_detail']
         end
 
+        def instalment_schedule_request
+          @links['instalment_schedule_request']
+        end
+
+        def instalment_schedule_request_instalment_schedule
+          @links['instalment_schedule_request_instalment_schedule']
+        end
+
         def mandate_request
           @links['mandate_request']
         end
@@ -109,6 +121,10 @@ module GoCardlessPro
         def subscription_request
           @links['subscription_request']
         end
+
+        def subscription_request_subscription
+          @links['subscription_request_subscription']
+        end
       end
     end
   end

data/lib/gocardless_pro/resources/billing_request_flow.rb

@@ -15,7 +15,7 @@ module GoCardlessPro
     # authorisation (such as open banking single payments).
     class BillingRequestFlow
       attr_reader :authorisation_url, :auto_fulfil, :created_at, :customer_details_captured, :exit_uri, :expires_at,
-                  :id, :language, :lock_bank_account, :lock_currency, :lock_customer_details, :prefilled_bank_account, :prefilled_customer, :redirect_uri, :session_token, :show_redirect_buttons, :show_success_redirect_button
+                  :id, :language, :lock_bank_account, :lock_currency, :lock_customer_details, :prefilled_bank_account, :prefilled_customer, :redirect_uri, :session_token, :show_redirect_buttons, :show_success_redirect_button, :skip_success_screen
 
       # Initialize a billing_request_flow resource instance
       # @param object [Hash] an object returned from the API
@@ -40,6 +40,7 @@ module GoCardlessPro
         @session_token = object['session_token']
         @show_redirect_buttons = object['show_redirect_buttons']
         @show_success_redirect_button = object['show_success_redirect_button']
+        @skip_success_screen = object['skip_success_screen']
         @response = response
       end
 

data/lib/gocardless_pro/resources/mandate_import_entry.rb

@@ -41,7 +41,7 @@ module GoCardlessPro
     # href="mailto:help@gocardless.com">get in touch</a> if you would like to
     # use this API.</p>
     class MandateImportEntry
-      attr_reader :created_at, :record_identifier
+      attr_reader :created_at, :processing_errors, :record_identifier
 
       # Initialize a mandate_import_entry resource instance
       # @param object [Hash] an object returned from the API
@@ -50,6 +50,7 @@ module GoCardlessPro
 
         @created_at = object['created_at']
         @links = object['links']
+        @processing_errors = object['processing_errors']
         @record_identifier = object['record_identifier']
         @response = response
       end

data/lib/gocardless_pro/services/billing_requests_service.rb

@@ -10,7 +10,8 @@ module GoCardlessPro
   module Services
     # Service for making requests to the BillingRequest endpoints
     class BillingRequestsService < BaseService
-      #
+      # <p class="notice"><strong>Important</strong>: All properties associated with
+      # `subscription_request` are only supported for ACH and PAD schemes.</p>
       # Example URL: /billing_requests
       # @param options [Hash] parameters as a hash, under a params key.
       def create(options = {})
@@ -45,6 +46,78 @@ module GoCardlessPro
         Resources::BillingRequest.new(unenvelope_body(response.body), response)
       end
 
+      # <p class="notice"><strong>Important</strong>: All properties associated with
+      # `instalment_schedule_request` are only supported for ACH and PAD schemes.</p>
+      # Example URL: /billing_requests
+      # @param options [Hash] parameters as a hash, under a params key.
+      def create_with_instalments_with_dates(options = {})
+        path = '/billing_requests'
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params][envelope_key] = params
+
+        options[:retry_failures] = true
+
+        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
+
+      # <p class="notice"><strong>Important</strong>: All properties associated with
+      # `instalment_schedule_request` are only supported for ACH and PAD schemes.</p>
+      # Example URL: /billing_requests
+      # @param options [Hash] parameters as a hash, under a params key.
+      def create_with_instalments_with_schedule(options = {})
+        path = '/billing_requests'
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params][envelope_key] = params
+
+        options[:retry_failures] = true
+
+        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
+
       # If the billing request has a pending <code>collect_customer_details</code>
       # action, this endpoint can be used to collect the details in order to
       # complete it.

data/lib/gocardless_pro/version.rb

@@ -3,5 +3,5 @@ end
 
 module GoCardlessPro
   # Current version of the GC gem
-  VERSION = '3.0.0'
+  VERSION = '3.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gocardless_pro
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.2.0
 platform: ruby
 authors:
 - GoCardless
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-24 00:00:00.000000000 Z
+date: 2025-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -86,7 +86,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.11
-description: 
+description:
 email:
 - engineering@gocardless.com
 executables: []
@@ -192,7 +192,7 @@ homepage: https://github.com/gocardless/gocardless-pro-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -208,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.19
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A gem for calling the GoCardless Pro API
 test_files: []