gocardless_pro 4.2.0 → 4.4.1

data/lib/gocardless_pro/services/outbound_payment_import_entries_service.rb

@@ -0,0 +1,64 @@
+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 OutboundPaymentImportEntry endpoints
+    class OutboundPaymentImportEntriesService < BaseService
+      # Returns a cursor-paginated
+      # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+      # list of the entries for a given outbound payment import.
+      # Example URL: /outbound_payment_import_entries
+      # @param options [Hash] parameters as a hash, under a params key.
+      def list(options = {})
+        path = '/outbound_payment_import_entries'
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        ListResponse.new(
+          response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::OutboundPaymentImportEntry
+        )
+      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
+
+      private
+
+      # Unenvelope the response of the body using the service's `envelope_key`
+      #
+      # @param body [Hash]
+      def unenvelope_body(body)
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
+      end
+
+      # return the key which API responses will envelope data under
+      def envelope_key
+        'outbound_payment_import_entries'
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/outbound_payment_imports_service.rb

@@ -0,0 +1,118 @@
+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 OutboundPaymentImport endpoints
+    class OutboundPaymentImportsService < BaseService
+      #
+      # Example URL: /outbound_payment_imports
+      # @param options [Hash] parameters as a hash, under a params key.
+      def create(options = {})
+        path = '/outbound_payment_imports'
+
+        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.new(e.error)
+            when :fetch
+              return get(e.conflicting_resource_id)
+            end
+          end
+
+          raise e
+        end
+
+        return if response.body.nil?
+
+        Resources::OutboundPaymentImport.new(unenvelope_body(response.body), response)
+      end
+
+      # Returns a single outbound payment import.
+      # Example URL: /outbound_payment_imports/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "IM".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def get(identity, options = {})
+        path = sub_url('/outbound_payment_imports/:identity', {
+                         'identity' => identity,
+                       })
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        return if response.body.nil?
+
+        Resources::OutboundPaymentImport.new(unenvelope_body(response.body), response)
+      end
+
+      # Returns a cursor-paginated
+      # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+      # list of your outbound payment imports.
+      # Example URL: /outbound_payment_imports
+      # @param options [Hash] parameters as a hash, under a params key.
+      def list(options = {})
+        path = '/outbound_payment_imports'
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        ListResponse.new(
+          response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::OutboundPaymentImport
+        )
+      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
+
+      private
+
+      # Unenvelope the response of the body using the service's `envelope_key`
+      #
+      # @param body [Hash]
+      def unenvelope_body(body)
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
+      end
+
+      # return the key which API responses will envelope data under
+      def envelope_key
+        'outbound_payment_imports'
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/outbound_payments_service.rb

@@ -31,7 +31,7 @@ module GoCardlessPro
           if e.idempotent_creation_conflict?
             case @api_service.on_idempotency_conflict
             when :raise
-              raise IdempotencyConflict, e.error
+              raise IdempotencyConflict.new(e.error)
             when :fetch
               return get(e.conflicting_resource_id)
             end
@@ -67,7 +67,7 @@ module GoCardlessPro
           if e.idempotent_creation_conflict?
             case @api_service.on_idempotency_conflict
             when :raise
-              raise IdempotencyConflict, e.error
+              raise IdempotencyConflict.new(e.error)
             when :fetch
               return get(e.conflicting_resource_id)
             end
@@ -91,7 +91,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def cancel(identity, options = {})
         path = sub_url('/outbound_payments/:identity/actions/cancel', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -109,7 +109,7 @@ module GoCardlessPro
           if e.idempotent_creation_conflict?
             case @api_service.on_idempotency_conflict
             when :raise
-              raise IdempotencyConflict, e.error
+              raise IdempotencyConflict.new(e.error)
             when :fetch
               return get(e.conflicting_resource_id)
             end
@@ -124,14 +124,14 @@ module GoCardlessPro
       end
 
       # Approves an outbound payment. Only outbound payments with the
-      # “pending_approval” status can be approved.
+      # "pending_approval" status can be approved.
       # Example URL: /outbound_payments/:identity/actions/approve
       #
       # @param identity       # Unique identifier of the outbound payment.
       # @param options [Hash] parameters as a hash, under a params key.
       def approve(identity, options = {})
         path = sub_url('/outbound_payments/:identity/actions/approve', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -149,7 +149,7 @@ module GoCardlessPro
           if e.idempotent_creation_conflict?
             case @api_service.on_idempotency_conflict
             when :raise
-              raise IdempotencyConflict, e.error
+              raise IdempotencyConflict.new(e.error)
             when :fetch
               return get(e.conflicting_resource_id)
             end
@@ -170,7 +170,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/outbound_payments/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         options[:retry_failures] = true
@@ -182,8 +182,9 @@ module GoCardlessPro
         Resources::OutboundPayment.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of outbound
-      # payments.
+      # Returns a cursor-paginated
+      # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+      # list of outbound payments.
       # Example URL: /outbound_payments
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -218,7 +219,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def update(identity, options = {})
         path = sub_url('/outbound_payments/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -234,13 +235,34 @@ module GoCardlessPro
         Resources::OutboundPayment.new(unenvelope_body(response.body), response)
       end
 
+      # Retrieve aggregate statistics on outbound payments.
+      # Example URL: /outbound_payments/stats
+      # @param options [Hash] parameters as a hash, under a params key.
+      def stats(options = {})
+        path = '/outbound_payments/stats'
+
+        options[:retry_failures] = false
+
+        response = make_request(:get, path, options)
+
+        return if response.body.nil?
+
+        Resources::OutboundPayment.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']
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
       end
 
       # return the key which API responses will envelope data under

data/lib/gocardless_pro/services/payer_authorisations_service.rb

@@ -18,7 +18,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/payer_authorisations/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         options[:retry_failures] = true
@@ -56,7 +56,7 @@ module GoCardlessPro
           if e.idempotent_creation_conflict?
             case @api_service.on_idempotency_conflict
             when :raise
-              raise IdempotencyConflict, e.error
+              raise IdempotencyConflict.new(e.error)
             when :fetch
               return get(e.conflicting_resource_id)
             end
@@ -75,17 +75,16 @@ module GoCardlessPro
       # the request will be modified. An empty array of incomplete_fields means that
       # the resource is valid. This endpoint has been designed this way so you do not
       # need to save any payer data on your servers or the browser while still being
-      # able to implement a progressive solution, such a multi-step form. <p
-      # class="notice"> Note that in order to update the `metadata` attribute values
-      # it must be sent completely as it overrides the previously existing values.
-      # </p>
+      # able to implement a progressive solution, such a multi-step form.  Note that
+      # in order to update the `metadata` attribute values it must be sent completely
+      # as it overrides the previously existing values.
       # Example URL: /payer_authorisations/:identity
       #
       # @param identity       # Unique identifier, beginning with "PA".
       # @param options [Hash] parameters as a hash, under a params key.
       def update(identity, options = {})
         path = sub_url('/payer_authorisations/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -111,7 +110,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def submit(identity, options = {})
         path = sub_url('/payer_authorisations/:identity/actions/submit', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -129,7 +128,7 @@ module GoCardlessPro
           if e.idempotent_creation_conflict?
             case @api_service.on_idempotency_conflict
             when :raise
-              raise IdempotencyConflict, e.error
+              raise IdempotencyConflict.new(e.error)
             when :fetch
               return get(e.conflicting_resource_id)
             end
@@ -147,20 +146,18 @@ module GoCardlessPro
       # be created.
       # A Payer Authorisation cannot be confirmed if it hasn't been submitted yet.
       #
-      # <p class="notice">
       #   The main use of the confirm endpoint is to enable integrators to acknowledge
       # the end of the setup process.
-      #   They might want to make the payers go through some other steps after they go
+      # They might want to make the payers go through some other steps after they go
       # through our flow or make them go through the necessary verification mechanism
       # (upcoming feature).
-      # </p>
       # Example URL: /payer_authorisations/:identity/actions/confirm
       #
       # @param identity       # Unique identifier, beginning with "PA".
       # @param options [Hash] parameters as a hash, under a params key.
       def confirm(identity, options = {})
         path = sub_url('/payer_authorisations/:identity/actions/confirm', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -178,7 +175,7 @@ module GoCardlessPro
           if e.idempotent_creation_conflict?
             case @api_service.on_idempotency_conflict
             when :raise
-              raise IdempotencyConflict, e.error
+              raise IdempotencyConflict.new(e.error)
             when :fetch
               return get(e.conflicting_resource_id)
             end
@@ -198,7 +195,13 @@ module GoCardlessPro
       #
       # @param body [Hash]
       def unenvelope_body(body)
-        body[envelope_key] || body['data']
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
       end
 
       # return the key which API responses will envelope data under

data/lib/gocardless_pro/services/payer_themes_service.rb

@@ -37,7 +37,13 @@ module GoCardlessPro
       #
       # @param body [Hash]
       def unenvelope_body(body)
-        body[envelope_key] || body['data']
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
       end
 
       # return the key which API responses will envelope data under

data/lib/gocardless_pro/services/payment_account_transactions_service.rb

@@ -0,0 +1,93 @@
+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 PaymentAccountTransaction endpoints
+    class PaymentAccountTransactionsService < BaseService
+      # Retrieves the details of an existing payment account transaction.
+      # Example URL: /payment_account_transactions/:identity
+      #
+      # @param identity       # The unique ID of the bank account
+      # (https://developer.gocardless.com/api-reference/#core-endpoints-creditor-bank-accounts)
+      # which happens to be the payment account.
+      # @param options [Hash] parameters as a hash, under a params key.
+      def get(identity, options = {})
+        path = sub_url('/payment_account_transactions/:identity', {
+                         'identity' => identity,
+                       })
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        return if response.body.nil?
+
+        Resources::PaymentAccountTransaction.new(unenvelope_body(response.body), response)
+      end
+
+      # List transactions for a given payment account.
+      # Example URL: /payment_accounts/:identity/transactions
+      #
+      # @param identity       # The unique ID of the bank account
+      # (https://developer.gocardless.com/api-reference/#core-endpoints-creditor-bank-accounts)
+      # which happens to be the payment account.
+      # @param options [Hash] parameters as a hash, under a params key.
+      def list(identity, options = {})
+        path = sub_url('/payment_accounts/:identity/transactions', {
+                         'identity' => identity,
+                       })
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        ListResponse.new(
+          response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::PaymentAccountTransaction
+        )
+      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 identity       # The unique ID of the bank account
+      # (https://developer.gocardless.com/api-reference/#core-endpoints-creditor-bank-accounts)
+      # which happens to be the payment account.
+      # @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(identity, options = {})
+        Paginator.new(
+          service: self,
+          options: options,
+          identity: identity
+        ).enumerator
+      end
+
+      private
+
+      # Unenvelope the response of the body using the service's `envelope_key`
+      #
+      # @param body [Hash]
+      def unenvelope_body(body)
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
+      end
+
+      # return the key which API responses will envelope data under
+      def envelope_key
+        'payment_account_transactions'
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/payment_accounts_service.rb

@@ -0,0 +1,83 @@
+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 PaymentAccount endpoints
+    class PaymentAccountsService < BaseService
+      # Retrieves the details of an existing payment account.
+      # Example URL: /payment_accounts/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "BA".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def get(identity, options = {})
+        path = sub_url('/payment_accounts/:identity', {
+                         'identity' => identity,
+                       })
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        return if response.body.nil?
+
+        Resources::PaymentAccount.new(unenvelope_body(response.body), response)
+      end
+
+      # Returns a cursor-paginated
+      # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+      # list of your payment accounts.
+      # Example URL: /payment_accounts
+      # @param options [Hash] parameters as a hash, under a params key.
+      def list(options = {})
+        path = '/payment_accounts'
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        ListResponse.new(
+          response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::PaymentAccount
+        )
+      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
+
+      private
+
+      # Unenvelope the response of the body using the service's `envelope_key`
+      #
+      # @param body [Hash]
+      def unenvelope_body(body)
+        if body.key?(envelope_key)
+          body[envelope_key]
+        elsif body.key?('data')
+          body['data']
+        else
+          body
+        end
+      end
+
+      # return the key which API responses will envelope data under
+      def envelope_key
+        'payment_accounts'
+      end
+    end
+  end
+end