class GoCardlessPro::Services::EventsService

Service for making requests to the Event 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/events_service.rb, line 35
def all(options = {})
  Paginator.new(
    service: self,
    options: options
  ).enumerator
end
get(identity, options = {}) click to toggle source

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.

# File lib/gocardless_pro/services/events_service.rb, line 47
def get(identity, options = {})
  path = sub_url('/events/:identity', 'identity' => identity)

  options[:retry_failures] = true

  response = make_request(:get, path, options)

  return if response.body.nil?

  Resources::Event.new(unenvelope_body(response.body), response)
end
list(options = {}) click to toggle source

Returns a [cursor-paginated](api-usage-cursor-pagination) list of your events. Example URL: /events @param options [Hash] parameters as a hash, under a params key.

# File lib/gocardless_pro/services/events_service.rb, line 17
def list(options = {})
  path = '/events'

  options[:retry_failures] = true

  response = make_request(:get, path, options)

  ListResponse.new(
    response: response,
    unenveloped_body: unenvelope_body(response.body),
    resource_class: Resources::Event
  )
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/events_service.rb, line 69
def envelope_key
  'events'
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/events_service.rb, line 64
def unenvelope_body(body)
  body[envelope_key] || body['data']
end