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

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

Defined Under Namespace

Classes: CreateParams, DeleteParams, DisableParams, EnableParams, ListParams, PingParams, RetrieveParams, UpdateParams

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.



152
153
154
155
156
157
158
159
160
 
# File 'lib/stripe/services/v2/core/event_destination_service.rb', line 152

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.



163
164
165
166
167
168
169
170
171
 
# File 'lib/stripe/services/v2/core/event_destination_service.rb', line 163

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.



174
175
176
177
178
179
180
181
182
 
# File 'lib/stripe/services/v2/core/event_destination_service.rb', line 174

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.



185
186
187
188
189
190
191
192
193
 
# File 'lib/stripe/services/v2/core/event_destination_service.rb', line 185

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.



196
197
198
199
200
201
202
203
204
 
# File 'lib/stripe/services/v2/core/event_destination_service.rb', line 196

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.



207
208
209
210
211
212
213
214
215
 
# File 'lib/stripe/services/v2/core/event_destination_service.rb', line 207

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.



218
219
220
221
222
223
224
225
226
 
# File 'lib/stripe/services/v2/core/event_destination_service.rb', line 218

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.



229
230
231
232
233
234
235
236
237
 
# File 'lib/stripe/services/v2/core/event_destination_service.rb', line 229

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