gocardless_pro 2.44.0 → 2.46.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f18c023fdf2776637fc1228dbd79184ac6f669be1733e9d45a8b0d83fd75811f
-  data.tar.gz: f38f5cffffeefd3fde896538c9767c89c4e4b9075d8f2b153223ed6a6b235942
+  metadata.gz: 48f0431f3dc2e7308c560e95cb938c975ce7d3dc6a731357975779e04c9fb724
+  data.tar.gz: 5efc3b834b594cb4ed1a8c8d0355537d69e55ca9a44c036810e5c07f0e7ae86a
 SHA512:
-  metadata.gz: b400be69bb579451995ccaa792e3b25429858ba4ea32aa6d26105c5a767bbefb587a3537a6cb9740469ee7c1628d390cab66073aa5d66b0b21dc52428e5774b5
-  data.tar.gz: 1e8552a627d5bf46361e3871442341d6a464b49065d91c2034535cffad18a6e6476fa4dfc86c85118d532982373de62c5f1d9421ee5239d02813246c5d0bcc94
+  metadata.gz: a5d8b6cacedabdf6658e7567f0b4b0cfd5687d7c25fee78d70bc124168f87dd7bdd035d36125378b6ecd797fc3025ec2f785397238d57457a5c0719c5d6d2cb6
+  data.tar.gz: 82df3b65a0f45cb0d067ba0f98794cd7a716d6aa5ce515b55a15124f8d9b88b94c4baf05eec3f41a1e2e1bce26e243a965f213b55db06a12a4f1cf02ec8680fc

data/lib/gocardless_pro/client.rb

@@ -98,6 +98,11 @@ module GoCardlessPro
       @mandate_pdfs ||= Services::MandatePdfsService.new(@api_service)
     end
 
+    # Access to the service for negative_balance_limit to make API calls
+    def negative_balance_limits
+      @negative_balance_limits ||= Services::NegativeBalanceLimitsService.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)
@@ -208,7 +213,7 @@ module GoCardlessPro
           'User-Agent' => "#{user_agent}",
           'Content-Type' => 'application/json',
           'GoCardless-Client-Library' => 'gocardless-pro-ruby',
-          'GoCardless-Client-Version' => '2.44.0',
+          'GoCardless-Client-Version' => '2.46.0',
         },
       }
     end

data/lib/gocardless_pro/resources/bank_authorisation.rb

@@ -27,6 +27,7 @@ module GoCardlessPro
       attr_reader :expires_at
       attr_reader :id
       attr_reader :last_visited_at
+      attr_reader :qr_code_url
       attr_reader :redirect_uri
       attr_reader :url
 
@@ -42,6 +43,7 @@ module GoCardlessPro
         @id = object['id']
         @last_visited_at = object['last_visited_at']
         @links = object['links']
+        @qr_code_url = object['qr_code_url']
         @redirect_uri = object['redirect_uri']
         @url = object['url']
         @response = response

data/lib/gocardless_pro/resources/creditor.rb

@@ -18,10 +18,10 @@ module GoCardlessPro
     # Currently, for Anti Money Laundering reasons, any creditors you add must
     # be directly related to your organisation.
     class Creditor
-      attr_reader :activated
       attr_reader :address_line1
       attr_reader :address_line2
       attr_reader :address_line3
+      attr_reader :bank_reference_prefix
       attr_reader :can_create_refunds
       attr_reader :city
       attr_reader :country_code
@@ -44,10 +44,10 @@ module GoCardlessPro
       def initialize(object, response = nil)
         @object = object
 
-        @activated = object['activated']
         @address_line1 = object['address_line1']
         @address_line2 = object['address_line2']
         @address_line3 = object['address_line3']
+        @bank_reference_prefix = object['bank_reference_prefix']
         @can_create_refunds = object['can_create_refunds']
         @city = object['city']
         @country_code = object['country_code']

data/lib/gocardless_pro/resources/institution.rb

@@ -17,7 +17,7 @@ module GoCardlessPro
     # Not all institutions support both Payment Initiation (PIS) and Account
     # Information (AIS) services.
     class Institution
-      attr_reader :bank_redirect
+      attr_reader :autocompletes_collect_bank_account
       attr_reader :country_code
       attr_reader :icon_url
       attr_reader :id
@@ -29,7 +29,7 @@ module GoCardlessPro
       def initialize(object, response = nil)
         @object = object
 
-        @bank_redirect = object['bank_redirect']
+        @autocompletes_collect_bank_account = object['autocompletes_collect_bank_account']
         @country_code = object['country_code']
         @icon_url = object['icon_url']
         @id = object['id']

data/lib/gocardless_pro/resources/negative_balance_limit.rb

@@ -0,0 +1,69 @@
+#
+# 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 negative_balance_limit resource returned from the API
+
+    # The negative balance limit for a creditor. If the creditor would exceed
+    # this limit, we will not allow the creation of refunds.
+    class NegativeBalanceLimit
+      attr_reader :active
+      attr_reader :balance_limit
+      attr_reader :created_at
+      attr_reader :currency
+      attr_reader :id
+      attr_reader :reason
+      attr_reader :updated_at
+
+      # Initialize a negative_balance_limit resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @active = object['active']
+        @balance_limit = object['balance_limit']
+        @created_at = object['created_at']
+        @currency = object['currency']
+        @id = object['id']
+        @links = object['links']
+        @reason = object['reason']
+        @updated_at = object['updated_at']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Return the links that the resource has
+      def links
+        @negative_balance_limit_links ||= Links.new(@links)
+      end
+
+      # Provides the negative_balance_limit resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+
+      class Links
+        def initialize(links)
+          @links = links || {}
+        end
+
+        def creator_user
+          @links['creator_user']
+        end
+
+        def creditor
+          @links['creditor']
+        end
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/subscription.rb

@@ -17,7 +17,6 @@ module GoCardlessPro
     #
     # The following rules apply when specifying recurrence:
     #
-    # - The first payment must be charged within 1 year.
     # - If `day_of_month` and `start_date` are not provided `start_date` will be
     # the [mandate](#core-endpoints-mandates)'s `next_possible_charge_date` and
     # the subscription will then recur based on the `interval` & `interval_unit`

data/lib/gocardless_pro/services/creditors_service.rb

@@ -117,52 +117,6 @@ module GoCardlessPro
         Resources::Creditor.new(unenvelope_body(response.body), response)
       end
 
-      # Applies a [scheme identifier](#core-endpoints-scheme-identifiers) to a
-      # creditor.
-      # If the creditor already has a scheme identifier for the scheme, it will be
-      # replaced,
-      # and any mandates attached to it transferred asynchronously.
-      # For some schemes, the application of the scheme identifier will be performed
-      # asynchronously.
-      #
-      # Example URL: /creditors/:identity/actions/apply_scheme_identifier
-      #
-      # @param identity       # Unique identifier, beginning with "CR".
-      # @param options [Hash] parameters as a hash, under a params key.
-      def apply_scheme_identifier(identity, options = {})
-        path = sub_url('/creditors/:identity/actions/apply_scheme_identifier', {
-                         '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::Creditor.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/negative_balance_limits_service.rb

@@ -0,0 +1,77 @@
+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 NegativeBalanceLimit endpoints
+    class NegativeBalanceLimitsService < BaseService
+      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of negative
+      # balance limits.
+      # Example URL: /negative_balance_limits
+      # @param options [Hash] parameters as a hash, under a params key.
+      def list(options = {})
+        path = '/negative_balance_limits'
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        ListResponse.new(
+          response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::NegativeBalanceLimit
+        )
+      end
+
+      # Get a lazily enumerated list of all the items returned. This is similar to the `list` method but will paginate for you automatically.
+      #
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Otherwise they will be the body of the request.
+      def all(options = {})
+        Paginator.new(
+          service: self,
+          options: options
+        ).enumerator
+      end
+
+      # Creates a new negative balance limit, which also deactivates the existing
+      # limit (if present) for that currency and creditor combination.
+      # Example URL: /negative_balance_limits
+      # @param options [Hash] parameters as a hash, under a params key.
+      def create(options = {})
+        path = '/negative_balance_limits'
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params][envelope_key] = params
+
+        options[:retry_failures] = true
+
+        response = make_request(:post, path, options)
+
+        return if response.body.nil?
+
+        Resources::NegativeBalanceLimit.new(unenvelope_body(response.body), response)
+      end
+
+      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
+        'negative_balance_limits'
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/scheme_identifiers_service.rb

@@ -15,33 +15,39 @@ module GoCardlessPro
       # are taken
       # using it. The scheme identifier must also have the `status` of active before
       # it can be
-      # used. For some schemes e.g. faster_payments this will happen instantly. For
-      # other schemes
-      # e.g. bacs this can take several days.
+      # used. On Bacs, this will take 5 working days. On other schemes, this happens
+      # instantly.
       #
-      # ### Scheme identifier name validations
+      # #### Scheme identifier name validations
       #
-      # Each scheme has different rules for the length and permitted characters in the
-      # scheme identifier
-      # name field. The rules are:
+      # The `name` field of a scheme identifier can contain alphanumeric characters,
+      # spaces and
+      # special characters.
       #
-      # | __scheme__      | __maximum length__ | __allowed characters__   | __spaces__
-      # |
-      # | :-------------- | :----------------- | :----------------------- | :---------
-      # |
-      # | bacs            | 18 characters      | `a-zA-Z0-9/.&-`          | yes
-      # |
-      # | sepa_core       | 70 characters      | `a-zA-Z0-9/?:().,+&<>'"` | yes
-      # |
-      # | ach             | 16 characters      | `a-zA-Z0-9/?:().,'+-`    | yes
-      # |
-      # | faster_payments | 18 characters      | `a-zA-Z0-9/?:().,'+-`    | yes
-      # |
+      # Its maximum length and the special characters it supports depend on the
+      # scheme:
+      #
+      # | __scheme__        | __maximum length__ | __special characters allowed__
+      #                 |
+      # | :---------------- | :----------------- |
+      # :-------------------------------------------------- |
+      # | `bacs`            | 18 characters      | `/` `.` `&` `-`
+      #                 |
+      # | `sepa`            | 70 characters      | `/` `?` `:` `(` `)` `.` `,` `+` `&`
+      # `<` `>` `'` `"` |
+      # | `ach`             | 16 characters      | `/` `?` `:` `(` `)` `.` `,` `'` `+`
+      # `-`             |
+      # | `faster_payments` | 18 characters      | `/` `?` `:` `(` `)` `.` `,` `'` `+`
+      # `-`             |
       #
       # The validation error that gets returned for an invalid name will contain a
       # suggested name
       # in the metadata that is guaranteed to pass name validations.
       #
+      # You should ensure that the name you set matches the legal name or the trading
+      # name of
+      # the creditor, otherwise, there is an increased risk of chargeback.
+      #
       # Example URL: /scheme_identifiers
       # @param options [Hash] parameters as a hash, under a params key.
       def create(options = {})

data/lib/gocardless_pro/version.rb

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

data/lib/gocardless_pro.rb

@@ -96,6 +96,9 @@ require_relative 'gocardless_pro/services/mandate_import_entries_service'
 require_relative 'gocardless_pro/resources/mandate_pdf'
 require_relative 'gocardless_pro/services/mandate_pdfs_service'
 
+require_relative 'gocardless_pro/resources/negative_balance_limit'
+require_relative 'gocardless_pro/services/negative_balance_limits_service'
+
 require_relative 'gocardless_pro/resources/payer_authorisation'
 require_relative 'gocardless_pro/services/payer_authorisations_service'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gocardless_pro
 version: !ruby/object:Gem::Version
-  version: 2.44.0
+  version: 2.46.0
 platform: ruby
 authors:
 - GoCardless
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-16 00:00:00.000000000 Z
+date: 2023-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -131,6 +131,7 @@ files:
 - lib/gocardless_pro/resources/mandate_import.rb
 - lib/gocardless_pro/resources/mandate_import_entry.rb
 - lib/gocardless_pro/resources/mandate_pdf.rb
+- lib/gocardless_pro/resources/negative_balance_limit.rb
 - lib/gocardless_pro/resources/payer_authorisation.rb
 - lib/gocardless_pro/resources/payment.rb
 - lib/gocardless_pro/resources/payout.rb
@@ -164,6 +165,7 @@ files:
 - lib/gocardless_pro/services/mandate_imports_service.rb
 - lib/gocardless_pro/services/mandate_pdfs_service.rb
 - lib/gocardless_pro/services/mandates_service.rb
+- lib/gocardless_pro/services/negative_balance_limits_service.rb
 - lib/gocardless_pro/services/payer_authorisations_service.rb
 - lib/gocardless_pro/services/payments_service.rb
 - lib/gocardless_pro/services/payout_items_service.rb
@@ -197,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: A gem for calling the GoCardless Pro API