Class: GoCardlessPro::Services::EventsService

Inherits:
BaseService
  • Object
show all
Defined in:
lib/gocardless_pro/services/events_service.rb

Overview

Service for making requests to the Event endpoints

Instance Method Summary collapse

Methods inherited from BaseService

#initialize, #make_request, #sub_url

Constructor Details

This class inherits a constructor from GoCardlessPro::Services::BaseService

Instance Method Details

#all(options = {}) ⇒ Object

Get a lazily enumerated list of all the items returned. This is similar to the list method but will paginate for you automatically.

Otherwise they will be the body of the request.



35
36
37
38
39
40
 
# File 'lib/gocardless_pro/services/events_service.rb', line 35

def all(options = {})
  Paginator.new(
    service: self,
    options: options
  ).enumerator
end

#get(identity, options = {}) ⇒ Object

Retrieves the details of a single event. Example URL: /events/:identity



47
48
49
50
51
52
53
54
55
56
57
58
59
 
# 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 = {}) ⇒ Object

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your events. Example URL: /events



17
18
19
20
21
22
23
24
25
26
27
28
29
 
# 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