gocardless_pro 4.3.0 → 4.4.1

data/lib/gocardless_pro/services/scenario_simulators_service.rb

@@ -15,135 +15,132 @@ 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. It must start in the
-      # `pending_submission` state. Only compatible with Bacs and SEPA
-      # 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_confirmed_to_failed`:
+      # 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.</li>
-      # <li>`billing_request_fulfilled_and_payment_paid_out`: Authorises the
+      # 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', {
@@ -169,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

data/lib/gocardless_pro/services/scheme_identifiers_service.rb

@@ -20,7 +20,7 @@ module GoCardlessPro
       # become active. On other schemes, including SEPA,
       # this happens instantly.
       #
-      # #### Scheme identifier name validations
+      # Scheme identifier name validations
       #
       # The `name` field of a scheme identifier can contain alphanumeric characters,
       # spaces and
@@ -29,8 +29,8 @@ module GoCardlessPro
       # Its maximum length and the special characters it supports depend on the
       # scheme:
       #
-      # | __scheme__        | __maximum length__ | __special characters allowed__
-      #                 |
+      # | scheme        | maximum length | special characters allowed
+      #     |
       # | :---------------- | :----------------- |
       # :-------------------------------------------------- |
       # | `bacs`            | 18 characters      | `/` `.` `&` `-`
@@ -49,7 +49,6 @@ module GoCardlessPro
       # 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 = {})
@@ -84,8 +83,9 @@ module GoCardlessPro
         Resources::SchemeIdentifier.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your scheme
-      # identifiers.
+      # Returns a cursor-paginated
+      # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+      # list of your scheme identifiers.
       # Example URL: /scheme_identifiers
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -138,7 +138,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/subscriptions_service.rb

@@ -45,9 +45,10 @@ module GoCardlessPro
         Resources::Subscription.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
-      # subscriptions. Please note if the subscriptions are related to customers who
-      # have been removed, they will not be shown in the response.
+      # Returns a cursor-paginated
+      # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+      # list of your subscriptions. Please note if the subscriptions are related to
+      # customers who have been removed, they will not be shown in the response.
       # Example URL: /subscriptions
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -98,26 +99,26 @@ module GoCardlessPro
       #
       # This fails with:
       #
-      # - `validation_failed` if invalid data is provided when attempting to update a
+      # -
+      # `validation_failed` if invalid data is provided when attempting to update a
       # subscription.
-      #
-      # - `subscription_not_active` if the subscription is no longer active.
-      #
-      # - `subscription_already_ended` if the subscription has taken all payments.
-      #
-      # - `mandate_payments_require_approval` if the amount is being changed and the
+      # -
+      # `subscription_not_active` if the subscription is no longer active.
+      # -
+      # `subscription_already_ended` if the subscription has taken all payments.
+      # -
+      # `mandate_payments_require_approval` if the amount is being changed and the
       # mandate requires approval.
-      #
-      # - `number_of_subscription_amendments_exceeded` error if the subscription
-      # amount has already been changed 10 times.
-      #
-      # - `forbidden` if the amount is being changed, and the subscription was created
+      # -
+      # `number_of_subscription_amendments_exceeded` error if the subscription amount
+      # has already been changed 10 times.
+      # -
+      # `forbidden` if the amount is being changed, and the subscription was created
       # by an app and you are not authenticated as that app, or if the subscription
       # was not created by an app and you are authenticated as an app
-      #
-      # - `resource_created_by_another_app` if the app fee is being changed, and the
+      # -
+      # `resource_created_by_another_app` if the app fee is being changed, and the
       # subscription was created by an app other than the app you are authenticated as
-      #
       # Example URL: /subscriptions/:identity
       #
       # @param identity       # Unique identifier, beginning with "SB".
@@ -148,8 +149,10 @@ module GoCardlessPro
       # when they continue forever (created without `count` or `end_date`) or
       # the subscription is already paused for a number of cycles.
       #
-      # When `pause_cycles` is omitted the subscription is paused until the [resume
-      # endpoint](#subscriptions-resume-a-subscription) is called.
+      # When `pause_cycles` is omitted the subscription is paused until the resume
+      # endpoint
+      # (https://developer.gocardless.com/api-reference/#subscriptions-resume-a-subscription)
+      # is called.
       # If the subscription is collecting a fixed number of payments, `end_date` will
       # be set to `null`.
       # When paused indefinitely, `upcoming_payments` will be empty.
@@ -163,22 +166,23 @@ module GoCardlessPro
       #
       # This fails with:
       #
-      # - `forbidden` if the subscription was created by an app and you are not
+      # -
+      # `forbidden` if the subscription was created by an app and you are not
       # authenticated as that app, or if the subscription was not created by an app
       # and you are authenticated as an app
-      #
-      # - `validation_failed` if invalid data is provided when attempting to pause a
+      # -
+      # `validation_failed` if invalid data is provided when attempting to pause a
       # subscription.
-      #
-      # - `subscription_paused_cannot_update_cycles` if the subscription is already
+      # -
+      # `subscription_paused_cannot_update_cycles` if the subscription is already
       # paused for a number of cycles and the request provides a value for
       # `pause_cycle`.
-      #
-      # - `subscription_cannot_be_paused` if the subscription cannot be paused.
-      #
-      # - `subscription_already_ended` if the subscription has taken all payments.
-      #
-      # - `pause_cycles_must_be_greater_than_or_equal_to` if the provided value for
+      # -
+      # `subscription_cannot_be_paused` if the subscription cannot be paused.
+      # -
+      # `subscription_already_ended` if the subscription has taken all payments.
+      # -
+      # `pause_cycles_must_be_greater_than_or_equal_to` if the provided value for
       # `pause_cycles` cannot be satisfied.
       # Example URL: /subscriptions/:identity/actions/pause
       #
@@ -226,15 +230,15 @@ module GoCardlessPro
       #
       # This fails with:
       #
-      # - `forbidden` if the subscription was created by an app and you are not
+      # -
+      # `forbidden` if the subscription was created by an app and you are not
       # authenticated as that app, or if the subscription was not created by an app
       # and you are authenticated as an app
-      #
-      # - `validation_failed` if invalid data is provided when attempting to resume a
+      # -
+      # `validation_failed` if invalid data is provided when attempting to resume a
       # subscription.
-      #
-      # - `subscription_not_paused` if the subscription is not paused.
-      #
+      # -
+      # `subscription_not_paused` if the subscription is not paused.
       # Example URL: /subscriptions/:identity/actions/resume
       #
       # @param identity       # Unique identifier, beginning with "SB".
@@ -323,7 +327,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/tax_rates_service.rb

@@ -10,8 +10,9 @@ module GoCardlessPro
   module Services
     # Service for making requests to the TaxRate endpoints
     class TaxRatesService < BaseService
-      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of all tax
-      # rates.
+      # Returns a cursor-paginated
+      # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+      # list of all tax rates.
       # Example URL: /tax_rates
       # @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/transferred_mandates_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/verification_details_service.rb

@@ -63,7 +63,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/webhooks_service.rb

@@ -10,8 +10,9 @@ module GoCardlessPro
   module Services
     # Service for making requests to the Webhook endpoints
     class WebhooksService < BaseService
-      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
-      # webhooks.
+      # Returns a cursor-paginated
+      # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
+      # list of your webhooks.
       # Example URL: /webhooks
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -103,7 +104,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/version.rb

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

data/lib/gocardless_pro/webhook.rb

@@ -1,6 +1,18 @@
 require 'openssl'
 
 module GoCardlessPro
+  # Represents the result of parsing a webhook, containing both the events
+  # and the webhook metadata.
+  class WebhookParseResult
+    attr_reader :events
+    attr_reader :webhook_id
+
+    def initialize(events, webhook_id)
+      @events = events
+      @webhook_id = webhook_id
+    end
+  end
+
   class Webhook
     class InvalidSignatureError < StandardError; end
 
@@ -38,6 +50,39 @@ module GoCardlessPro
         events.map { |event| Resources::Event.new(event) }
       end
 
+      # Validates that a webhook was genuinely sent by GoCardless using
+      # `.signature_valid?`, and then parses it into a WebhookParseResult containing
+      # both the events and the webhook ID from the meta field
+      #
+      # @option options [String] :request_body the request body
+      # @option options [String] :signature_header the signature included in the request,
+      #   found in the `Webhook-Signature` header
+      # @option options [String] :webhook_endpoint_secret the webhook endpoint secret for
+      #   your webhook endpoint, as configured in your GoCardless Dashboard
+      # @return [WebhookParseResult] containing the events and webhook ID
+      # @raise [InvalidSignatureError] if the signature header specified does not match
+      #   the signature computed using the request body and webhook endpoint secret
+      # @raise [ArgumentError] if a required keyword argument is not provided or is not
+      #   of the required type
+      def parse_with_meta(options = {})
+        validate_options!(options)
+
+        unless signature_valid?(request_body: options[:request_body],
+                                signature_header: options[:signature_header],
+                                webhook_endpoint_secret: options[:webhook_endpoint_secret])
+          raise InvalidSignatureError, "This webhook doesn't appear to be a genuine " \
+                                        'webhook from GoCardless, because the signature ' \
+                                        "header doesn't match the signature computed" \
+                                        ' with your webhook endpoint secret.'
+        end
+
+        parsed = JSON.parse(options[:request_body])
+        events = parsed['events'].map { |event| Resources::Event.new(event) }
+        webhook_id = parsed.dig('meta', 'webhook_id')
+
+        WebhookParseResult.new(events, webhook_id)
+      end
+
       # Validates that a webhook was genuinely sent by GoCardless by computing its
       # signature using the body and your webhook endpoint secret, and comparing that with
       # the signature included in the `Webhook-Signature` header

data/lib/gocardless_pro.rb

@@ -123,6 +123,12 @@ require_relative 'gocardless_pro/services/negative_balance_limits_service'
 require_relative 'gocardless_pro/resources/outbound_payment'
 require_relative 'gocardless_pro/services/outbound_payments_service'
 
+require_relative 'gocardless_pro/resources/outbound_payment_import'
+require_relative 'gocardless_pro/services/outbound_payment_imports_service'
+
+require_relative 'gocardless_pro/resources/outbound_payment_import_entry'
+require_relative 'gocardless_pro/services/outbound_payment_import_entries_service'
+
 require_relative 'gocardless_pro/resources/payer_authorisation'
 require_relative 'gocardless_pro/services/payer_authorisations_service'