gocardless-pro 0.1.0

data/lib/gocardless-pro/services/payment_service.rb

@@ -0,0 +1,164 @@
+require_relative './base_service'
+
+# encoding: utf-8
+#
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+
+module GoCardless
+  module Services
+    # Service for making requests to the Payment endpoints
+    class PaymentService < BaseService
+      # <a name="mandate_is_inactive"></a>Creates a new payment object.
+      #
+      # This
+      # fails with a `mandate_is_inactive` error if the linked
+      # [mandate](https://developer.gocardless.com/pro/#api-endpoints-mandates) is
+      # cancelled. Payments can be created against `pending_submission` mandates, but
+      # they will not be submitted until the mandate becomes active.
+      # Example URL: /payments
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def create(options = {}, custom_headers = {})
+        path = '/payments'
+        new_options = {}
+        new_options[envelope_key] = options
+        options = new_options
+        response = make_request(:post, path, options, custom_headers)
+
+        Resources::Payment.new(unenvelope_body(response.body))
+      end
+
+      # Returns a
+      # [cursor-paginated](https://developer.gocardless.com/pro/#overview-cursor-pagination)
+      # list of your payments.
+      # Example URL: /payments
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def list(options = {}, custom_headers = {})
+        path = '/payments'
+
+        response = make_request(:get, path, options, custom_headers)
+        ListResponse.new(
+          raw_response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::Payment
+        )
+      end
+
+      # Get a lazily enumerated list of all the items returned. This is simmilar 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,
+          path: '/payments',
+          options: options
+        ).enumerator
+      end
+
+      # Retrieves the details of a single existing payment.
+      # Example URL: /payments/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "PM"
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def get(identity, options = {}, custom_headers = {})
+        path = sub_url('/payments/:identity',           'identity' => identity)
+
+        response = make_request(:get, path, options, custom_headers)
+
+        Resources::Payment.new(unenvelope_body(response.body))
+      end
+
+      # Updates a payment object. This accepts only the metadata parameter.
+      # Example URL: /payments/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "PM"
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def update(identity, options = {}, custom_headers = {})
+        path = sub_url('/payments/:identity',           'identity' => identity)
+
+        new_options = {}
+        new_options[envelope_key] = options
+        options = new_options
+        response = make_request(:put, path, options, custom_headers)
+
+        Resources::Payment.new(unenvelope_body(response.body))
+      end
+
+      # Cancels the payment if it has not already been submitted to the banks. Any
+      # metadata supplied to this endpoint will be stored on the payment cancellation
+      # event it causes.
+      #
+      # This will fail with a `cancellation_failed` error unless
+      # the payment's status is `pending_submission`.
+      # Example URL: /payments/:identity/actions/cancel
+      #
+      # @param identity       # Unique identifier, beginning with "PM"
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def cancel(identity, options = {}, custom_headers = {})
+        path = sub_url('/payments/:identity/actions/cancel',           'identity' => identity)
+
+        new_options = {}
+        new_options['data'] = options
+        options = new_options
+        response = make_request(:post, path, options, custom_headers)
+
+        Resources::Payment.new(unenvelope_body(response.body))
+      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.
+      #
+      # This will return a `retry_failed`
+      # error if the payment has not failed.
+      # Example URL: /payments/:identity/actions/retry
+      #
+      # @param identity       # Unique identifier, beginning with "PM"
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def retry(identity, options = {}, custom_headers = {})
+        path = sub_url('/payments/:identity/actions/retry',           'identity' => identity)
+
+        new_options = {}
+        new_options['data'] = options
+        options = new_options
+        response = make_request(:post, path, options, custom_headers)
+
+        Resources::Payment.new(unenvelope_body(response.body))
+      end
+
+      # Unenvelope the response of the body using the service's `envelope_key`
+      #
+      # @param body [Hash]
+      def unenvelope_body(body)
+        body[envelope_key] || body['data']
+      end
+
+      private
+
+      # return the key which API responses will envelope data under
+      def envelope_key
+        'payments'
+      end
+
+      # take a URL with placeholder params and substitute them out for the acutal value
+      # @param url [String] the URL with placeholders in
+      # @param param_map [Hash] a hash of placeholders and their actual values
+      def sub_url(url, param_map)
+        param_map.reduce(url) do |new_url, (param, value)|
+          new_url.gsub(":#{param}", value)
+        end
+      end
+    end
+  end
+end

data/lib/gocardless-pro/services/payout_service.rb

@@ -0,0 +1,80 @@
+require_relative './base_service'
+
+# encoding: utf-8
+#
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+
+module GoCardless
+  module Services
+    # Service for making requests to the Payout endpoints
+    class PayoutService < BaseService
+      # Returns a
+      # [cursor-paginated](https://developer.gocardless.com/pro/#overview-cursor-pagination)
+      # list of your payouts.
+      # Example URL: /payouts
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def list(options = {}, custom_headers = {})
+        path = '/payouts'
+
+        response = make_request(:get, path, options, custom_headers)
+        ListResponse.new(
+          raw_response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::Payout
+        )
+      end
+
+      # Get a lazily enumerated list of all the items returned. This is simmilar 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,
+          path: '/payouts',
+          options: options
+        ).enumerator
+      end
+
+      # Retrieves the details of a single payout.
+      # Example URL: /payouts/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "PO"
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def get(identity, options = {}, custom_headers = {})
+        path = sub_url('/payouts/:identity',           'identity' => identity)
+
+        response = make_request(:get, path, options, custom_headers)
+
+        Resources::Payout.new(unenvelope_body(response.body))
+      end
+
+      # Unenvelope the response of the body using the service's `envelope_key`
+      #
+      # @param body [Hash]
+      def unenvelope_body(body)
+        body[envelope_key] || body['data']
+      end
+
+      private
+
+      # return the key which API responses will envelope data under
+      def envelope_key
+        'payouts'
+      end
+
+      # take a URL with placeholder params and substitute them out for the acutal value
+      # @param url [String] the URL with placeholders in
+      # @param param_map [Hash] a hash of placeholders and their actual values
+      def sub_url(url, param_map)
+        param_map.reduce(url) do |new_url, (param, value)|
+          new_url.gsub(":#{param}", value)
+        end
+      end
+    end
+  end
+end

data/lib/gocardless-pro/services/publishable_api_key_service.rb

@@ -0,0 +1,130 @@
+require_relative './base_service'
+
+# encoding: utf-8
+#
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+
+module GoCardless
+  module Services
+    # Service for making requests to the PublishableApiKey endpoints
+    class PublishableApiKeyService < BaseService
+      # Creates a publishable API key object.
+      # Example URL: /publishable_api_keys
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def create(options = {}, custom_headers = {})
+        path = '/publishable_api_keys'
+        new_options = {}
+        new_options[envelope_key] = options
+        options = new_options
+        response = make_request(:post, path, options, custom_headers)
+
+        Resources::PublishableApiKey.new(unenvelope_body(response.body))
+      end
+
+      # Returns a
+      # [cursor-paginated](https://developer.gocardless.com/pro/#overview-cursor-pagination)
+      # list of your publishable API keys
+      # Example URL: /publishable_api_keys
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def list(options = {}, custom_headers = {})
+        path = '/publishable_api_keys'
+
+        response = make_request(:get, path, options, custom_headers)
+        ListResponse.new(
+          raw_response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::PublishableApiKey
+        )
+      end
+
+      # Get a lazily enumerated list of all the items returned. This is simmilar 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,
+          path: '/publishable_api_keys',
+          options: options
+        ).enumerator
+      end
+
+      # Returns all details about a single publishable API key
+      # Example URL: /publishable_api_keys/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "PK"
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def get(identity, options = {}, custom_headers = {})
+        path = sub_url('/publishable_api_keys/:identity',           'identity' => identity)
+
+        response = make_request(:get, path, options, custom_headers)
+
+        Resources::PublishableApiKey.new(unenvelope_body(response.body))
+      end
+
+      # Updates a publishable API key. Only the `name` fields are supported. Any other
+      # fields passed will be ignored.
+      # Example URL: /publishable_api_keys/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "PK"
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def update(identity, options = {}, custom_headers = {})
+        path = sub_url('/publishable_api_keys/:identity',           'identity' => identity)
+
+        new_options = {}
+        new_options[envelope_key] = options
+        options = new_options
+        response = make_request(:put, path, options, custom_headers)
+
+        Resources::PublishableApiKey.new(unenvelope_body(response.body))
+      end
+
+      # Disables a publishable API key. Once disabled, the publishable API key will
+      # not be usable to authenticate any requests.
+      # Example URL: /publishable_api_keys/:identity/actions/disable
+      #
+      # @param identity       # Unique identifier, beginning with "PK"
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def disable(identity, options = {}, custom_headers = {})
+        path = sub_url('/publishable_api_keys/:identity/actions/disable',           'identity' => identity)
+
+        new_options = {}
+        new_options['data'] = options
+        options = new_options
+        response = make_request(:post, path, options, custom_headers)
+
+        Resources::PublishableApiKey.new(unenvelope_body(response.body))
+      end
+
+      # Unenvelope the response of the body using the service's `envelope_key`
+      #
+      # @param body [Hash]
+      def unenvelope_body(body)
+        body[envelope_key] || body['data']
+      end
+
+      private
+
+      # return the key which API responses will envelope data under
+      def envelope_key
+        'publishable_api_keys'
+      end
+
+      # take a URL with placeholder params and substitute them out for the acutal value
+      # @param url [String] the URL with placeholders in
+      # @param param_map [Hash] a hash of placeholders and their actual values
+      def sub_url(url, param_map)
+        param_map.reduce(url) do |new_url, (param, value)|
+          new_url.gsub(":#{param}", value)
+        end
+      end
+    end
+  end
+end

data/lib/gocardless-pro/services/redirect_flow_service.rb

@@ -0,0 +1,96 @@
+require_relative './base_service'
+
+# encoding: utf-8
+#
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+
+module GoCardless
+  module Services
+    # Service for making requests to the RedirectFlow endpoints
+    class RedirectFlowService < BaseService
+      # Creates a redirect flow object which can then be used to redirect your
+      # customer to the GoCardless Pro hosted payment pages.
+      # Example URL: /redirect_flows
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def create(options = {}, custom_headers = {})
+        path = '/redirect_flows'
+        new_options = {}
+        new_options[envelope_key] = options
+        options = new_options
+        response = make_request(:post, path, options, custom_headers)
+
+        Resources::RedirectFlow.new(unenvelope_body(response.body))
+      end
+
+      # Returns all details about a single redirect flow
+      # Example URL: /redirect_flows/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "RE"
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def get(identity, options = {}, custom_headers = {})
+        path = sub_url('/redirect_flows/:identity',           'identity' => identity)
+
+        response = make_request(:get, path, options, custom_headers)
+
+        Resources::RedirectFlow.new(unenvelope_body(response.body))
+      end
+
+      # This creates a
+      # [customer](https://developer.gocardless.com/pro/#api-endpoints-customers),
+      # [customer bank
+      # account](https://developer.gocardless.com/pro/#api-endpoints-customer-bank-account),
+      # and [mandate](https://developer.gocardless.com/pro/#api-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` error if your integration has already
+      # completed this flow. It will return a `bad_request` error if the
+      # `session_token` differs to the one supplied when the redirect flow was
+      # created.
+      # Example URL: /redirect_flows/:identity/actions/complete
+      #
+      # @param identity       # Unique identifier, beginning with "RE"
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def complete(identity, options = {}, custom_headers = {})
+        path = sub_url('/redirect_flows/:identity/actions/complete',           'identity' => identity)
+
+        new_options = {}
+        new_options['data'] = options
+        options = new_options
+        response = make_request(:post, path, options, custom_headers)
+
+        Resources::RedirectFlow.new(unenvelope_body(response.body))
+      end
+
+      # Unenvelope the response of the body using the service's `envelope_key`
+      #
+      # @param body [Hash]
+      def unenvelope_body(body)
+        body[envelope_key] || body['data']
+      end
+
+      private
+
+      # return the key which API responses will envelope data under
+      def envelope_key
+        'redirect_flows'
+      end
+
+      # take a URL with placeholder params and substitute them out for the acutal value
+      # @param url [String] the URL with placeholders in
+      # @param param_map [Hash] a hash of placeholders and their actual values
+      def sub_url(url, param_map)
+        param_map.reduce(url) do |new_url, (param, value)|
+          new_url.gsub(":#{param}", value)
+        end
+      end
+    end
+  end
+end