mailsafepro 1.0.0

data/docs/LogsApi.md

@@ -0,0 +1,154 @@
+# MailSafePro::LogsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**clear_request_logs_logs_logs_requests_delete**](LogsApi.md#clear_request_logs_logs_logs_requests_delete) | **DELETE** /logs/logs/requests | Clear Request Logs |
+| [**get_request_logs_logs_logs_requests_get**](LogsApi.md#get_request_logs_logs_logs_requests_get) | **GET** /logs/logs/requests | Get Request Logs |
+
+
+## clear_request_logs_logs_logs_requests_delete
+
+> Object clear_request_logs_logs_logs_requests_delete
+
+Clear Request Logs
+
+Clear all request logs for current 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::LogsApi.new
+
+begin
+  # Clear Request Logs
+  result = api_instance.clear_request_logs_logs_logs_requests_delete
+  p result
+rescue MailSafePro::ApiError => e
+  puts "Error when calling LogsApi->clear_request_logs_logs_logs_requests_delete: #{e}"
+end
+```
+
+#### Using the clear_request_logs_logs_logs_requests_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> clear_request_logs_logs_logs_requests_delete_with_http_info
+
+```ruby
+begin
+  # Clear Request Logs
+  data, status_code, headers = api_instance.clear_request_logs_logs_logs_requests_delete_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue MailSafePro::ApiError => e
+  puts "Error when calling LogsApi->clear_request_logs_logs_logs_requests_delete_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
+
+
+## get_request_logs_logs_logs_requests_get
+
+> Object get_request_logs_logs_logs_requests_get(opts)
+
+Get Request Logs
+
+Get request logs 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::LogsApi.new
+opts = {
+  limit: 56, # Integer | Max results to return
+  status_code: 56, # Integer | Filter by HTTP status code
+  endpoint: 'endpoint_example', # String | Filter by endpoint path
+  method: 'method_example', # String | Filter by HTTP method (GET, POST, etc)
+  since: Time.parse('2013-10-20T19:20:30+01:00') # Time | Filter by timestamp (ISO 8601)
+}
+
+begin
+  # Get Request Logs
+  result = api_instance.get_request_logs_logs_logs_requests_get(opts)
+  p result
+rescue MailSafePro::ApiError => e
+  puts "Error when calling LogsApi->get_request_logs_logs_logs_requests_get: #{e}"
+end
+```
+
+#### Using the get_request_logs_logs_logs_requests_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> get_request_logs_logs_logs_requests_get_with_http_info(opts)
+
+```ruby
+begin
+  # Get Request Logs
+  data, status_code, headers = api_instance.get_request_logs_logs_logs_requests_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue MailSafePro::ApiError => e
+  puts "Error when calling LogsApi->get_request_logs_logs_logs_requests_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | Max results to return | [optional][default to 100] |
+| **status_code** | **Integer** | Filter by HTTP status code | [optional] |
+| **endpoint** | **String** | Filter by endpoint path | [optional] |
+| **method** | **String** | Filter by HTTP method (GET, POST, etc) | [optional] |
+| **since** | **Time** | Filter by timestamp (ISO 8601) | [optional] |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/PlanEnum.md

@@ -0,0 +1,15 @@
+# MailSafePro::PlanEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'mailsafepro'
+
+instance = MailSafePro::PlanEnum.new()
+```
+

data/docs/PriorityEnum.md

@@ -0,0 +1,15 @@
+# MailSafePro::PriorityEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'mailsafepro'
+
+instance = MailSafePro::PriorityEnum.new()
+```
+

data/docs/RegisterEndpoint.md

@@ -0,0 +1,18 @@
+# MailSafePro::RegisterEndpoint
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **callback_url** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'mailsafepro'
+
+instance = MailSafePro::RegisterEndpoint.new(
+  callback_url: null
+)
+```
+

data/docs/ResponseTestNotificationBillingBillingTestNotificationPostValue.md

@@ -0,0 +1,15 @@
+# MailSafePro::ResponseTestNotificationBillingBillingTestNotificationPostValue
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'mailsafepro'
+
+instance = MailSafePro::ResponseTestNotificationBillingBillingTestNotificationPostValue.new()
+```
+

data/docs/RiskLevelEnum.md

@@ -0,0 +1,15 @@
+# MailSafePro::RiskLevelEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'mailsafepro'
+
+instance = MailSafePro::RiskLevelEnum.new()
+```
+

data/docs/RotateSecret.md

@@ -0,0 +1,18 @@
+# MailSafePro::RotateSecret
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **endpoint_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'mailsafepro'
+
+instance = MailSafePro::RotateSecret.new(
+  endpoint_id: null
+)
+```
+

data/docs/SMTPInfo.md

@@ -0,0 +1,26 @@
+# MailSafePro::SMTPInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **checked** | **Boolean** | SMTP check was performed |  |
+| **mailbox_exists** | **Boolean** |  | [optional] |
+| **mx_server** | **String** |  | [optional] |
+| **response_time** | **Float** |  | [optional] |
+| **error_message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mailsafepro'
+
+instance = MailSafePro::SMTPInfo.new(
+  checked: null,
+  mailbox_exists: null,
+  mx_server: null,
+  response_time: null,
+  error_message: null
+)
+```
+

data/docs/SubscriptionResponse.md

@@ -0,0 +1,24 @@
+# MailSafePro::SubscriptionResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **plan** | **String** |  |  |
+| **next_billing_date** | **String** |  | [optional] |
+| **status** | **String** |  | [optional][default to 'active'] |
+| **customer_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mailsafepro'
+
+instance = MailSafePro::SubscriptionResponse.new(
+  plan: null,
+  next_billing_date: null,
+  status: null,
+  customer_id: null
+)
+```
+

data/docs/UserLogin.md

@@ -0,0 +1,20 @@
+# MailSafePro::UserLogin
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | User email address |  |
+| **password** | **String** | User password |  |
+
+## Example
+
+```ruby
+require 'mailsafepro'
+
+instance = MailSafePro::UserLogin.new(
+  email: null,
+  password: null
+)
+```
+

data/docs/UserRegister.md

@@ -0,0 +1,22 @@
+# MailSafePro::UserRegister
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | User email address |  |
+| **password** | **String** | User password |  |
+| **plan** | [**PlanEnum**](PlanEnum.md) | Subscription plan | [optional] |
+
+## Example
+
+```ruby
+require 'mailsafepro'
+
+instance = MailSafePro::UserRegister.new(
+  email: null,
+  password: null,
+  plan: null
+)
+```
+