gocardless_pro 4.3.0 → 4.4.1

data/lib/gocardless_pro/services/mandates_service.rb

@@ -45,8 +45,9 @@ module GoCardlessPro
         Resources::Mandate.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
-      # mandates.
+      # Returns a cursor-paginated
+      # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+      # list of your mandates.
       # Example URL: /mandates
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -163,12 +164,12 @@ module GoCardlessPro
         Resources::Mandate.new(unenvelope_body(response.body), response)
       end
 
-      # <a name="mandate_not_inactive"></a>Reinstates a cancelled or expired mandate
-      # to the banks. You will receive a `resubmission_requested` webhook, but after
-      # that reinstating the mandate follows the same process as its initial creation,
-      # so you will receive a `submitted` webhook, followed by a `reinstated` or
-      # `failed` webhook up to two working days later. Any metadata supplied to this
-      # endpoint will be stored on the `resubmission_requested` event it causes.
+      # Reinstates a cancelled or expired mandate to the banks. You will receive a
+      # `resubmission_requested` webhook, but after that reinstating the mandate
+      # follows the same process as its initial creation, so you will receive a
+      # `submitted` webhook, followed by a `reinstated` or `failed` webhook up to two
+      # working days later. Any metadata supplied to this endpoint will be stored on
+      # the `resubmission_requested` event it causes.
       #
       # This will fail with a `mandate_not_inactive` error if the mandate is already
       # being submitted, or is active.
@@ -219,7 +220,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/negative_balance_limits_service.rb

@@ -10,8 +10,9 @@ 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.
+      # Returns a cursor-paginated
+      # (https://developer.gocardless.com/api-reference/#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 = {})
@@ -45,7 +46,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/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

@@ -124,7 +124,7 @@ 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.
@@ -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 = {})
@@ -255,7 +256,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_authorisations_service.rb

@@ -75,10 +75,9 @@ 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".
@@ -147,13 +146,11 @@ 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".
@@ -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

@@ -10,12 +10,33 @@ 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](#core-endpoints-creditor-bank-accounts) which happens to be the
-      # payment account.
+      # @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', {
@@ -35,9 +56,9 @@ module GoCardlessPro
 
       # 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](#core-endpoints-creditor-bank-accounts) which happens to be the
-      # payment account.
+      # @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 = {})
@@ -54,7 +75,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_accounts_service.rb

@@ -29,8 +29,9 @@ module GoCardlessPro
         Resources::PaymentAccount.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
-      # payment accounts.
+      # 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 = {})
@@ -64,7 +65,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/payments_service.rb

@@ -10,12 +10,13 @@ module GoCardlessPro
   module Services
     # Service for making requests to the Payment endpoints
     class PaymentsService < BaseService
-      # <a name="mandate_is_inactive"></a>Creates a new payment object.
+      # Creates a new payment object.
       #
-      # This fails with a `mandate_is_inactive` error if the linked
-      # [mandate](#core-endpoints-mandates) is cancelled or has failed. Payments can
-      # be created against mandates with status of: `pending_customer_approval`,
-      # `pending_submission`, `submitted`, and `active`.
+      # This fails with a `mandate_is_inactive` error if the linked mandate
+      # (https://developer.gocardless.com/api-reference/#core-endpoints-mandates) is
+      # cancelled or has failed. Payments can be created against mandates with status
+      # of: `pending_customer_approval`, `pending_submission`, `submitted`, and
+      # `active`.
       # Example URL: /payments
       # @param options [Hash] parameters as a hash, under a params key.
       def create(options = {})
@@ -50,8 +51,9 @@ module GoCardlessPro
         Resources::Payment.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
-      # payments.
+      # Returns a cursor-paginated
+      # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+      # list of your payments.
       # Example URL: /payments
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -165,12 +167,12 @@ module GoCardlessPro
         Resources::Payment.new(unenvelope_body(response.body), response)
       end
 
-      # <a name="retry_failed"></a>Retries a failed payment if the underlying mandate
-      # is active. You will receive a `resubmission_requested` webhook, but after that
-      # retrying the payment follows the same process as its initial creation, so you
-      # will receive a `submitted` webhook, followed by a `confirmed` or `failed`
-      # event. Any metadata supplied to this endpoint will be stored against the
-      # payment submission event it causes.
+      # Retries a failed payment if the underlying mandate is active. You will receive
+      # a `resubmission_requested` webhook, but after that retrying the payment
+      # follows the same process as its initial creation, so you will receive a
+      # `submitted` webhook, followed by a `confirmed` or `failed` event. Any metadata
+      # supplied to this endpoint will be stored against the payment submission event
+      # it causes.
       #
       # This will return a `retry_failed` error if the payment has not failed.
       #
@@ -219,7 +221,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/payout_items_service.rb

@@ -10,13 +10,12 @@ module GoCardlessPro
   module Services
     # Service for making requests to the PayoutItem endpoints
     class PayoutItemsService < BaseService
-      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of items in
-      # the payout.
-      #
-      # <strong>This endpoint only serves requests for payouts created in the last 6
-      # months. Requests for older payouts will return an HTTP status <code>410
-      # Gone</code>.</strong>
+      # Returns a cursor-paginated
+      # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+      # list of items in the payout.
       #
+      # This endpoint only serves requests for payouts created in the last 6 months.
+      # Requests for older payouts will return an HTTP status 410 Gone.
       # Example URL: /payout_items
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -50,7 +49,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/payouts_service.rb

@@ -10,8 +10,9 @@ module GoCardlessPro
   module Services
     # Service for making requests to the Payout endpoints
     class PayoutsService < BaseService
-      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
-      # payouts.
+      # Returns a cursor-paginated
+      # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+      # list of your payouts.
       # Example URL: /payouts
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -40,8 +41,8 @@ module GoCardlessPro
       end
 
       # Retrieves the details of a single payout. For an example of how to reconcile
-      # the transactions in a payout, see [this
-      # guide](#events-reconciling-payouts-with-events).
+      # the transactions in a payout, see this guide
+      # (https://developer.gocardless.com/api-reference/#events-reconciling-payouts-with-events).
       # Example URL: /payouts/:identity
       #
       # @param identity       # Unique identifier, beginning with "PO".
@@ -89,7 +90,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/redirect_flows_service.rb

@@ -65,10 +65,14 @@ module GoCardlessPro
         Resources::RedirectFlow.new(unenvelope_body(response.body), response)
       end
 
-      # This creates a [customer](#core-endpoints-customers), [customer bank
-      # account](#core-endpoints-customer-bank-accounts), and
-      # [mandate](#core-endpoints-mandates) using the details supplied by your
-      # customer and returns the ID of the created mandate.
+      # This creates a customer
+      # (https://developer.gocardless.com/api-reference/#core-endpoints-customers),
+      # customer bank account
+      # (https://developer.gocardless.com/api-reference/#core-endpoints-customer-bank-accounts),
+      # and mandate
+      # (https://developer.gocardless.com/api-reference/#core-endpoints-mandates)
+      # using the details supplied by your customer and returns the ID of the created
+      # mandate.
       #
       # This will return a `redirect_flow_incomplete` error if your customer has not
       # yet been redirected back to your site, and a `redirect_flow_already_completed`
@@ -119,7 +123,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/refunds_service.rb

@@ -12,18 +12,16 @@ module GoCardlessPro
     class RefundsService < BaseService
       # Creates a new refund object.
       #
-      # This fails with:<a name="total_amount_confirmation_invalid"></a><a
-      # name="number_of_refunds_exceeded"></a><a
-      # name="available_refund_amount_insufficient"></a>
+      # This fails with:
       #
-      # - `total_amount_confirmation_invalid` if the confirmation amount doesn't match
+      # -
+      # `total_amount_confirmation_invalid` if the confirmation amount doesn't match
       # the total amount refunded for the payment. This safeguard is there to prevent
       # two processes from creating refunds without awareness of each other.
-      #
-      # - `available_refund_amount_insufficient` if the creditor does not have
+      # -
+      # `available_refund_amount_insufficient` if the creditor does not have
       # sufficient balance for refunds available to cover the cost of the requested
       # refund.
-      #
       # Example URL: /refunds
       # @param options [Hash] parameters as a hash, under a params key.
       def create(options = {})
@@ -58,8 +56,9 @@ module GoCardlessPro
         Resources::Refund.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
-      # refunds.
+      # Returns a cursor-paginated
+      # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+      # list of your refunds.
       # Example URL: /refunds
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -135,7 +134,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