Class: Phyllo::WebhookApi

Inherits:
Object
  • Object
show all
Defined in:
lib/phyllo/api/webhook_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WebhookApi

Returns a new instance of WebhookApi.



17
18
19
 
# File 'lib/phyllo/api/webhook_api.rb', line 17

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/phyllo/api/webhook_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#v1_webhook_delete_webhooks_by_id(id, opts = {}) ⇒ nil

Delete a webhook Delete a webhook information

Parameters:

  • id (String) —

    Unique identifier for the webhook.

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

    the optional parameters

Returns:

  • (nil) 


26
27
28
29
 
# File 'lib/phyllo/api/webhook_api.rb', line 26

def v1_webhook_delete_webhooks_by_id(id, opts = {})
  v1_webhook_delete_webhooks_by_id_with_http_info(id, opts)
  nil
end

#v1_webhook_delete_webhooks_by_id_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a webhook Delete a webhook information

Parameters:

  • id (String) —

    Unique identifier for the webhook.

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/phyllo/api/webhook_api.rb', line 36

def v1_webhook_delete_webhooks_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WebhookApi.v1_webhook_delete_webhooks_by_id ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling WebhookApi.v1_webhook_delete_webhooks_by_id"
  end
  # resource path
  local_var_path = "/v1/webhooks/{id}".sub("{" + "id" + "}", CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

  new_options = opts.merge(
    operation: :"WebhookApi.v1_webhook_delete_webhooks_by_id",
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhookApi#v1_webhook_delete_webhooks_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#v1_webhook_get_webhooks(opts = {}) ⇒ WebhookResponseList1

Retrieve all webhooks Lists all Webhooks.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of objects to be returned. It can be between 1 to 100. The default value is 10. (default to 10)

  • :offset (Integer) —

    The number of objects to skip. Use this argument for pagination. The default value is 0. (default to 0)

Returns:



88
89
90
91
 
# File 'lib/phyllo/api/webhook_api.rb', line 88

def v1_webhook_get_webhooks(opts = {})
  data, _status_code, _headers = v1_webhook_get_webhooks_with_http_info(opts)
  data
end

#v1_webhook_get_webhooks_by_id(id, opts = {}) ⇒ WebhookResponse1

Retrieve a webhook Retrieve the information of the Webhook with the supplied Webhook id.

Parameters:

  • id (String) —

    Unique identifier for the webhook.

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

    the optional parameters

Returns:



150
151
152
153
 
# File 'lib/phyllo/api/webhook_api.rb', line 150

def v1_webhook_get_webhooks_by_id(id, opts = {})
  data, _status_code, _headers = v1_webhook_get_webhooks_by_id_with_http_info(id, opts)
  data
end

#v1_webhook_get_webhooks_by_id_with_http_info(id, opts = {}) ⇒ Array<(WebhookResponse1, Integer, Hash)>

Retrieve a webhook Retrieve the information of the Webhook with the supplied Webhook id.

Parameters:

  • id (String) —

    Unique identifier for the webhook.

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

    the optional parameters

Returns:

  • (Array<(WebhookResponse1, Integer, Hash)>) —

    WebhookResponse1 data, response status code and response headers



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/phyllo/api/webhook_api.rb', line 160

def v1_webhook_get_webhooks_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WebhookApi.v1_webhook_get_webhooks_by_id ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling WebhookApi.v1_webhook_get_webhooks_by_id"
  end
  # resource path
  local_var_path = "/v1/webhooks/{id}".sub("{" + "id" + "}", CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params["Accept"] = @api_client.select_header_accept(["application/json"])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || "WebhookResponse1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

  new_options = opts.merge(
    operation: :"WebhookApi.v1_webhook_get_webhooks_by_id",
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhookApi#v1_webhook_get_webhooks_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#v1_webhook_get_webhooks_with_http_info(opts = {}) ⇒ Array<(WebhookResponseList1, Integer, Hash)>

Retrieve all webhooks Lists all Webhooks.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of objects to be returned. It can be between 1 to 100. The default value is 10. (default to 10)

  • :offset (Integer) —

    The number of objects to skip. Use this argument for pagination. The default value is 0. (default to 0)

Returns:

  • (Array<(WebhookResponseList1, Integer, Hash)>) —

    WebhookResponseList1 data, response status code and response headers



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/phyllo/api/webhook_api.rb', line 99

def v1_webhook_get_webhooks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WebhookApi.v1_webhook_get_webhooks ..."
  end
  # resource path
  local_var_path = "/v1/webhooks"

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:limit] = opts[:limit] if !opts[:limit].nil?
  query_params[:offset] = opts[:offset] if !opts[:offset].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params["Accept"] = @api_client.select_header_accept(["application/json"])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || "WebhookResponseList1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

  new_options = opts.merge(
    operation: :"WebhookApi.v1_webhook_get_webhooks",
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhookApi#v1_webhook_get_webhooks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#v1_webhook_post_webhooks(opts = {}) ⇒ WebhookResponse1

Create a webhook Create a Webhook.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



213
214
215
216
 
# File 'lib/phyllo/api/webhook_api.rb', line 213

def v1_webhook_post_webhooks(opts = {})
  data, _status_code, _headers = v1_webhook_post_webhooks_with_http_info(opts)
  data
end

#v1_webhook_post_webhooks_send(opts = {}) ⇒ WebhookPayload1

Send a mock webhook notification Sends a webhook notification on the registered webhook URL.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



277
278
279
280
 
# File 'lib/phyllo/api/webhook_api.rb', line 277

def v1_webhook_post_webhooks_send(opts = {})
  data, _status_code, _headers = v1_webhook_post_webhooks_send_with_http_info(opts)
  data
end

#v1_webhook_post_webhooks_send_with_http_info(opts = {}) ⇒ Array<(WebhookPayload1, Integer, Hash)>

Send a mock webhook notification Sends a webhook notification on the registered webhook URL.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(WebhookPayload1, Integer, Hash)>) —

    WebhookPayload1 data, response status code and response headers



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/phyllo/api/webhook_api.rb', line 287

def v1_webhook_post_webhooks_send_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WebhookApi.v1_webhook_post_webhooks_send ..."
  end
  # resource path
  local_var_path = "/v1/webhooks/send"

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params["Accept"] = @api_client.select_header_accept(["application/json"])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(["application/json"])
  if !content_type.nil?
    header_params["Content-Type"] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:send_webhook_payload1])

  # return_type
  return_type = opts[:debug_return_type] || "WebhookPayload1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

  new_options = opts.merge(
    operation: :"WebhookApi.v1_webhook_post_webhooks_send",
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhookApi#v1_webhook_post_webhooks_send\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#v1_webhook_post_webhooks_with_http_info(opts = {}) ⇒ Array<(WebhookResponse1, Integer, Hash)>

Create a webhook Create a Webhook.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(WebhookResponse1, Integer, Hash)>) —

    WebhookResponse1 data, response status code and response headers



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/phyllo/api/webhook_api.rb', line 223

def v1_webhook_post_webhooks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WebhookApi.v1_webhook_post_webhooks ..."
  end
  # resource path
  local_var_path = "/v1/webhooks"

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params["Accept"] = @api_client.select_header_accept(["application/json"])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(["application/json"])
  if !content_type.nil?
    header_params["Content-Type"] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:create_webhook_request1])

  # return_type
  return_type = opts[:debug_return_type] || "WebhookResponse1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

  new_options = opts.merge(
    operation: :"WebhookApi.v1_webhook_post_webhooks",
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhookApi#v1_webhook_post_webhooks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#v1_webhook_put_webhooks_by_id(id, opts = {}) ⇒ WebhookResponse1

Update a webhook Update a webhook information

Parameters:

  • id (String) —

    Unique identifier for the webhook.

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

    the optional parameters

Options Hash (opts):

Returns:



342
343
344
345
 
# File 'lib/phyllo/api/webhook_api.rb', line 342

def v1_webhook_put_webhooks_by_id(id, opts = {})
  data, _status_code, _headers = v1_webhook_put_webhooks_by_id_with_http_info(id, opts)
  data
end

#v1_webhook_put_webhooks_by_id_with_http_info(id, opts = {}) ⇒ Array<(WebhookResponse1, Integer, Hash)>

Update a webhook Update a webhook information

Parameters:

  • id (String) —

    Unique identifier for the webhook.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(WebhookResponse1, Integer, Hash)>) —

    WebhookResponse1 data, response status code and response headers



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/phyllo/api/webhook_api.rb', line 353

def v1_webhook_put_webhooks_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WebhookApi.v1_webhook_put_webhooks_by_id ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling WebhookApi.v1_webhook_put_webhooks_by_id"
  end
  # resource path
  local_var_path = "/v1/webhooks/{id}".sub("{" + "id" + "}", CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params["Accept"] = @api_client.select_header_accept(["application/json"])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(["application/json"])
  if !content_type.nil?
    header_params["Content-Type"] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:update_webhook_request1])

  # return_type
  return_type = opts[:debug_return_type] || "WebhookResponse1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

  new_options = opts.merge(
    operation: :"WebhookApi.v1_webhook_put_webhooks_by_id",
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhookApi#v1_webhook_put_webhooks_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end