class GoCardlessPro::Services::InstitutionsService

Service for making requests to the Institution endpoints

Public Instance Methods

all(options = {}) click to toggle source

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/institutions_service.rb, line 34
def all(options = {})
  Paginator.new(
    service: self,
    options: options
  ).enumerator
end
list(options = {}) click to toggle source

Returns a list of all supported institutions. Example URL: /institutions @param options [Hash] parameters as a hash, under a params key.

# File lib/gocardless_pro/services/institutions_service.rb, line 16
def list(options = {})
  path = '/institutions'

  options[:retry_failures] = true

  response = make_request(:get, path, options)

  ListResponse.new(
    response: response,
    unenveloped_body: unenvelope_body(response.body),
    resource_class: Resources::Institution
  )
end

Private Instance Methods

envelope_key() click to toggle source

return the key which API responses will envelope data under

# File lib/gocardless_pro/services/institutions_service.rb, line 51
def envelope_key
  'institutions'
end
unenvelope_body(body) click to toggle source

Unenvelope the response of the body using the service's `envelope_key`

@param body [Hash]

# File lib/gocardless_pro/services/institutions_service.rb, line 46
def unenvelope_body(body)
  body[envelope_key] || body['data']
end