mailsafepro 1.0.0

data/docs/WebhooksManagementApi.md

@@ -0,0 +1,500 @@
+# MailSafePro::WebhooksManagementApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_webhook_webhooks_management_webhooks_post**](WebhooksManagementApi.md#create_webhook_webhooks_management_webhooks_post) | **POST** /webhooks-management/webhooks/ | Create Webhook |
+| [**delete_webhook_webhooks_management_webhooks_webhook_id_delete**](WebhooksManagementApi.md#delete_webhook_webhooks_management_webhooks_webhook_id_delete) | **DELETE** /webhooks-management/webhooks/{webhook_id} | Delete Webhook |
+| [**get_deliveries_webhooks_management_webhooks_webhook_id_deliveries_get**](WebhooksManagementApi.md#get_deliveries_webhooks_management_webhooks_webhook_id_deliveries_get) | **GET** /webhooks-management/webhooks/{webhook_id}/deliveries | Get Deliveries |
+| [**get_webhook_webhooks_management_webhooks_webhook_id_get**](WebhooksManagementApi.md#get_webhook_webhooks_management_webhooks_webhook_id_get) | **GET** /webhooks-management/webhooks/{webhook_id} | Get Webhook |
+| [**list_webhooks_webhooks_management_webhooks_get**](WebhooksManagementApi.md#list_webhooks_webhooks_management_webhooks_get) | **GET** /webhooks-management/webhooks/ | List Webhooks |
+| [**test_webhook_webhooks_management_webhooks_webhook_id_test_post**](WebhooksManagementApi.md#test_webhook_webhooks_management_webhooks_webhook_id_test_post) | **POST** /webhooks-management/webhooks/{webhook_id}/test | Test Webhook |
+| [**update_webhook_webhooks_management_webhooks_webhook_id_patch**](WebhooksManagementApi.md#update_webhook_webhooks_management_webhooks_webhook_id_patch) | **PATCH** /webhooks-management/webhooks/{webhook_id} | Update Webhook |
+
+
+## create_webhook_webhooks_management_webhooks_post
+
+> Object create_webhook_webhooks_management_webhooks_post(webhook_create)
+
+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%)
+
+### Examples
+
+```ruby
+require 'time'
+require 'mailsafepro'
+# setup authorization
+MailSafePro.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MailSafePro::WebhooksManagementApi.new
+webhook_create = MailSafePro::WebhookCreate.new({url: 'url_example'}) # WebhookCreate | 
+
+begin
+  # Create Webhook
+  result = api_instance.create_webhook_webhooks_management_webhooks_post(webhook_create)
+  p result
+rescue MailSafePro::ApiError => e
+  puts "Error when calling WebhooksManagementApi->create_webhook_webhooks_management_webhooks_post: #{e}"
+end
+```
+
+#### Using the create_webhook_webhooks_management_webhooks_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> create_webhook_webhooks_management_webhooks_post_with_http_info(webhook_create)
+
+```ruby
+begin
+  # Create Webhook
+  data, status_code, headers = api_instance.create_webhook_webhooks_management_webhooks_post_with_http_info(webhook_create)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue MailSafePro::ApiError => e
+  puts "Error when calling WebhooksManagementApi->create_webhook_webhooks_management_webhooks_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook_create** | [**WebhookCreate**](WebhookCreate.md) |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_webhook_webhooks_management_webhooks_webhook_id_delete
+
+> Object delete_webhook_webhooks_management_webhooks_webhook_id_delete(webhook_id)
+
+Delete Webhook
+
+Delete webhook.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mailsafepro'
+# setup authorization
+MailSafePro.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MailSafePro::WebhooksManagementApi.new
+webhook_id = 'webhook_id_example' # String | 
+
+begin
+  # Delete Webhook
+  result = api_instance.delete_webhook_webhooks_management_webhooks_webhook_id_delete(webhook_id)
+  p result
+rescue MailSafePro::ApiError => e
+  puts "Error when calling WebhooksManagementApi->delete_webhook_webhooks_management_webhooks_webhook_id_delete: #{e}"
+end
+```
+
+#### Using the delete_webhook_webhooks_management_webhooks_webhook_id_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> delete_webhook_webhooks_management_webhooks_webhook_id_delete_with_http_info(webhook_id)
+
+```ruby
+begin
+  # Delete Webhook
+  data, status_code, headers = api_instance.delete_webhook_webhooks_management_webhooks_webhook_id_delete_with_http_info(webhook_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue MailSafePro::ApiError => e
+  puts "Error when calling WebhooksManagementApi->delete_webhook_webhooks_management_webhooks_webhook_id_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_deliveries_webhooks_management_webhooks_webhook_id_deliveries_get
+
+> Object get_deliveries_webhooks_management_webhooks_webhook_id_deliveries_get(webhook_id, opts)
+
+Get Deliveries
+
+Get delivery history for webhook.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mailsafepro'
+# setup authorization
+MailSafePro.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MailSafePro::WebhooksManagementApi.new
+webhook_id = 'webhook_id_example' # String | 
+opts = {
+  limit: 56 # Integer | 
+}
+
+begin
+  # Get Deliveries
+  result = api_instance.get_deliveries_webhooks_management_webhooks_webhook_id_deliveries_get(webhook_id, opts)
+  p result
+rescue MailSafePro::ApiError => e
+  puts "Error when calling WebhooksManagementApi->get_deliveries_webhooks_management_webhooks_webhook_id_deliveries_get: #{e}"
+end
+```
+
+#### Using the get_deliveries_webhooks_management_webhooks_webhook_id_deliveries_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> get_deliveries_webhooks_management_webhooks_webhook_id_deliveries_get_with_http_info(webhook_id, opts)
+
+```ruby
+begin
+  # Get Deliveries
+  data, status_code, headers = api_instance.get_deliveries_webhooks_management_webhooks_webhook_id_deliveries_get_with_http_info(webhook_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue MailSafePro::ApiError => e
+  puts "Error when calling WebhooksManagementApi->get_deliveries_webhooks_management_webhooks_webhook_id_deliveries_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook_id** | **String** |  |  |
+| **limit** | **Integer** |  | [optional][default to 100] |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_webhook_webhooks_management_webhooks_webhook_id_get
+
+> Object get_webhook_webhooks_management_webhooks_webhook_id_get(webhook_id)
+
+Get Webhook
+
+Get webhook details.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mailsafepro'
+# setup authorization
+MailSafePro.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MailSafePro::WebhooksManagementApi.new
+webhook_id = 'webhook_id_example' # String | 
+
+begin
+  # Get Webhook
+  result = api_instance.get_webhook_webhooks_management_webhooks_webhook_id_get(webhook_id)
+  p result
+rescue MailSafePro::ApiError => e
+  puts "Error when calling WebhooksManagementApi->get_webhook_webhooks_management_webhooks_webhook_id_get: #{e}"
+end
+```
+
+#### Using the get_webhook_webhooks_management_webhooks_webhook_id_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> get_webhook_webhooks_management_webhooks_webhook_id_get_with_http_info(webhook_id)
+
+```ruby
+begin
+  # Get Webhook
+  data, status_code, headers = api_instance.get_webhook_webhooks_management_webhooks_webhook_id_get_with_http_info(webhook_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue MailSafePro::ApiError => e
+  puts "Error when calling WebhooksManagementApi->get_webhook_webhooks_management_webhooks_webhook_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_webhooks_webhooks_management_webhooks_get
+
+> Object list_webhooks_webhooks_management_webhooks_get
+
+List Webhooks
+
+List all webhooks for authenticated user.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mailsafepro'
+# setup authorization
+MailSafePro.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MailSafePro::WebhooksManagementApi.new
+
+begin
+  # List Webhooks
+  result = api_instance.list_webhooks_webhooks_management_webhooks_get
+  p result
+rescue MailSafePro::ApiError => e
+  puts "Error when calling WebhooksManagementApi->list_webhooks_webhooks_management_webhooks_get: #{e}"
+end
+```
+
+#### Using the list_webhooks_webhooks_management_webhooks_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> list_webhooks_webhooks_management_webhooks_get_with_http_info
+
+```ruby
+begin
+  # List Webhooks
+  data, status_code, headers = api_instance.list_webhooks_webhooks_management_webhooks_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue MailSafePro::ApiError => e
+  puts "Error when calling WebhooksManagementApi->list_webhooks_webhooks_management_webhooks_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## test_webhook_webhooks_management_webhooks_webhook_id_test_post
+
+> Object test_webhook_webhooks_management_webhooks_webhook_id_test_post(webhook_id)
+
+Test Webhook
+
+Send test event to webhook.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mailsafepro'
+# setup authorization
+MailSafePro.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MailSafePro::WebhooksManagementApi.new
+webhook_id = 'webhook_id_example' # String | 
+
+begin
+  # Test Webhook
+  result = api_instance.test_webhook_webhooks_management_webhooks_webhook_id_test_post(webhook_id)
+  p result
+rescue MailSafePro::ApiError => e
+  puts "Error when calling WebhooksManagementApi->test_webhook_webhooks_management_webhooks_webhook_id_test_post: #{e}"
+end
+```
+
+#### Using the test_webhook_webhooks_management_webhooks_webhook_id_test_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> test_webhook_webhooks_management_webhooks_webhook_id_test_post_with_http_info(webhook_id)
+
+```ruby
+begin
+  # Test Webhook
+  data, status_code, headers = api_instance.test_webhook_webhooks_management_webhooks_webhook_id_test_post_with_http_info(webhook_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue MailSafePro::ApiError => e
+  puts "Error when calling WebhooksManagementApi->test_webhook_webhooks_management_webhooks_webhook_id_test_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_webhook_webhooks_management_webhooks_webhook_id_patch
+
+> Object update_webhook_webhooks_management_webhooks_webhook_id_patch(webhook_id, webhook_update)
+
+Update Webhook
+
+Update webhook configuration.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mailsafepro'
+# setup authorization
+MailSafePro.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = MailSafePro::WebhooksManagementApi.new
+webhook_id = 'webhook_id_example' # String | 
+webhook_update = MailSafePro::WebhookUpdate.new # WebhookUpdate | 
+
+begin
+  # Update Webhook
+  result = api_instance.update_webhook_webhooks_management_webhooks_webhook_id_patch(webhook_id, webhook_update)
+  p result
+rescue MailSafePro::ApiError => e
+  puts "Error when calling WebhooksManagementApi->update_webhook_webhooks_management_webhooks_webhook_id_patch: #{e}"
+end
+```
+
+#### Using the update_webhook_webhooks_management_webhooks_webhook_id_patch_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> update_webhook_webhooks_management_webhooks_webhook_id_patch_with_http_info(webhook_id, webhook_update)
+
+```ruby
+begin
+  # Update Webhook
+  data, status_code, headers = api_instance.update_webhook_webhooks_management_webhooks_webhook_id_patch_with_http_info(webhook_id, webhook_update)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue MailSafePro::ApiError => e
+  puts "Error when calling WebhooksManagementApi->update_webhook_webhooks_management_webhooks_webhook_id_patch_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook_id** | **String** |  |  |
+| **webhook_update** | [**WebhookUpdate**](WebhookUpdate.md) |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="mailsafepro"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="mailsafepro-ruby"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'