Class: MailSafePro::WebhooksApi

Inherits:
Object
  • Object
show all
Defined in:
lib/mailsafepro/api/webhooks_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WebhooksApi

Returns a new instance of WebhooksApi.



19
20
21
 
# File 'lib/mailsafepro/api/webhooks_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/mailsafepro/api/webhooks_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_webhook_webhooks_management_webhooks_post(webhook_create, opts = {}) ⇒ Object

Create Webhook Create a new webhook endpoint. Events available: - validation.completed: Single email validation finished - batch.completed: Batch validation finished - usage.limit_reached: API usage limit reached (80%)

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


27
28
29
30
 
# File 'lib/mailsafepro/api/webhooks_api.rb', line 27

def create_webhook_webhooks_management_webhooks_post(webhook_create, opts = {})
  data, _status_code, _headers = create_webhook_webhooks_management_webhooks_post_with_http_info(webhook_create, opts)
  data
end

#create_webhook_webhooks_management_webhooks_post_with_http_info(webhook_create, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Create Webhook Create a new webhook endpoint. Events available: - validation.completed: Single email validation finished - batch.completed: Batch validation finished - usage.limit_reached: API usage limit reached (80%)

Parameters:

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
81
82
83
84
85
86
87
88
 
# File 'lib/mailsafepro/api/webhooks_api.rb', line 37

def create_webhook_webhooks_management_webhooks_post_with_http_info(webhook_create, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.create_webhook_webhooks_management_webhooks_post ...'
  end
  # verify the required parameter 'webhook_create' is set
  if @api_client.config.client_side_validation && webhook_create.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_create' when calling WebhooksApi.create_webhook_webhooks_management_webhooks_post"
  end
  # resource path
  local_var_path = '/webhooks-management/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']) unless header_params['Accept']
  # 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(webhook_create)

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Bearer']

  new_options = opts.merge(
    :operation => :"WebhooksApi.create_webhook_webhooks_management_webhooks_post",
    :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: WebhooksApi#create_webhook_webhooks_management_webhooks_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_webhook_webhooks_management_webhooks_webhook_id_delete(webhook_id, opts = {}) ⇒ Object

Delete Webhook Delete webhook.

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


95
96
97
98
 
# File 'lib/mailsafepro/api/webhooks_api.rb', line 95

def delete_webhook_webhooks_management_webhooks_webhook_id_delete(webhook_id, opts = {})
  data, _status_code, _headers = delete_webhook_webhooks_management_webhooks_webhook_id_delete_with_http_info(webhook_id, opts)
  data
end

#delete_webhook_webhooks_management_webhooks_webhook_id_delete_with_http_info(webhook_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Delete Webhook Delete webhook.

Parameters:

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
144
145
146
147
148
149
150
151
 
# File 'lib/mailsafepro/api/webhooks_api.rb', line 105

def delete_webhook_webhooks_management_webhooks_webhook_id_delete_with_http_info(webhook_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.delete_webhook_webhooks_management_webhooks_webhook_id_delete ...'
  end
  # verify the required parameter 'webhook_id' is set
  if @api_client.config.client_side_validation && webhook_id.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_id' when calling WebhooksApi.delete_webhook_webhooks_management_webhooks_webhook_id_delete"
  end
  # resource path
  local_var_path = '/webhooks-management/webhooks/{webhook_id}'.sub('{' + 'webhook_id' + '}', CGI.escape(webhook_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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Bearer']

  new_options = opts.merge(
    :operation => :"WebhooksApi.delete_webhook_webhooks_management_webhooks_webhook_id_delete",
    :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: WebhooksApi#delete_webhook_webhooks_management_webhooks_webhook_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_deliveries_webhooks_management_webhooks_webhook_id_deliveries_get(webhook_id, opts = {}) ⇒ Object

Get Deliveries Get delivery history for webhook.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) — default: default to 100

Returns:

  • (Object) 


159
160
161
162
 
# File 'lib/mailsafepro/api/webhooks_api.rb', line 159

def get_deliveries_webhooks_management_webhooks_webhook_id_deliveries_get(webhook_id, opts = {})
  data, _status_code, _headers = get_deliveries_webhooks_management_webhooks_webhook_id_deliveries_get_with_http_info(webhook_id, opts)
  data
end

#get_deliveries_webhooks_management_webhooks_webhook_id_deliveries_get_with_http_info(webhook_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get Deliveries Get delivery history for webhook.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) — default: default to 100

Returns:

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

    Object data, response status code and response headers



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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/mailsafepro/api/webhooks_api.rb', line 170

def get_deliveries_webhooks_management_webhooks_webhook_id_deliveries_get_with_http_info(webhook_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.get_deliveries_webhooks_management_webhooks_webhook_id_deliveries_get ...'
  end
  # verify the required parameter 'webhook_id' is set
  if @api_client.config.client_side_validation && webhook_id.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_id' when calling WebhooksApi.get_deliveries_webhooks_management_webhooks_webhook_id_deliveries_get"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling WebhooksApi.get_deliveries_webhooks_management_webhooks_webhook_id_deliveries_get, must be smaller than or equal to 500.'
  end

  # resource path
  local_var_path = '/webhooks-management/webhooks/{webhook_id}/deliveries'.sub('{' + 'webhook_id' + '}', CGI.escape(webhook_id.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Bearer']

  new_options = opts.merge(
    :operation => :"WebhooksApi.get_deliveries_webhooks_management_webhooks_webhook_id_deliveries_get",
    :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: WebhooksApi#get_deliveries_webhooks_management_webhooks_webhook_id_deliveries_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_webhook_webhooks_management_webhooks_webhook_id_get(webhook_id, opts = {}) ⇒ Object

Get Webhook Get webhook details.

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


228
229
230
231
 
# File 'lib/mailsafepro/api/webhooks_api.rb', line 228

def get_webhook_webhooks_management_webhooks_webhook_id_get(webhook_id, opts = {})
  data, _status_code, _headers = get_webhook_webhooks_management_webhooks_webhook_id_get_with_http_info(webhook_id, opts)
  data
end

#get_webhook_webhooks_management_webhooks_webhook_id_get_with_http_info(webhook_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get Webhook Get webhook details.

Parameters:

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/mailsafepro/api/webhooks_api.rb', line 238

def get_webhook_webhooks_management_webhooks_webhook_id_get_with_http_info(webhook_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.get_webhook_webhooks_management_webhooks_webhook_id_get ...'
  end
  # verify the required parameter 'webhook_id' is set
  if @api_client.config.client_side_validation && webhook_id.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_id' when calling WebhooksApi.get_webhook_webhooks_management_webhooks_webhook_id_get"
  end
  # resource path
  local_var_path = '/webhooks-management/webhooks/{webhook_id}'.sub('{' + 'webhook_id' + '}', CGI.escape(webhook_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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Bearer']

  new_options = opts.merge(
    :operation => :"WebhooksApi.get_webhook_webhooks_management_webhooks_webhook_id_get",
    :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: WebhooksApi#get_webhook_webhooks_management_webhooks_webhook_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_webhooks_webhooks_management_webhooks_get(opts = {}) ⇒ Object

List Webhooks List all webhooks for authenticated user.

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


290
291
292
293
 
# File 'lib/mailsafepro/api/webhooks_api.rb', line 290

def list_webhooks_webhooks_management_webhooks_get(opts = {})
  data, _status_code, _headers = list_webhooks_webhooks_management_webhooks_get_with_http_info(opts)
  data
end

#list_webhooks_webhooks_management_webhooks_get_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

List Webhooks List all webhooks for authenticated user.

Parameters:

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
335
336
337
338
339
340
341
 
# File 'lib/mailsafepro/api/webhooks_api.rb', line 299

def list_webhooks_webhooks_management_webhooks_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.list_webhooks_webhooks_management_webhooks_get ...'
  end
  # resource path
  local_var_path = '/webhooks-management/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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Bearer']

  new_options = opts.merge(
    :operation => :"WebhooksApi.list_webhooks_webhooks_management_webhooks_get",
    :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: WebhooksApi#list_webhooks_webhooks_management_webhooks_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#register_endpoint_webhooks_v1_webhooks_endpoints_register_post(register_endpoint, opts = {}) ⇒ Object

Register Endpoint

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_api_key (String)
  • :authorization (String)

Returns:

  • (Object) 


349
350
351
352
 
# File 'lib/mailsafepro/api/webhooks_api.rb', line 349

def register_endpoint_webhooks_v1_webhooks_endpoints_register_post(register_endpoint, opts = {})
  data, _status_code, _headers = register_endpoint_webhooks_v1_webhooks_endpoints_register_post_with_http_info(register_endpoint, opts)
  data
end

#register_endpoint_webhooks_v1_webhooks_endpoints_register_post_0(register_endpoint, opts = {}) ⇒ Object

Register Endpoint

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_api_key (String)
  • :authorization (String)

Returns:

  • (Object) 


421
422
423
424
 
# File 'lib/mailsafepro/api/webhooks_api.rb', line 421

def register_endpoint_webhooks_v1_webhooks_endpoints_register_post_0(register_endpoint, opts = {})
  data, _status_code, _headers = register_endpoint_webhooks_v1_webhooks_endpoints_register_post_0_with_http_info(register_endpoint, opts)
  data
end

#register_endpoint_webhooks_v1_webhooks_endpoints_register_post_0_with_http_info(register_endpoint, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Register Endpoint

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_api_key (String)
  • :authorization (String)

Returns:

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

    Object data, response status code and response headers



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/mailsafepro/api/webhooks_api.rb', line 432

def register_endpoint_webhooks_v1_webhooks_endpoints_register_post_0_with_http_info(register_endpoint, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.register_endpoint_webhooks_v1_webhooks_endpoints_register_post_0 ...'
  end
  # verify the required parameter 'register_endpoint' is set
  if @api_client.config.client_side_validation && register_endpoint.nil?
    fail ArgumentError, "Missing the required parameter 'register_endpoint' when calling WebhooksApi.register_endpoint_webhooks_v1_webhooks_endpoints_register_post_0"
  end
  # resource path
  local_var_path = '/webhooks/v1/webhooks/endpoints/register'

  # 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']) unless header_params['Accept']
  # 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
  header_params[:'X-API-Key'] = opts[:'x_api_key'] if !opts[:'x_api_key'].nil?
  header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"WebhooksApi.register_endpoint_webhooks_v1_webhooks_endpoints_register_post_0",
    :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: WebhooksApi#register_endpoint_webhooks_v1_webhooks_endpoints_register_post_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#register_endpoint_webhooks_v1_webhooks_endpoints_register_post_with_http_info(register_endpoint, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Register Endpoint

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_api_key (String)
  • :authorization (String)

Returns:

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

    Object data, response status code and response headers



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
405
406
407
408
409
410
411
412
413
 
# File 'lib/mailsafepro/api/webhooks_api.rb', line 360

def register_endpoint_webhooks_v1_webhooks_endpoints_register_post_with_http_info(register_endpoint, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.register_endpoint_webhooks_v1_webhooks_endpoints_register_post ...'
  end
  # verify the required parameter 'register_endpoint' is set
  if @api_client.config.client_side_validation && register_endpoint.nil?
    fail ArgumentError, "Missing the required parameter 'register_endpoint' when calling WebhooksApi.register_endpoint_webhooks_v1_webhooks_endpoints_register_post"
  end
  # resource path
  local_var_path = '/webhooks/v1/webhooks/endpoints/register'

  # 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']) unless header_params['Accept']
  # 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
  header_params[:'X-API-Key'] = opts[:'x_api_key'] if !opts[:'x_api_key'].nil?
  header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"WebhooksApi.register_endpoint_webhooks_v1_webhooks_endpoints_register_post",
    :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: WebhooksApi#register_endpoint_webhooks_v1_webhooks_endpoints_register_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#rotate_secret_webhooks_v1_webhooks_endpoints_rotate_post(rotate_secret, opts = {}) ⇒ Object

Rotate Secret

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_api_key (String)
  • :authorization (String)

Returns:

  • (Object) 


493
494
495
496
 
# File 'lib/mailsafepro/api/webhooks_api.rb', line 493

def rotate_secret_webhooks_v1_webhooks_endpoints_rotate_post(rotate_secret, opts = {})
  data, _status_code, _headers = rotate_secret_webhooks_v1_webhooks_endpoints_rotate_post_with_http_info(rotate_secret, opts)
  data
end

#rotate_secret_webhooks_v1_webhooks_endpoints_rotate_post_0(rotate_secret, opts = {}) ⇒ Object

Rotate Secret

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_api_key (String)
  • :authorization (String)

Returns:

  • (Object) 


565
566
567
568
 
# File 'lib/mailsafepro/api/webhooks_api.rb', line 565

def rotate_secret_webhooks_v1_webhooks_endpoints_rotate_post_0(rotate_secret, opts = {})
  data, _status_code, _headers = rotate_secret_webhooks_v1_webhooks_endpoints_rotate_post_0_with_http_info(rotate_secret, opts)
  data
end

#rotate_secret_webhooks_v1_webhooks_endpoints_rotate_post_0_with_http_info(rotate_secret, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Rotate Secret

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_api_key (String)
  • :authorization (String)

Returns:

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

    Object data, response status code and response headers



576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
 
# File 'lib/mailsafepro/api/webhooks_api.rb', line 576

def rotate_secret_webhooks_v1_webhooks_endpoints_rotate_post_0_with_http_info(rotate_secret, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.rotate_secret_webhooks_v1_webhooks_endpoints_rotate_post_0 ...'
  end
  # verify the required parameter 'rotate_secret' is set
  if @api_client.config.client_side_validation && rotate_secret.nil?
    fail ArgumentError, "Missing the required parameter 'rotate_secret' when calling WebhooksApi.rotate_secret_webhooks_v1_webhooks_endpoints_rotate_post_0"
  end
  # resource path
  local_var_path = '/webhooks/v1/webhooks/endpoints/rotate'

  # 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']) unless header_params['Accept']
  # 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
  header_params[:'X-API-Key'] = opts[:'x_api_key'] if !opts[:'x_api_key'].nil?
  header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"WebhooksApi.rotate_secret_webhooks_v1_webhooks_endpoints_rotate_post_0",
    :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: WebhooksApi#rotate_secret_webhooks_v1_webhooks_endpoints_rotate_post_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#rotate_secret_webhooks_v1_webhooks_endpoints_rotate_post_with_http_info(rotate_secret, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Rotate Secret

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_api_key (String)
  • :authorization (String)

Returns:

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

    Object data, response status code and response headers



504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/mailsafepro/api/webhooks_api.rb', line 504

def rotate_secret_webhooks_v1_webhooks_endpoints_rotate_post_with_http_info(rotate_secret, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.rotate_secret_webhooks_v1_webhooks_endpoints_rotate_post ...'
  end
  # verify the required parameter 'rotate_secret' is set
  if @api_client.config.client_side_validation && rotate_secret.nil?
    fail ArgumentError, "Missing the required parameter 'rotate_secret' when calling WebhooksApi.rotate_secret_webhooks_v1_webhooks_endpoints_rotate_post"
  end
  # resource path
  local_var_path = '/webhooks/v1/webhooks/endpoints/rotate'

  # 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']) unless header_params['Accept']
  # 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
  header_params[:'X-API-Key'] = opts[:'x_api_key'] if !opts[:'x_api_key'].nil?
  header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"WebhooksApi.rotate_secret_webhooks_v1_webhooks_endpoints_rotate_post",
    :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: WebhooksApi#rotate_secret_webhooks_v1_webhooks_endpoints_rotate_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#test_webhook_webhooks_management_webhooks_webhook_id_test_post(webhook_id, opts = {}) ⇒ Object

Test Webhook Send test event to webhook.

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


636
637
638
639
 
# File 'lib/mailsafepro/api/webhooks_api.rb', line 636

def test_webhook_webhooks_management_webhooks_webhook_id_test_post(webhook_id, opts = {})
  data, _status_code, _headers = test_webhook_webhooks_management_webhooks_webhook_id_test_post_with_http_info(webhook_id, opts)
  data
end

#test_webhook_webhooks_management_webhooks_webhook_id_test_post_with_http_info(webhook_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Test Webhook Send test event to webhook.

Parameters:

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'lib/mailsafepro/api/webhooks_api.rb', line 646

def test_webhook_webhooks_management_webhooks_webhook_id_test_post_with_http_info(webhook_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.test_webhook_webhooks_management_webhooks_webhook_id_test_post ...'
  end
  # verify the required parameter 'webhook_id' is set
  if @api_client.config.client_side_validation && webhook_id.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_id' when calling WebhooksApi.test_webhook_webhooks_management_webhooks_webhook_id_test_post"
  end
  # resource path
  local_var_path = '/webhooks-management/webhooks/{webhook_id}/test'.sub('{' + 'webhook_id' + '}', CGI.escape(webhook_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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Bearer']

  new_options = opts.merge(
    :operation => :"WebhooksApi.test_webhook_webhooks_management_webhooks_webhook_id_test_post",
    :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: WebhooksApi#test_webhook_webhooks_management_webhooks_webhook_id_test_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_webhook_webhooks_management_webhooks_webhook_id_patch(webhook_id, webhook_update, opts = {}) ⇒ Object

Update Webhook Update webhook configuration.

Parameters:

  • webhook_id (String)
  • webhook_update (WebhookUpdate)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


700
701
702
703
 
# File 'lib/mailsafepro/api/webhooks_api.rb', line 700

def update_webhook_webhooks_management_webhooks_webhook_id_patch(webhook_id, webhook_update, opts = {})
  data, _status_code, _headers = update_webhook_webhooks_management_webhooks_webhook_id_patch_with_http_info(webhook_id, webhook_update, opts)
  data
end

#update_webhook_webhooks_management_webhooks_webhook_id_patch_with_http_info(webhook_id, webhook_update, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Update Webhook Update webhook configuration.

Parameters:

  • webhook_id (String)
  • webhook_update (WebhookUpdate)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    Object data, response status code and response headers



711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
 
# File 'lib/mailsafepro/api/webhooks_api.rb', line 711

def update_webhook_webhooks_management_webhooks_webhook_id_patch_with_http_info(webhook_id, webhook_update, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.update_webhook_webhooks_management_webhooks_webhook_id_patch ...'
  end
  # verify the required parameter 'webhook_id' is set
  if @api_client.config.client_side_validation && webhook_id.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_id' when calling WebhooksApi.update_webhook_webhooks_management_webhooks_webhook_id_patch"
  end
  # verify the required parameter 'webhook_update' is set
  if @api_client.config.client_side_validation && webhook_update.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_update' when calling WebhooksApi.update_webhook_webhooks_management_webhooks_webhook_id_patch"
  end
  # resource path
  local_var_path = '/webhooks-management/webhooks/{webhook_id}'.sub('{' + 'webhook_id' + '}', CGI.escape(webhook_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']) unless header_params['Accept']
  # 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(webhook_update)

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Bearer']

  new_options = opts.merge(
    :operation => :"WebhooksApi.update_webhook_webhooks_management_webhooks_webhook_id_patch",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhooksApi#update_webhook_webhooks_management_webhooks_webhook_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end