gocardless_pro 0.3.0

data/lib/gocardless_pro/services/creditors_service.rb

@@ -0,0 +1,113 @@
+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 GoCardlessPro
+  module Services
+    # Service for making requests to the Creditor endpoints
+    class CreditorsService < BaseService
+      # Creates a new creditor.
+      # Example URL: /creditors
+      # @param options [Hash] parameters as a hash, under a params key.
+      def create(options = {})
+        path = '/creditors'
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params][envelope_key] = params
+        response = make_request(:post, path, options)
+
+        return if response.body.nil?
+        Resources::Creditor.new(unenvelope_body(response.body))
+      end
+
+      # Returns a
+      # [cursor-paginated](https://developer.gocardless.com/pro/2015-04-29/#overview-cursor-pagination)
+      # list of your creditors.
+      # Example URL: /creditors
+      # @param options [Hash] parameters as a hash, under a params key.
+      def list(options = {})
+        path = '/creditors'
+
+        response = make_request(:get, path, options)
+        ListResponse.new(
+          raw_response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::Creditor
+        )
+      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: '/creditors',
+          options: options,
+          resource_class: Resources::Creditor
+        ).enumerator
+      end
+
+      # Retrieves the details of an existing creditor.
+      # Example URL: /creditors/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "CR".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def get(identity, options = {})
+        path = sub_url('/creditors/:identity',           'identity' => identity)
+
+        response = make_request(:get, path, options)
+
+        return if response.body.nil?
+        Resources::Creditor.new(unenvelope_body(response.body))
+      end
+
+      # Updates a creditor object. Supports all of the fields supported when creating
+      # a creditor.
+      # Example URL: /creditors/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "CR".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def update(identity, options = {})
+        path = sub_url('/creditors/:identity',           'identity' => identity)
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params][envelope_key] = params
+        response = make_request(:put, path, options)
+
+        return if response.body.nil?
+        Resources::Creditor.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
+        'creditors'
+      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/customer_bank_accounts_service.rb

@@ -0,0 +1,154 @@
+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 GoCardlessPro
+  module Services
+    # Service for making requests to the CustomerBankAccount endpoints
+    class CustomerBankAccountsService < BaseService
+      # Creates a new customer bank account object.
+      #
+      # There are three different
+      # ways to supply bank account details:
+      #
+      # - [Local
+      # details](https://developer.gocardless.com/pro/2015-04-29/#ui-local-bank-details)
+      #
+      #
+      # - IBAN
+      #
+      # - [Customer Bank Account
+      # Tokens](https://developer.gocardless.com/pro/2015-04-29/#js-flow-create-a-customer-bank-account-token)
+      #
+      #
+      # For more information on the different fields required in each country, see
+      # [local bank
+      # details](https://developer.gocardless.com/pro/2015-04-29/#ui-local-bank-details).
+      # Example URL: /customer_bank_accounts
+      # @param options [Hash] parameters as a hash, under a params key.
+      def create(options = {})
+        path = '/customer_bank_accounts'
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params][envelope_key] = params
+        response = make_request(:post, path, options)
+
+        return if response.body.nil?
+        Resources::CustomerBankAccount.new(unenvelope_body(response.body))
+      end
+
+      # Returns a
+      # [cursor-paginated](https://developer.gocardless.com/pro/2015-04-29/#overview-cursor-pagination)
+      # list of your bank accounts.
+      # Example URL: /customer_bank_accounts
+      # @param options [Hash] parameters as a hash, under a params key.
+      def list(options = {})
+        path = '/customer_bank_accounts'
+
+        response = make_request(:get, path, options)
+        ListResponse.new(
+          raw_response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::CustomerBankAccount
+        )
+      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: '/customer_bank_accounts',
+          options: options,
+          resource_class: Resources::CustomerBankAccount
+        ).enumerator
+      end
+
+      # Retrieves the details of an existing bank account.
+      # Example URL: /customer_bank_accounts/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "BA"
+      # @param options [Hash] parameters as a hash, under a params key.
+      def get(identity, options = {})
+        path = sub_url('/customer_bank_accounts/:identity',           'identity' => identity)
+
+        response = make_request(:get, path, options)
+
+        return if response.body.nil?
+        Resources::CustomerBankAccount.new(unenvelope_body(response.body))
+      end
+
+      # Updates a customer bank account object. Only the metadata parameter is
+      # allowed.
+      # Example URL: /customer_bank_accounts/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "BA"
+      # @param options [Hash] parameters as a hash, under a params key.
+      def update(identity, options = {})
+        path = sub_url('/customer_bank_accounts/:identity',           'identity' => identity)
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params][envelope_key] = params
+        response = make_request(:put, path, options)
+
+        return if response.body.nil?
+        Resources::CustomerBankAccount.new(unenvelope_body(response.body))
+      end
+
+      # Immediately cancels all associated mandates and cancellable payments.
+      #
+      #
+      # This will return a `disable_failed` error if the bank account has already been
+      # disabled.
+      #
+      # A disabled bank account can be re-enabled by creating a new
+      # bank account resource with the same details.
+      # Example URL: /customer_bank_accounts/:identity/actions/disable
+      #
+      # @param identity       # Unique identifier, beginning with "BA"
+      # @param options [Hash] parameters as a hash, under a params key.
+      def disable(identity, options = {})
+        path = sub_url('/customer_bank_accounts/:identity/actions/disable',           'identity' => identity)
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params]['data'] = params
+        response = make_request(:post, path, options)
+
+        return if response.body.nil?
+        Resources::CustomerBankAccount.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
+        'customer_bank_accounts'
+      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/customers_service.rb

@@ -0,0 +1,113 @@
+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 GoCardlessPro
+  module Services
+    # Service for making requests to the Customer endpoints
+    class CustomersService < BaseService
+      # Creates a new customer object.
+      # Example URL: /customers
+      # @param options [Hash] parameters as a hash, under a params key.
+      def create(options = {})
+        path = '/customers'
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params][envelope_key] = params
+        response = make_request(:post, path, options)
+
+        return if response.body.nil?
+        Resources::Customer.new(unenvelope_body(response.body))
+      end
+
+      # Returns a
+      # [cursor-paginated](https://developer.gocardless.com/pro/2015-04-29/#overview-cursor-pagination)
+      # list of your customers.
+      # Example URL: /customers
+      # @param options [Hash] parameters as a hash, under a params key.
+      def list(options = {})
+        path = '/customers'
+
+        response = make_request(:get, path, options)
+        ListResponse.new(
+          raw_response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::Customer
+        )
+      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: '/customers',
+          options: options,
+          resource_class: Resources::Customer
+        ).enumerator
+      end
+
+      # Retrieves the details of an existing customer.
+      # Example URL: /customers/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "CU".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def get(identity, options = {})
+        path = sub_url('/customers/:identity',           'identity' => identity)
+
+        response = make_request(:get, path, options)
+
+        return if response.body.nil?
+        Resources::Customer.new(unenvelope_body(response.body))
+      end
+
+      # Updates a customer object. Supports all of the fields supported when creating
+      # a customer.
+      # Example URL: /customers/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "CU".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def update(identity, options = {})
+        path = sub_url('/customers/:identity',           'identity' => identity)
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params][envelope_key] = params
+        response = make_request(:put, path, options)
+
+        return if response.body.nil?
+        Resources::Customer.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
+        'customers'
+      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/events_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 GoCardlessPro
+  module Services
+    # Service for making requests to the Event endpoints
+    class EventsService < BaseService
+      # Returns a
+      # [cursor-paginated](https://developer.gocardless.com/pro/2015-04-29/#overview-cursor-pagination)
+      # list of your events.
+      # Example URL: /events
+      # @param options [Hash] parameters as a hash, under a params key.
+      def list(options = {})
+        path = '/events'
+
+        response = make_request(:get, path, options)
+        ListResponse.new(
+          raw_response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::Event
+        )
+      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: '/events',
+          options: options,
+          resource_class: Resources::Event
+        ).enumerator
+      end
+
+      # Retrieves the details of a single event.
+      # Example URL: /events/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "EV"
+      # @param options [Hash] parameters as a hash, under a params key.
+      def get(identity, options = {})
+        path = sub_url('/events/:identity',           'identity' => identity)
+
+        response = make_request(:get, path, options)
+
+        return if response.body.nil?
+        Resources::Event.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
+        'events'
+      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