class GoCardless::Services::CreditorService
Service for making requests to the Creditor endpoints
Public Instance Methods
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.
# File lib/gocardless-pro/services/creditor_service.rb, line 48 def all(options = {}) Paginator.new( service: self, path: '/creditors', options: options ).enumerator end
Creates a new creditor. Example URL: /creditors @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.
# File lib/gocardless-pro/services/creditor_service.rb, line 17 def create(options = {}, custom_headers = {}) path = '/creditors' new_options = {} new_options[envelope_key] = options options = new_options response = make_request(:post, path, options, custom_headers) Resources::Creditor.new(unenvelope_body(response.body)) 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. If the request is a GET, these will be converted to query parameters. Else, they will be the body of the request.
# File lib/gocardless-pro/services/creditor_service.rb, line 62 def get(identity, options = {}, custom_headers = {}) path = sub_url('/creditors/:identity', 'identity' => identity) response = make_request(:get, path, options, custom_headers) Resources::Creditor.new(unenvelope_body(response.body)) end
Returns a [cursor-paginated](developer.gocardless.com/pro/#overview-cursor-pagination) list of your creditors. Example URL: /creditors @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.
# File lib/gocardless-pro/services/creditor_service.rb, line 33 def list(options = {}, custom_headers = {}) path = '/creditors' response = make_request(:get, path, options, custom_headers) ListResponse.new( raw_response: response, unenveloped_body: unenvelope_body(response.body), resource_class: Resources::Creditor ) end
Unenvelope the response of the body using the service’s ‘envelope_key`
@param body [Hash]
# File lib/gocardless-pro/services/creditor_service.rb, line 91 def unenvelope_body(body) body[envelope_key] || body['data'] 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. If the request is a GET, these will be converted to query parameters. Else, they will be the body of the request.
# File lib/gocardless-pro/services/creditor_service.rb, line 77 def update(identity, options = {}, custom_headers = {}) path = sub_url('/creditors/:identity', 'identity' => identity) new_options = {} new_options[envelope_key] = options options = new_options response = make_request(:put, path, options, custom_headers) Resources::Creditor.new(unenvelope_body(response.body)) end
Private Instance Methods
return the key which API responses will envelope data under
# File lib/gocardless-pro/services/creditor_service.rb, line 98 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
# File lib/gocardless-pro/services/creditor_service.rb, line 105 def sub_url(url, param_map) param_map.reduce(url) do |new_url, (param, value)| new_url.gsub(":#{param}", value) end end