Class: GoCardlessPro::Services::WebhooksService

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

Overview

Service for making requests to the Webhook 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.

Parameters:

  • options (Hash) (defaults to: {}) —

    parameters as a hash. If the request is a GET, these will be converted to query parameters.



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

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

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

Retrieves the details of an existing webhook. Example URL: /webhooks/:identity

Parameters:

  • identity —

    # Unique identifier, beginning with “WB”.

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/gocardless_pro/services/webhooks_service.rb', line 47

def get(identity, options = {})
  path = sub_url('/webhooks/:identity', {
                   'identity' => identity
                 })

  options[:retry_failures] = true

  response = make_request(:get, path, options)

  return if response.body.nil?

  Resources::Webhook.new(unenvelope_body(response.body), response)
end

#list(options = {}) ⇒ Object

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

Parameters:

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/gocardless_pro/services/webhooks_service.rb', line 17

def list(options = {})
  path = '/webhooks'

  options[:retry_failures] = true

  response = make_request(:get, path, options)

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

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

Requests for a previous webhook to be sent again Example URL: /webhooks/:identity/actions/retry

Parameters:

  • identity —

    # Unique identifier, beginning with “WB”.

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/gocardless_pro/services/webhooks_service.rb', line 66

def retry(identity, options = {})
  path = sub_url('/webhooks/:identity/actions/retry', {
                   'identity' => identity
                 })

  params = options.delete(:params) || {}
  options[:params] = {}
  options[:params]['data'] = params

  options[:retry_failures] = false

  begin
    response = make_request(:post, path, options)

    # Response doesn't raise any errors until #body is called
    response.tap(&:body)
  rescue InvalidStateError => e
    if e.idempotent_creation_conflict?
      case @api_service.on_idempotency_conflict
      when :raise
        raise IdempotencyConflict, e.error
      when :fetch
        return get(e.conflicting_resource_id)
      end
    end

    raise e
  end

  return if response.body.nil?

  Resources::Webhook.new(unenvelope_body(response.body), response)
end