Class: MailSafePro::WebhooksManagementApi
- Inherits:
-
Object
- Object
- MailSafePro::WebhooksManagementApi
- Defined in:
- lib/mailsafepro/api/webhooks_management_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_webhook_webhooks_management_webhooks_post(webhook_create, opts = {}) ⇒ Object
Create Webhook Create a new webhook endpoint.
-
#create_webhook_webhooks_management_webhooks_post_with_http_info(webhook_create, opts = {}) ⇒ Array<(Object, Integer, Hash)>
Create Webhook Create a new webhook endpoint.
-
#delete_webhook_webhooks_management_webhooks_webhook_id_delete(webhook_id, opts = {}) ⇒ Object
Delete Webhook Delete webhook.
-
#delete_webhook_webhooks_management_webhooks_webhook_id_delete_with_http_info(webhook_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>
Delete Webhook Delete webhook.
-
#get_deliveries_webhooks_management_webhooks_webhook_id_deliveries_get(webhook_id, opts = {}) ⇒ Object
Get Deliveries Get delivery history for webhook.
-
#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.
-
#get_webhook_webhooks_management_webhooks_webhook_id_get(webhook_id, opts = {}) ⇒ Object
Get Webhook Get webhook details.
-
#get_webhook_webhooks_management_webhooks_webhook_id_get_with_http_info(webhook_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>
Get Webhook Get webhook details.
-
#initialize(api_client = ApiClient.default) ⇒ WebhooksManagementApi
constructor
A new instance of WebhooksManagementApi.
-
#list_webhooks_webhooks_management_webhooks_get(opts = {}) ⇒ Object
List Webhooks List all webhooks for authenticated user.
-
#list_webhooks_webhooks_management_webhooks_get_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>
List Webhooks List all webhooks for authenticated user.
-
#test_webhook_webhooks_management_webhooks_webhook_id_test_post(webhook_id, opts = {}) ⇒ Object
Test Webhook Send test event to webhook.
-
#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.
-
#update_webhook_webhooks_management_webhooks_webhook_id_patch(webhook_id, webhook_update, opts = {}) ⇒ Object
Update Webhook Update webhook configuration.
-
#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.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ WebhooksManagementApi
Returns a new instance of WebhooksManagementApi.
19 20 21 |
# File 'lib/mailsafepro/api/webhooks_management_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_management_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%)
27 28 29 30 |
# File 'lib/mailsafepro/api/webhooks_management_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%)
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_management_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: WebhooksManagementApi.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 WebhooksManagementApi.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'] = opts.merge( :operation => :"WebhooksManagementApi.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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: WebhooksManagementApi#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.
95 96 97 98 |
# File 'lib/mailsafepro/api/webhooks_management_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.
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_management_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: WebhooksManagementApi.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 WebhooksManagementApi.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'] = opts.merge( :operation => :"WebhooksManagementApi.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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: WebhooksManagementApi#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.
159 160 161 162 |
# File 'lib/mailsafepro/api/webhooks_management_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.
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_management_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: WebhooksManagementApi.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 WebhooksManagementApi.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 WebhooksManagementApi.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'] = opts.merge( :operation => :"WebhooksManagementApi.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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: WebhooksManagementApi#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.
228 229 230 231 |
# File 'lib/mailsafepro/api/webhooks_management_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.
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_management_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: WebhooksManagementApi.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 WebhooksManagementApi.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'] = opts.merge( :operation => :"WebhooksManagementApi.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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: WebhooksManagementApi#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.
290 291 292 293 |
# File 'lib/mailsafepro/api/webhooks_management_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.
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_management_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: WebhooksManagementApi.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'] = opts.merge( :operation => :"WebhooksManagementApi.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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: WebhooksManagementApi#list_webhooks_webhooks_management_webhooks_get\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.
348 349 350 351 |
# File 'lib/mailsafepro/api/webhooks_management_api.rb', line 348 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.
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/mailsafepro/api/webhooks_management_api.rb', line 358 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: WebhooksManagementApi.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 WebhooksManagementApi.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'] = opts.merge( :operation => :"WebhooksManagementApi.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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: WebhooksManagementApi#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.
412 413 414 415 |
# File 'lib/mailsafepro/api/webhooks_management_api.rb', line 412 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.
423 424 425 426 427 428 429 430 431 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 |
# File 'lib/mailsafepro/api/webhooks_management_api.rb', line 423 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: WebhooksManagementApi.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 WebhooksManagementApi.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 WebhooksManagementApi.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'] = opts.merge( :operation => :"WebhooksManagementApi.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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: WebhooksManagementApi#update_webhook_webhooks_management_webhooks_webhook_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |