Class: Stripe::V2::Core::EventDestinationService

Inherits:
StripeService show all
Defined in:
lib/stripe/services/v2/core/event_destination_service.rb

Instance Method Summary collapse

Methods inherited from StripeService

#initialize, #request, #request_stream

Constructor Details

This class inherits a constructor from Stripe::StripeService

Instance Method Details

#create(params = {}, opts = {}) ⇒ Object

Create a new event destination.



9
10
11
12
13
14
15
16
17
 
# File 'lib/stripe/services/v2/core/event_destination_service.rb', line 9

def create(params = {}, opts = {})
  request(
    method: :post,
    path: "/v2/core/event_destinations",
    params: params,
    opts: opts,
    base_address: :api
  )
end

#delete(id, params = {}, opts = {}) ⇒ Object

Delete an event destination.



20
21
22
23
24
25
26
27
28
 
# File 'lib/stripe/services/v2/core/event_destination_service.rb', line 20

def delete(id, params = {}, opts = {})
  request(
    method: :delete,
    path: format("/v2/core/event_destinations/%<id>s", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#disable(id, params = {}, opts = {}) ⇒ Object

Disable an event destination.



31
32
33
34
35
36
37
38
39
 
# File 'lib/stripe/services/v2/core/event_destination_service.rb', line 31

def disable(id, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v2/core/event_destinations/%<id>s/disable", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#enable(id, params = {}, opts = {}) ⇒ Object

Enable an event destination.



42
43
44
45
46
47
48
49
50
 
# File 'lib/stripe/services/v2/core/event_destination_service.rb', line 42

def enable(id, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v2/core/event_destinations/%<id>s/enable", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#list(params = {}, opts = {}) ⇒ Object

Lists all event destinations.



53
54
55
56
57
58
59
60
61
 
# File 'lib/stripe/services/v2/core/event_destination_service.rb', line 53

def list(params = {}, opts = {})
  request(
    method: :get,
    path: "/v2/core/event_destinations",
    params: params,
    opts: opts,
    base_address: :api
  )
end

#ping(id, params = {}, opts = {}) ⇒ Object

Send a ‘ping` event to an event destination.



64
65
66
67
68
69
70
71
72
 
# File 'lib/stripe/services/v2/core/event_destination_service.rb', line 64

def ping(id, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v2/core/event_destinations/%<id>s/ping", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#retrieve(id, params = {}, opts = {}) ⇒ Object

Retrieves the details of an event destination.



75
76
77
78
79
80
81
82
83
 
# File 'lib/stripe/services/v2/core/event_destination_service.rb', line 75

def retrieve(id, params = {}, opts = {})
  request(
    method: :get,
    path: format("/v2/core/event_destinations/%<id>s", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#update(id, params = {}, opts = {}) ⇒ Object

Update the details of an event destination.



86
87
88
89
90
91
92
93
94
 
# File 'lib/stripe/services/v2/core/event_destination_service.rb', line 86

def update(id, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v2/core/event_destinations/%<id>s", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end