Merge pull request #104 from gocardless/template-changes

v2.36.0

Author: opsz2

lib/gocardless_pro.rb

@@ -98,6 +98,9 @@ module GoCardlessPro
 require_relative 'gocardless_pro/resources/mandate_pdf'
 require_relative 'gocardless_pro/services/mandate_pdfs_service'
 
+require_relative 'gocardless_pro/resources/mandate_request_constraints'
+require_relative 'gocardless_pro/services/mandate_request_constraints_service'
+
 require_relative 'gocardless_pro/resources/payer_authorisation'
 require_relative 'gocardless_pro/services/payer_authorisations_service'
 

lib/gocardless_pro/client.rb

@@ -98,6 +98,11 @@ def mandate_pdfs
       @mandate_pdfs ||= Services::MandatePdfsService.new(@api_service)
     end
 
+    # Access to the service for mandate_request_constraints to make API calls
+    def mandate_request_constraints
+      @mandate_request_constraints ||= Services::MandateRequestConstraintsService.new(@api_service)
+    end
+
     # Access to the service for payer_authorisation to make API calls
     def payer_authorisations
       @payer_authorisations ||= Services::PayerAuthorisationsService.new(@api_service)
@@ -198,7 +203,7 @@ def default_options
           'User-Agent' => user_agent.to_s,
           'Content-Type' => 'application/json',
           'GoCardless-Client-Library' => 'gocardless-pro-ruby',
-          'GoCardless-Client-Version' => '2.35.0',
+          'GoCardless-Client-Version' => '2.36.0',
         },
       }
     end

lib/gocardless_pro/resources/billing_request_template.rb

@@ -18,6 +18,7 @@ class BillingRequestTemplate
       attr_reader :created_at
       attr_reader :id
       attr_reader :mandate_request_currency
+      attr_reader :mandate_request_description
       attr_reader :mandate_request_metadata
       attr_reader :mandate_request_scheme
       attr_reader :mandate_request_verify
@@ -40,6 +41,7 @@ def initialize(object, response = nil)
         @created_at = object['created_at']
         @id = object['id']
         @mandate_request_currency = object['mandate_request_currency']
+        @mandate_request_description = object['mandate_request_description']
         @mandate_request_metadata = object['mandate_request_metadata']
         @mandate_request_scheme = object['mandate_request_scheme']
         @mandate_request_verify = object['mandate_request_verify']

lib/gocardless_pro/resources/block.rb

@@ -18,24 +18,37 @@ module Resources
     #
     # 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.
+    # or a more generic match such as an email domain or bank name. Please be
+    # careful when creating
+    # blocks for more generic matches as this may block legitimate payers from
+    # using your service.
     #
-    # 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.
+    # New block types may be added over time.
     #
-    # Payments and subscriptions cannot be created against a mandate in blocked
-    # state.
+    # A block 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.
     #
-    # A mandate can never be transitioned out of the blocked state.
+    # Please note:
+    #
+    #   - Payments and subscriptions cannot be created against a mandate in
+    # blocked state.
+    #   - A mandate can never be transitioned out of the blocked state.
+    #
+    # The one exception to this is when blocking a 'bank_name'. This block will
+    # prevent bank
+    # accounts from being created for banks that match the given name. To ensure
+    # we match
+    # bank names correctly an existing bank account must be used when creating
+    # this block. Please
+    # be aware that we cannot always match a bank account to a given bank name.
     #
     # <p class="notice">
-    #   This API is currently only available for approved integrators - please
-    # <a href="mailto:[email protected]">get in touch</a> if you would like to
-    # use this API.
+    #   This API is currently only available for GoCardless Protect+ integrators
+    # - please <a href="mailto:[email protected]">get in touch</a> if you
+    # would like to use this API.
     # </p>
     class Block
       attr_reader :active

lib/gocardless_pro/resources/mandate_request_constraints.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+#
+# This client is automatically generated from a template and JSON schema definition.
+# See https://github.com/gocardless/gocardless-pro-ruby#contributing before editing.
+#
+
+require 'uri'
+
+module GoCardlessPro
+  # A module containing classes for each of the resources in the GC Api
+  module Resources
+    # Represents an instance of a mandate_request_constraints resource returned from the API
+
+    # Constraints that will apply to the mandate_request. (Optional)
+    # Specifically for PayTo and VRP.
+    class MandateRequestConstraints
+      attr_reader :end_date
+      attr_reader :max_amount_per_payment
+      attr_reader :periodic_limits
+      attr_reader :start_date
+
+      # Initialize a mandate_request_constraints resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @end_date = object['end_date']
+        @max_amount_per_payment = object['max_amount_per_payment']
+        @periodic_limits = object['periodic_limits']
+        @start_date = object['start_date']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Provides the mandate_request_constraints resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+    end
+  end
+end

lib/gocardless_pro/services/mandate_request_constraints_service.rb

@@ -0,0 +1,28 @@
+require_relative './base_service'
+
+# encoding: utf-8
+#
+# This client is automatically generated from a template and JSON schema definition.
+# See https://github.com/gocardless/gocardless-pro-ruby#contributing before editing.
+#
+
+module GoCardlessPro
+  module Services
+    # Service for making requests to the MandateRequestConstraints endpoints
+    class MandateRequestConstraintsService < BaseService
+      private
+
+      # Unenvelope the response of the body using the service's `envelope_key`
+      #
+      # @param body [Hash]
+      def unenvelope_body(body)
+        body[envelope_key] || body['data']
+      end
+
+      # return the key which API responses will envelope data under
+      def envelope_key
+        'mandate_request_constraints'
+      end
+    end
+  end
+end

lib/gocardless_pro/version.rb

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

spec/resources/billing_request_template_spec.rb

@@ -22,6 +22,7 @@
               'created_at' => 'created_at-input',
               'id' => 'id-input',
               'mandate_request_currency' => 'mandate_request_currency-input',
+              'mandate_request_description' => 'mandate_request_description-input',
               'mandate_request_metadata' => 'mandate_request_metadata-input',
               'mandate_request_scheme' => 'mandate_request_scheme-input',
               'mandate_request_verify' => 'mandate_request_verify-input',
@@ -57,6 +58,8 @@
 
         expect(get_list_response.records.first.mandate_request_currency).to eq('mandate_request_currency-input')
 
+        expect(get_list_response.records.first.mandate_request_description).to eq('mandate_request_description-input')
+
         expect(get_list_response.records.first.mandate_request_metadata).to eq('mandate_request_metadata-input')
 
         expect(get_list_response.records.first.mandate_request_scheme).to eq('mandate_request_scheme-input')
@@ -101,6 +104,7 @@
             'created_at' => 'created_at-input',
             'id' => 'id-input',
             'mandate_request_currency' => 'mandate_request_currency-input',
+            'mandate_request_description' => 'mandate_request_description-input',
             'mandate_request_metadata' => 'mandate_request_metadata-input',
             'mandate_request_scheme' => 'mandate_request_scheme-input',
             'mandate_request_verify' => 'mandate_request_verify-input',
@@ -132,6 +136,7 @@
             'created_at' => 'created_at-input',
             'id' => 'id-input',
             'mandate_request_currency' => 'mandate_request_currency-input',
+            'mandate_request_description' => 'mandate_request_description-input',
             'mandate_request_metadata' => 'mandate_request_metadata-input',
             'mandate_request_scheme' => 'mandate_request_scheme-input',
             'mandate_request_verify' => 'mandate_request_verify-input',
@@ -179,6 +184,7 @@
                 'created_at' => 'created_at-input',
                 'id' => 'id-input',
                 'mandate_request_currency' => 'mandate_request_currency-input',
+                'mandate_request_description' => 'mandate_request_description-input',
                 'mandate_request_metadata' => 'mandate_request_metadata-input',
                 'mandate_request_scheme' => 'mandate_request_scheme-input',
                 'mandate_request_verify' => 'mandate_request_verify-input',
@@ -220,6 +226,7 @@
               'created_at' => 'created_at-input',
               'id' => 'id-input',
               'mandate_request_currency' => 'mandate_request_currency-input',
+              'mandate_request_description' => 'mandate_request_description-input',
               'mandate_request_metadata' => 'mandate_request_metadata-input',
               'mandate_request_scheme' => 'mandate_request_scheme-input',
               'mandate_request_verify' => 'mandate_request_verify-input',
@@ -276,6 +283,7 @@
           'created_at' => 'created_at-input',
           'id' => 'id-input',
           'mandate_request_currency' => 'mandate_request_currency-input',
+          'mandate_request_description' => 'mandate_request_description-input',
           'mandate_request_metadata' => 'mandate_request_metadata-input',
           'mandate_request_scheme' => 'mandate_request_scheme-input',
           'mandate_request_verify' => 'mandate_request_verify-input',
@@ -301,6 +309,7 @@
                 'created_at' => 'created_at-input',
                 'id' => 'id-input',
                 'mandate_request_currency' => 'mandate_request_currency-input',
+                'mandate_request_description' => 'mandate_request_description-input',
                 'mandate_request_metadata' => 'mandate_request_metadata-input',
                 'mandate_request_scheme' => 'mandate_request_scheme-input',
                 'mandate_request_verify' => 'mandate_request_verify-input',
@@ -326,6 +335,7 @@
                   'created_at' => 'created_at-input',
                   'id' => 'id-input',
                   'mandate_request_currency' => 'mandate_request_currency-input',
+                  'mandate_request_description' => 'mandate_request_description-input',
                   'mandate_request_metadata' => 'mandate_request_metadata-input',
                   'mandate_request_scheme' => 'mandate_request_scheme-input',
                   'mandate_request_verify' => 'mandate_request_verify-input',
@@ -384,6 +394,7 @@
           'created_at' => 'created_at-input',
           'id' => 'id-input',
           'mandate_request_currency' => 'mandate_request_currency-input',
+          'mandate_request_description' => 'mandate_request_description-input',
           'mandate_request_metadata' => 'mandate_request_metadata-input',
           'mandate_request_scheme' => 'mandate_request_scheme-input',
           'mandate_request_verify' => 'mandate_request_verify-input',
@@ -432,6 +443,7 @@
                 'created_at' => 'created_at-input',
                 'id' => 'id-input',
                 'mandate_request_currency' => 'mandate_request_currency-input',
+                'mandate_request_description' => 'mandate_request_description-input',
                 'mandate_request_metadata' => 'mandate_request_metadata-input',
                 'mandate_request_scheme' => 'mandate_request_scheme-input',
                 'mandate_request_verify' => 'mandate_request_verify-input',
@@ -475,6 +487,7 @@
               'created_at' => 'created_at-input',
               'id' => 'id-input',
               'mandate_request_currency' => 'mandate_request_currency-input',
+              'mandate_request_description' => 'mandate_request_description-input',
               'mandate_request_metadata' => 'mandate_request_metadata-input',
               'mandate_request_scheme' => 'mandate_request_scheme-input',
               'mandate_request_verify' => 'mandate_request_verify-input',

spec/resources/mandate_request_constraints_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe GoCardlessPro::Resources::MandateRequestConstraints do
+  let(:client) do
+    GoCardlessPro::Client.new(
+      access_token: 'SECRET_TOKEN'
+    )
+  end
+
+  let(:response_headers) { { 'Content-Type' => 'application/json' } }
+end