class GoCardlessPro::Services::BalancesService
Service for making requests to the Balance endpoints
Public Instance Methods
Source
# File lib/gocardless_pro/services/balances_service.rb, line 35 def all(options = {}) Paginator.new( service: self, options: options ).enumerator end
Get a lazily enumerated list of all the items returned. This is similar 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.
Source
# File lib/gocardless_pro/services/balances_service.rb, line 17 def list(options = {}) path = '/balances' options[:retry_failures] = true response = make_request(:get, path, options) ListResponse.new( response: response, unenveloped_body: unenvelope_body(response.body), resource_class: Resources::Balance ) end
Returns a [cursor-paginated](api-usage-cursor-pagination) list of balances for a given creditor. This endpoint is rate limited to 60 requests per minute. Example URL: /balances @param options [Hash] parameters as a hash, under a params key.
Private Instance Methods
Source
# File lib/gocardless_pro/services/balances_service.rb, line 52 def envelope_key 'balances' end
return the key which API responses will envelope data under
Source
# File lib/gocardless_pro/services/balances_service.rb, line 47 def unenvelope_body(body) body[envelope_key] || body['data'] end
Unenvelope the response of the body using the service’s ‘envelope_key`
@param body [Hash]