gocardless_pro 4.2.0 → 4.4.1

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 = {})
@@ -36,7 +37,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
@@ -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 = {})
@@ -86,7 +88,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/payments/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         options[:retry_failures] = true
@@ -105,7 +107,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def update(identity, options = {})
         path = sub_url('/payments/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -133,7 +135,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def cancel(identity, options = {})
         path = sub_url('/payments/:identity/actions/cancel', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -151,7 +153,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
@@ -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.
       #
@@ -181,7 +183,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def retry(identity, options = {})
         path = sub_url('/payments/:identity/actions/retry', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -199,7 +201,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
@@ -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,15 +41,15 @@ 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".
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/payouts/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         options[:retry_failures] = true
@@ -67,7 +68,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def update(identity, options = {})
         path = sub_url('/payouts/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -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

@@ -32,7 +32,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
@@ -53,7 +53,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/redirect_flows/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         options[:retry_failures] = true
@@ -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`
@@ -81,7 +85,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def complete(identity, options = {})
         path = sub_url('/redirect_flows/:identity/actions/complete', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -99,7 +103,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
@@ -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 = {})
@@ -44,7 +42,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
@@ -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 = {})
@@ -94,7 +93,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/refunds/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         options[:retry_failures] = true
@@ -113,7 +112,7 @@ module GoCardlessPro
       # @param options [Hash] parameters as a hash, under a params key.
       def update(identity, options = {})
         path = sub_url('/refunds/:identity', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -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

data/lib/gocardless_pro/services/scenario_simulators_service.rb

@@ -15,133 +15,136 @@ module GoCardlessPro
       #
       # @param identity       # The unique identifier of the simulator, used to initiate simulations.
       # One of:
-      # <ul>
-      # <li>`creditor_verification_status_action_required`: Sets a creditor's
+      #
+      # - `creditor_verification_status_action_required`: Sets a creditor's
       # `verification status` to `action required`, meaning that the creditor
       # must provide further information to GoCardless in order to verify their
-      # account to receive payouts.</li>
-      # <li>`creditor_verification_status_in_review`: Sets a creditor's
+      # account to receive payouts.
+      # - `creditor_verification_status_in_review`: Sets a creditor's
       # `verification status` to `in review`, meaning that the creditor has
       # provided all of the information requested by GoCardless to verify their
-      # account, and is now awaiting review.</li>
-      # <li>`creditor_verification_status_successful`: Sets a creditor's
+      # account, and is now awaiting review.
+      # - `creditor_verification_status_successful`: Sets a creditor's
       # `verification status` to `successful`, meaning that the creditor is
-      # fully verified and can receive payouts.</li>
-      # <li>`payment_confirmed`: Transitions a payment through to `confirmed`.
-      # It must start in the `pending_submission` state, and its mandate must be
-      # in the `activated` state (unless it is a payment for ACH, BECS, BECS_NZ
-      # or SEPA, in which cases the mandate may be `pending_submission`, since
-      # their mandates are submitted with their first payment).</li>
-      # <li>`payment_paid_out`: Transitions a payment through to `paid_out`,
+      # fully verified and can receive payouts.
+      # - `payment_confirmed`: Transitions a payment through to `confirmed`. It
+      # must start in the `pending_submission` state, and its mandate must be in
+      # the `activated` state (unless it is a payment for ACH, BECS, BECS_NZ or
+      # SEPA, in which cases the mandate may be `pending_submission`, since
+      # their mandates are submitted with their first payment).
+      # - `payment_paid_out`: Transitions a payment through to `paid_out`,
       # having been collected successfully and paid out to you. It must start in
       # the `pending_submission` state, and its mandate must be in the
       # `activated` state (unless it is a payment for ACH, BECS, BECS_NZ or
       # SEPA, in which cases the mandate may be `pending_submission`, since
-      # their mandates are submitted with their first payment).</li>
-      # <li>`payment_failed`: Transitions a payment through to `failed`. It must
+      # their mandates are submitted with their first payment).
+      # - `payment_failed`: Transitions a payment through to `failed`. It must
       # start in the `pending_submission` state, and its mandate must be in the
       # `activated` state (unless it is a payment for ACH, BECS, BECS_NZ or
       # SEPA, in which cases the mandate may be `pending_submission`, since
-      # their mandates are submitted with their first payment).</li>
-      # <li>`payment_charged_back`: Behaves the same as the `payout_paid_out`
+      # their mandates are submitted with their first payment).
+      # - `payment_charged_back`: Behaves the same as the `payout_paid_out`
       # simulator, except that the payment is transitioned to `charged_back`
-      # after it is paid out, having been charged back by the customer.</li>
-      # <li>`payment_chargeback_settled`: Behaves the same as the
+      # after it is paid out, having been charged back by the customer.
+      # - `payment_chargeback_settled`: Behaves the same as the
       # `payment_charged_back` simulator, except that the charged back payment
       # is additionally included as a debit item in a payout, thereby settling
-      # the charged back payment.</li>
-      # <li>`payment_late_failure`: Transitions a payment through to
+      # the charged back payment.
+      # - `payment_late_failure`: Transitions a payment through to
       # `late_failure`, having been apparently collected successfully
       # beforehand. It must start in either the `pending_submission` or
       # `paid_out` state, and its mandate must be in the `activated` state
       # (unless it is a payment for ACH, BECS, BECS_NZ or SEPA, in which cases
       # the mandate may be `pending_submission`, since their mandates are
       # submitted with their first payment). Not compatible with Autogiro
-      # mandates.</li>
-      # <li>`payment_late_failure_settled`: Behaves the same as the
+      # mandates.
+      # - `payment_late_failure_settled`: Behaves the same as the
       # `payment_late_failure` simulator, except that the late failure is
       # additionally included as a debit item in a payout, thereby settling the
-      # late failure.</li>
-      # <li>`payment_submitted`: Transitions a payment to `submitted`, without
-      # proceeding any further. It must start in the `pending_submission`
-      # state.</li>
-      # <li>`mandate_activated`: Transitions a mandate through to `activated`,
+      # late failure.
+      # - `payment_submitted`: Transitions a payment to `submitted`, without
+      # proceeding any further. It must start in the `pending_submission` state.
+      # - `mandate_activated`: Transitions a mandate through to `activated`,
       # having been submitted to the banks and set up successfully. It must
       # start in the `pending_submission` state. Not compatible with ACH, BECS,
       # BECS_NZ and SEPA mandates, which are submitted and activated with their
-      # first payment.</li>
-      # <li>`mandate_customer_approval_granted`: Transitions a mandate through
-      # to `pending_submission`, as if the customer approved the mandate
-      # creation. It must start in the `pending_customer_approval` state.
-      # Compatible only with Bacs and SEPA mandates, which support customer
-      # signatures on the mandate. All payments associated with the mandate will
-      # be transitioned to `pending_submission`. All subscriptions associated
-      # with the mandate will become `active`.</li>
-      # <li>`mandate_customer_approval_skipped`: Transitions a mandate through
-      # to `pending_submission`, as if the customer skipped the mandate approval
+      # first payment.
+      # - `mandate_customer_approval_granted`: Transitions a mandate through to
+      # `pending_submission`, as if the customer approved the mandate creation.
+      # It must start in the `pending_customer_approval` state. Compatible only
+      # with Bacs and SEPA mandates, which support customer signatures on the
+      # mandate. All payments associated with the mandate will be transitioned
+      # to `pending_submission`. All subscriptions associated with the mandate
+      # will become `active`.
+      # - `mandate_customer_approval_skipped`: Transitions a mandate through to
+      # `pending_submission`, as if the customer skipped the mandate approval
       # during the mandate creation process. It must start in the
       # `pending_customer_approval` state. Compatible only with Bacs and SEPA
       # mandates, which support customer signatures on the mandate. All payments
       # associated with the mandate will be transitioned to
       # `pending_submission`. All subscriptions associated with the mandate will
-      # become `active`.</li>
-      # <li>`mandate_failed`: Transitions a mandate through to `failed`, having
+      # become `active`.
+      # - `mandate_failed`: Transitions a mandate through to `failed`, having
       # been submitted to the banks but found to be invalid (for example due to
       # invalid bank details). It must start in the `pending_submission` or
       # `submitted` states. Not compatible with SEPA mandates, which are
-      # submitted with their first payment.</li>
-      # <li>`mandate_expired`: Transitions a mandate through to `expired`,
-      # having been submitted to the banks, set up successfully and then expired
+      # submitted with their first payment.
+      # - `mandate_expired`: Transitions a mandate through to `expired`, having
+      # been submitted to the banks, set up successfully and then expired
       # because no collection attempts were made against it for longer than the
       # scheme's dormancy period (13 months for Bacs, 3 years for SEPA, 15
       # months for ACH, Betalingsservice, and BECS). It must start in the
       # `pending_submission` state. Not compatible with Autogiro, BECS NZ, and
-      # PAD mandates, which do not expire.</li>
-      # <li>`mandate_transferred`: Transitions a mandate through to
-      # `transferred`, having been submitted to the banks, set up successfully
-      # and then moved to a new bank account due to the customer using the UK's
-      # Current Account Switching Service (CASS). It must start in the
-      # `pending_submission` state. Only compatible with Bacs mandates.</li>
-      # <li>`mandate_transferred_with_resubmission`: Transitions a mandate
-      # through `transferred` and resubmits it to the banks, can be caused be
-      # the UK's Current Account Switching Service (CASS) or when a customer
-      # contacts GoCardless to change their bank details. It must start in the
-      # `pending_submission` state. Only compatible with Bacs mandates.</li>
-      # <li>`mandate_suspended_by_payer`: Transitions a mandate to
+      # PAD mandates, which do not expire.
+      # - `mandate_transferred`: Transitions a mandate through to `transferred`,
+      # having been submitted to the banks, set up successfully and then moved
+      # to a new bank account due. It must start in the `pending_submission`
+      # state. Only compatible with Bacs and SEPA mandates.
+      # - `mandate_transferred_with_resubmission`: Transitions a mandate through
+      # `transferred` and resubmits it to the banks, can be caused be the UK's
+      # Current Account Switching Service (CASS) or when a customer contacts
+      # GoCardless to change their bank details. It must start in the
+      # `pending_submission` state. Only compatible with Bacs mandates.
+      # - `mandate_suspended_by_payer`: Transitions a mandate to
       # `suspended_by_payer`, as if payer has suspended the mandate after it has
       # been setup successfully. It must start in the `activated` state. Only
-      # compatible with PAY_TO mandates.</li>
-      # <li>`refund_paid`: Transitions a refund to `paid`. It must start in
-      # either the `pending_submission` or `submitted` state.</li>
-      # <li>`refund_settled`: Transitions a refund to `paid`, if it's not
-      # already, then generates a payout that includes the refund, thereby
-      # settling the funds. It must start in one of `pending_submission`,
-      # `submitted` or `paid` states.</li>
-      # <li>`refund_bounced`: Transitions a refund to `bounced`. It must start
-      # in either the `pending_submission`, `submitted`, or `paid` state.</li>
-      # <li>`refund_returned`: Transitions a refund to `refund_returned`. The
-      # refund must start in `pending_submission`.</li>
-      # <li>`payout_bounced`: Transitions a payout to `bounced`. It must start
-      # in the `paid` state.</li>
-      # <li>`billing_request_fulfilled`: Authorises the billing request, and
-      # then fulfils it. The billing request must be in the `pending` state,
-      # with all actions completed except for `bank_authorisation`. Only billing
-      # requests with a `payment_request` are supported.</li>
-      # <li>`billing_request_fulfilled_and_payment_failed`: Authorises the
-      # billing request, fulfils it, and moves the associated payment to
-      # `failed`. The billing request must be in the `pending` state, with all
+      # compatible with PAY_TO mandates.
+      # - `refund_paid`: Transitions a refund to `paid`. It must start in either
+      # the `pending_submission` or `submitted` state.
+      # - `refund_settled`: Transitions a refund to `paid`, if it's not already,
+      # then generates a payout that includes the refund, thereby settling the
+      # funds. It must start in one of `pending_submission`, `submitted` or
+      # `paid` states.
+      # - `refund_bounced`: Transitions a refund to `bounced`. It must start in
+      # either the `pending_submission`, `submitted`, or `paid` state.
+      # - `refund_returned`: Transitions a refund to `refund_returned`. The
+      # refund must start in `pending_submission`.
+      # - `payout_bounced`: Transitions a payout to `bounced`. It must start in
+      # the `paid` state.
+      # - `billing_request_fulfilled`: Authorises the billing request, and then
+      # fulfils it. The billing request must be in the `pending` state, with all
       # actions completed except for `bank_authorisation`. Only billing requests
-      # with a `payment_request` are supported.</li>
-      # <li>`billing_request_fulfilled_and_payment_paid_out`: Authorises the
+      # with a `payment_request` are supported.
+      # - `billing_request_fulfilled_and_payment_failed`: Authorises the billing
+      # request, fulfils it, and moves the associated payment to `failed`. The
+      # billing request must be in the `pending` state, with all actions
+      # completed except for `bank_authorisation`. Only billing requests with a
+      # `payment_request` are supported.
+      # - `billing_request_fulfilled_and_payment_confirmed_to_failed`:
+      # Authorises the billing request, fulfils it, moves the associated payment
+      # to `confirmed` and then moves it to `failed`. The billing request must
+      # be in the `pending` state, with all actions completed except for
+      # `bank_authorisation`. Only billing requests with a `payment_request` are
+      # supported.
+      # - `billing_request_fulfilled_and_payment_paid_out`: Authorises the
       # billing request, fulfils it, and moves the associated payment to
       # `paid_out`. The billing request must be in the `pending` state, with all
       # actions completed except for `bank_authorisation`. Only billing requests
-      # with a `payment_request` are supported.</li>
-      # </ul>
+      # with a `payment_request` are supported.
       # @param options [Hash] parameters as a hash, under a params key.
       def run(identity, options = {})
         path = sub_url('/scenario_simulators/:identity/actions/run', {
-                         'identity' => identity
+                         'identity' => identity,
                        })
 
         params = options.delete(:params) || {}
@@ -163,7 +166,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