mailsafepro 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/LICENSE +21 -0
- data/README.md +256 -0
- data/Rakefile +10 -0
- data/docs/APIKeyCreateRequest.md +20 -0
- data/docs/APIKeyListResponse.md +22 -0
- data/docs/APIKeyMeta.md +34 -0
- data/docs/APIKeysApi.md +1241 -0
- data/docs/AuthenticationApi.md +1171 -0
- data/docs/BatchEmailResponse.md +28 -0
- data/docs/BatchValidationRequest.md +26 -0
- data/docs/BillingApi.md +689 -0
- data/docs/BodyChangePlanBillingBillingChangePlanPost.md +18 -0
- data/docs/CheckoutRequest.md +18 -0
- data/docs/CheckoutSessionResponse.md +18 -0
- data/docs/DNSInfo.md +26 -0
- data/docs/DNSRecordDKIM.md +26 -0
- data/docs/DNSRecordDMARC.md +24 -0
- data/docs/DNSRecordSPF.md +24 -0
- data/docs/DefaultApi.md +141 -0
- data/docs/DeveloperToolsApi.md +154 -0
- data/docs/EmailResponse.md +46 -0
- data/docs/EmailValidationApi.md +479 -0
- data/docs/EmailValidationRequest.md +26 -0
- data/docs/HTTPValidationError.md +18 -0
- data/docs/HealthApi.md +937 -0
- data/docs/JobCreateRequest.md +32 -0
- data/docs/JobCreateResponse.md +22 -0
- data/docs/JobResultEntry.md +34 -0
- data/docs/JobResultsPage.md +26 -0
- data/docs/JobStatusResponse.md +28 -0
- data/docs/JobsApi.md +433 -0
- data/docs/KeyRotationRequest.md +22 -0
- data/docs/LogsApi.md +154 -0
- data/docs/PlanEnum.md +15 -0
- data/docs/PriorityEnum.md +15 -0
- data/docs/RegisterEndpoint.md +18 -0
- data/docs/ResponseTestNotificationBillingBillingTestNotificationPostValue.md +15 -0
- data/docs/RiskLevelEnum.md +15 -0
- data/docs/RotateSecret.md +18 -0
- data/docs/SMTPInfo.md +26 -0
- data/docs/SubscriptionResponse.md +24 -0
- data/docs/UserLogin.md +20 -0
- data/docs/UserRegister.md +22 -0
- data/docs/ValidationApi.md +479 -0
- data/docs/ValidationError.md +22 -0
- data/docs/ValidationErrorLocInner.md +15 -0
- data/docs/WebhookCreate.md +24 -0
- data/docs/WebhookResponse.md +22 -0
- data/docs/WebhookUpdate.md +24 -0
- data/docs/WebhooksApi.md +776 -0
- data/docs/WebhooksManagementApi.md +500 -0
- data/git_push.sh +57 -0
- data/lib/mailsafepro/api/api_keys_api.rb +1148 -0
- data/lib/mailsafepro/api/authentication_api.rb +1114 -0
- data/lib/mailsafepro/api/billing_api.rb +670 -0
- data/lib/mailsafepro/api/default_api.rb +149 -0
- data/lib/mailsafepro/api/developer_tools_api.rb +155 -0
- data/lib/mailsafepro/api/email_validation_api.rb +486 -0
- data/lib/mailsafepro/api/health_api.rb +877 -0
- data/lib/mailsafepro/api/jobs_api.rb +452 -0
- data/lib/mailsafepro/api/logs_api.rb +155 -0
- data/lib/mailsafepro/api/validation_api.rb +486 -0
- data/lib/mailsafepro/api/webhooks_api.rb +768 -0
- data/lib/mailsafepro/api/webhooks_management_api.rb +480 -0
- data/lib/mailsafepro/api_client.rb +397 -0
- data/lib/mailsafepro/api_error.rb +58 -0
- data/lib/mailsafepro/api_model_base.rb +88 -0
- data/lib/mailsafepro/configuration.rb +316 -0
- data/lib/mailsafepro/models/api_key_create_request.rb +185 -0
- data/lib/mailsafepro/models/api_key_list_response.rb +240 -0
- data/lib/mailsafepro/models/api_key_meta.rb +338 -0
- data/lib/mailsafepro/models/batch_email_response.rb +348 -0
- data/lib/mailsafepro/models/batch_validation_request.rb +290 -0
- data/lib/mailsafepro/models/body_change_plan_billing_billing_change_plan_post.rb +164 -0
- data/lib/mailsafepro/models/checkout_request.rb +166 -0
- data/lib/mailsafepro/models/checkout_session_response.rb +165 -0
- data/lib/mailsafepro/models/dns_info.rb +193 -0
- data/lib/mailsafepro/models/dns_record_dkim.rb +189 -0
- data/lib/mailsafepro/models/dns_record_dmarc.rb +179 -0
- data/lib/mailsafepro/models/dns_record_spf.rb +179 -0
- data/lib/mailsafepro/models/email_response.rb +454 -0
- data/lib/mailsafepro/models/email_validation_request.rb +252 -0
- data/lib/mailsafepro/models/http_validation_error.rb +149 -0
- data/lib/mailsafepro/models/job_create_request.rb +251 -0
- data/lib/mailsafepro/models/job_create_response.rb +216 -0
- data/lib/mailsafepro/models/job_result_entry.rb +257 -0
- data/lib/mailsafepro/models/job_results_page.rb +270 -0
- data/lib/mailsafepro/models/job_status_response.rb +231 -0
- data/lib/mailsafepro/models/key_rotation_request.rb +269 -0
- data/lib/mailsafepro/models/plan_enum.rb +41 -0
- data/lib/mailsafepro/models/priority_enum.rb +41 -0
- data/lib/mailsafepro/models/register_endpoint.rb +173 -0
- data/lib/mailsafepro/models/response_test_notification_billing_billing_test_notification_post_value.rb +103 -0
- data/lib/mailsafepro/models/risk_level_enum.rb +42 -0
- data/lib/mailsafepro/models/rotate_secret.rb +164 -0
- data/lib/mailsafepro/models/smtp_info.rb +206 -0
- data/lib/mailsafepro/models/subscription_response.rb +196 -0
- data/lib/mailsafepro/models/user_login.rb +211 -0
- data/lib/mailsafepro/models/user_register.rb +243 -0
- data/lib/mailsafepro/models/validation_error.rb +218 -0
- data/lib/mailsafepro/models/validation_error_loc_inner.rb +103 -0
- data/lib/mailsafepro/models/webhook_create.rb +213 -0
- data/lib/mailsafepro/models/webhook_response.rb +185 -0
- data/lib/mailsafepro/models/webhook_update.rb +204 -0
- data/lib/mailsafepro/version.rb +15 -0
- data/lib/mailsafepro.rb +88 -0
- data/mailsafepro.gemspec +39 -0
- data/spec/api/api_keys_api_spec.rb +245 -0
- data/spec/api/authentication_api_spec.rb +239 -0
- data/spec/api/billing_api_spec.rb +155 -0
- data/spec/api/default_api_spec.rb +60 -0
- data/spec/api/developer_tools_api_spec.rb +62 -0
- data/spec/api/email_validation_api_spec.rb +125 -0
- data/spec/api/health_api_spec.rb +200 -0
- data/spec/api/jobs_api_spec.rb +119 -0
- data/spec/api/logs_api_spec.rb +62 -0
- data/spec/api/validation_api_spec.rb +125 -0
- data/spec/api/webhooks_api_spec.rb +172 -0
- data/spec/api/webhooks_management_api_spec.rb +120 -0
- data/spec/models/api_key_create_request_spec.rb +42 -0
- data/spec/models/api_key_list_response_spec.rb +48 -0
- data/spec/models/api_key_meta_spec.rb +84 -0
- data/spec/models/batch_email_response_spec.rb +66 -0
- data/spec/models/batch_validation_request_spec.rb +60 -0
- data/spec/models/body_change_plan_billing_billing_change_plan_post_spec.rb +36 -0
- data/spec/models/checkout_request_spec.rb +36 -0
- data/spec/models/checkout_session_response_spec.rb +36 -0
- data/spec/models/dns_info_spec.rb +60 -0
- data/spec/models/dns_record_dkim_spec.rb +60 -0
- data/spec/models/dns_record_dmarc_spec.rb +54 -0
- data/spec/models/dns_record_spf_spec.rb +54 -0
- data/spec/models/email_response_spec.rb +120 -0
- data/spec/models/email_validation_request_spec.rb +60 -0
- data/spec/models/http_validation_error_spec.rb +36 -0
- data/spec/models/job_create_request_spec.rb +78 -0
- data/spec/models/job_create_response_spec.rb +48 -0
- data/spec/models/job_result_entry_spec.rb +84 -0
- data/spec/models/job_results_page_spec.rb +60 -0
- data/spec/models/job_status_response_spec.rb +66 -0
- data/spec/models/key_rotation_request_spec.rb +48 -0
- data/spec/models/plan_enum_spec.rb +30 -0
- data/spec/models/priority_enum_spec.rb +30 -0
- data/spec/models/register_endpoint_spec.rb +36 -0
- data/spec/models/response_test_notification_billing_billing_test_notification_post_value_spec.rb +21 -0
- data/spec/models/risk_level_enum_spec.rb +30 -0
- data/spec/models/rotate_secret_spec.rb +36 -0
- data/spec/models/smtp_info_spec.rb +60 -0
- data/spec/models/subscription_response_spec.rb +54 -0
- data/spec/models/user_login_spec.rb +42 -0
- data/spec/models/user_register_spec.rb +48 -0
- data/spec/models/validation_error_loc_inner_spec.rb +21 -0
- data/spec/models/validation_error_spec.rb +48 -0
- data/spec/models/webhook_create_spec.rb +54 -0
- data/spec/models/webhook_response_spec.rb +48 -0
- data/spec/models/webhook_update_spec.rb +54 -0
- data/spec/spec_helper.rb +111 -0
- metadata +291 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: c49fa62d110777f876050addb5f3c9d97e2bb2c39d78a4208377b83b8c0c6466
|
|
4
|
+
data.tar.gz: a778c495e584a5ec283a91da874605addf0dfe3bf3139c60dc19aa7bc9afcaaa
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 7513d8d563301f5103d2f7282b507b1a615b95176a00f1c00203da83b8486bc9810efa7245ff2a46a7ce77e347aa5a216fe5beb19c0848a5d1a977f692dd5990
|
|
7
|
+
data.tar.gz: ea9a0f25d92336da4413a7160b0801dc49b92327196bf2e1a813993fc8e74cbd566c90340e000b4df63d031fb3f9aa3eecee2f27bd13c71a52586208f1b5d63e
|
data/Gemfile
ADDED
data/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 MailSafePro
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
data/README.md
ADDED
|
@@ -0,0 +1,256 @@
|
|
|
1
|
+
# mailsafepro
|
|
2
|
+
|
|
3
|
+
MailSafePro - the Ruby gem for the Email Validation API — Enterprise-grade Email Verification
|
|
4
|
+
|
|
5
|
+
API robusta y segura para validación y verificación de correos electrónicos.
|
|
6
|
+
Soporta verificación individual y en lote, detección de brechas, y autenticación JWT.
|
|
7
|
+
Cumple con GDPR y dispone de planes de pago flexibles.
|
|
8
|
+
|
|
9
|
+
**🔗 Enlaces importantes:**
|
|
10
|
+
- [Estado del sistema](https://mailsafepro.betteruptime.com)
|
|
11
|
+
- [Documentación completa](https://email-validation-api-jlra.onrender.com/redoc)
|
|
12
|
+
|
|
13
|
+
**📧 Contacto:** mailsafepro1@gmail.com
|
|
14
|
+
|
|
15
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
16
|
+
|
|
17
|
+
- API version: 2.5.0
|
|
18
|
+
- Package version: 1.0.0
|
|
19
|
+
- Generator version: 7.18.0
|
|
20
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
21
|
+
|
|
22
|
+
## Installation
|
|
23
|
+
|
|
24
|
+
### Build a gem
|
|
25
|
+
|
|
26
|
+
To build the Ruby code into a gem:
|
|
27
|
+
|
|
28
|
+
```shell
|
|
29
|
+
gem build mailsafepro.gemspec
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Then either install the gem locally:
|
|
33
|
+
|
|
34
|
+
```shell
|
|
35
|
+
gem install ./mailsafepro-1.0.0.gem
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
(for development, run `gem install --dev ./mailsafepro-1.0.0.gem` to install the development dependencies)
|
|
39
|
+
|
|
40
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
41
|
+
|
|
42
|
+
Finally add this to the Gemfile:
|
|
43
|
+
|
|
44
|
+
gem 'mailsafepro', '~> 1.0.0'
|
|
45
|
+
|
|
46
|
+
### Install from Git
|
|
47
|
+
|
|
48
|
+
If the Ruby gem is hosted at a git repository: https://github.com/mailsafepro/mailsafepro-ruby, then add the following in the Gemfile:
|
|
49
|
+
|
|
50
|
+
gem 'mailsafepro', :git => 'https://github.com/mailsafepro/mailsafepro-ruby.git'
|
|
51
|
+
|
|
52
|
+
### Include the Ruby code directly
|
|
53
|
+
|
|
54
|
+
Include the Ruby code directly using `-I` as follows:
|
|
55
|
+
|
|
56
|
+
```shell
|
|
57
|
+
ruby -Ilib script.rb
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## Getting Started
|
|
61
|
+
|
|
62
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
|
63
|
+
|
|
64
|
+
```ruby
|
|
65
|
+
# Load the gem
|
|
66
|
+
require 'mailsafepro'
|
|
67
|
+
|
|
68
|
+
# Setup authorization
|
|
69
|
+
MailSafePro.configure do |config|
|
|
70
|
+
# Configure Bearer authorization (JWT): Bearer
|
|
71
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
72
|
+
# Configure a proc to get access tokens in lieu of the static access_token configuration
|
|
73
|
+
config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' }
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
api_instance = MailSafePro::APIKeysApi.new
|
|
77
|
+
api_key_create_request = MailSafePro::APIKeyCreateRequest.new # APIKeyCreateRequest |
|
|
78
|
+
|
|
79
|
+
begin
|
|
80
|
+
#Create Api Key
|
|
81
|
+
result = api_instance.create_api_key_api_keys_post(api_key_create_request)
|
|
82
|
+
p result
|
|
83
|
+
rescue MailSafePro::ApiError => e
|
|
84
|
+
puts "Exception when calling APIKeysApi->create_api_key_api_keys_post: #{e}"
|
|
85
|
+
end
|
|
86
|
+
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## Documentation for API Endpoints
|
|
90
|
+
|
|
91
|
+
All URIs are relative to *http://localhost*
|
|
92
|
+
|
|
93
|
+
Class | Method | HTTP request | Description
|
|
94
|
+
------------ | ------------- | ------------- | -------------
|
|
95
|
+
*MailSafePro::APIKeysApi* | [**create_api_key_api_keys_post**](docs/APIKeysApi.md#create_api_key_api_keys_post) | **POST** /api-keys | Create Api Key
|
|
96
|
+
*MailSafePro::APIKeysApi* | [**create_api_key_api_keys_post_0**](docs/APIKeysApi.md#create_api_key_api_keys_post_0) | **POST** /api-keys | Create Api Key
|
|
97
|
+
*MailSafePro::APIKeysApi* | [**force_sync_api_keys_force_sync_post**](docs/APIKeysApi.md#force_sync_api_keys_force_sync_post) | **POST** /api-keys/force-sync | Force Sync
|
|
98
|
+
*MailSafePro::APIKeysApi* | [**force_sync_api_keys_force_sync_post_0**](docs/APIKeysApi.md#force_sync_api_keys_force_sync_post_0) | **POST** /api-keys/force-sync | Force Sync
|
|
99
|
+
*MailSafePro::APIKeysApi* | [**get_api_key_value_api_keys_key_hash_value_get**](docs/APIKeysApi.md#get_api_key_value_api_keys_key_hash_value_get) | **GET** /api-keys/{key_hash}/value | Get Api Key Value
|
|
100
|
+
*MailSafePro::APIKeysApi* | [**get_api_key_value_api_keys_key_hash_value_get_0**](docs/APIKeysApi.md#get_api_key_value_api_keys_key_hash_value_get_0) | **GET** /api-keys/{key_hash}/value | Get Api Key Value
|
|
101
|
+
*MailSafePro::APIKeysApi* | [**get_usage_api_keys_usage_get**](docs/APIKeysApi.md#get_usage_api_keys_usage_get) | **GET** /api-keys/usage | Get Usage
|
|
102
|
+
*MailSafePro::APIKeysApi* | [**get_usage_api_keys_usage_get_0**](docs/APIKeysApi.md#get_usage_api_keys_usage_get_0) | **GET** /api-keys/usage | Get Usage
|
|
103
|
+
*MailSafePro::APIKeysApi* | [**list_api_keys_api_keys_get**](docs/APIKeysApi.md#list_api_keys_api_keys_get) | **GET** /api-keys | List Api Keys
|
|
104
|
+
*MailSafePro::APIKeysApi* | [**list_api_keys_api_keys_get_0**](docs/APIKeysApi.md#list_api_keys_api_keys_get_0) | **GET** /api-keys | List Api Keys
|
|
105
|
+
*MailSafePro::APIKeysApi* | [**repair_user_data_endpoint_api_keys_repair_data_post**](docs/APIKeysApi.md#repair_user_data_endpoint_api_keys_repair_data_post) | **POST** /api-keys/repair-data | Repair User Data Endpoint
|
|
106
|
+
*MailSafePro::APIKeysApi* | [**repair_user_data_endpoint_api_keys_repair_data_post_0**](docs/APIKeysApi.md#repair_user_data_endpoint_api_keys_repair_data_post_0) | **POST** /api-keys/repair-data | Repair User Data Endpoint
|
|
107
|
+
*MailSafePro::APIKeysApi* | [**revoke_api_key_api_keys_key_hash_revoke_delete**](docs/APIKeysApi.md#revoke_api_key_api_keys_key_hash_revoke_delete) | **DELETE** /api-keys/{key_hash}/revoke | Revoke Api Key
|
|
108
|
+
*MailSafePro::APIKeysApi* | [**revoke_api_key_api_keys_key_hash_revoke_delete_0**](docs/APIKeysApi.md#revoke_api_key_api_keys_key_hash_revoke_delete_0) | **DELETE** /api-keys/{key_hash}/revoke | Revoke Api Key
|
|
109
|
+
*MailSafePro::APIKeysApi* | [**rotate_api_key_api_keys_key_hash_rotate_post**](docs/APIKeysApi.md#rotate_api_key_api_keys_key_hash_rotate_post) | **POST** /api-keys/{key_hash}/rotate | Rotate Api Key
|
|
110
|
+
*MailSafePro::APIKeysApi* | [**rotate_api_key_api_keys_key_hash_rotate_post_0**](docs/APIKeysApi.md#rotate_api_key_api_keys_key_hash_rotate_post_0) | **POST** /api-keys/{key_hash}/rotate | Rotate Api Key
|
|
111
|
+
*MailSafePro::APIKeysApi* | [**sync_plan_keys_api_keys_sync_plan_keys_post**](docs/APIKeysApi.md#sync_plan_keys_api_keys_sync_plan_keys_post) | **POST** /api-keys/sync-plan-keys | Sync Plan Keys
|
|
112
|
+
*MailSafePro::APIKeysApi* | [**sync_plan_keys_api_keys_sync_plan_keys_post_0**](docs/APIKeysApi.md#sync_plan_keys_api_keys_sync_plan_keys_post_0) | **POST** /api-keys/sync-plan-keys | Sync Plan Keys
|
|
113
|
+
*MailSafePro::AuthenticationApi* | [**auth_health_check_auth_health_auth_get**](docs/AuthenticationApi.md#auth_health_check_auth_health_auth_get) | **GET** /auth/health/auth | Auth Health Check
|
|
114
|
+
*MailSafePro::AuthenticationApi* | [**auth_health_check_auth_health_auth_get_0**](docs/AuthenticationApi.md#auth_health_check_auth_health_auth_get_0) | **GET** /auth/health/auth | Auth Health Check
|
|
115
|
+
*MailSafePro::AuthenticationApi* | [**auth_health_check_auth_health_auth_head**](docs/AuthenticationApi.md#auth_health_check_auth_health_auth_head) | **HEAD** /auth/health/auth | Auth Health Check
|
|
116
|
+
*MailSafePro::AuthenticationApi* | [**auth_health_check_auth_health_auth_head_0**](docs/AuthenticationApi.md#auth_health_check_auth_health_auth_head_0) | **HEAD** /auth/health/auth | Auth Health Check
|
|
117
|
+
*MailSafePro::AuthenticationApi* | [**delete_account_auth_delete_delete**](docs/AuthenticationApi.md#delete_account_auth_delete_delete) | **DELETE** /auth/delete | Delete Account
|
|
118
|
+
*MailSafePro::AuthenticationApi* | [**delete_account_auth_delete_delete_0**](docs/AuthenticationApi.md#delete_account_auth_delete_delete_0) | **DELETE** /auth/delete | Delete Account
|
|
119
|
+
*MailSafePro::AuthenticationApi* | [**get_current_user_auth_me_get**](docs/AuthenticationApi.md#get_current_user_auth_me_get) | **GET** /auth/me | Get Current User
|
|
120
|
+
*MailSafePro::AuthenticationApi* | [**get_current_user_auth_me_get_0**](docs/AuthenticationApi.md#get_current_user_auth_me_get_0) | **GET** /auth/me | Get Current User
|
|
121
|
+
*MailSafePro::AuthenticationApi* | [**login_web_user_auth_login_post**](docs/AuthenticationApi.md#login_web_user_auth_login_post) | **POST** /auth/login | Login Web User
|
|
122
|
+
*MailSafePro::AuthenticationApi* | [**login_web_user_auth_login_post_0**](docs/AuthenticationApi.md#login_web_user_auth_login_post_0) | **POST** /auth/login | Login Web User
|
|
123
|
+
*MailSafePro::AuthenticationApi* | [**logout_auth_logout_post**](docs/AuthenticationApi.md#logout_auth_logout_post) | **POST** /auth/logout | Logout
|
|
124
|
+
*MailSafePro::AuthenticationApi* | [**logout_auth_logout_post_0**](docs/AuthenticationApi.md#logout_auth_logout_post_0) | **POST** /auth/logout | Logout
|
|
125
|
+
*MailSafePro::AuthenticationApi* | [**refresh_token_auth_refresh_post**](docs/AuthenticationApi.md#refresh_token_auth_refresh_post) | **POST** /auth/refresh | Refresh Token
|
|
126
|
+
*MailSafePro::AuthenticationApi* | [**refresh_token_auth_refresh_post_0**](docs/AuthenticationApi.md#refresh_token_auth_refresh_post_0) | **POST** /auth/refresh | Refresh Token
|
|
127
|
+
*MailSafePro::AuthenticationApi* | [**register_web_user_auth_register_post**](docs/AuthenticationApi.md#register_web_user_auth_register_post) | **POST** /auth/register | Register Web User
|
|
128
|
+
*MailSafePro::AuthenticationApi* | [**register_web_user_auth_register_post_0**](docs/AuthenticationApi.md#register_web_user_auth_register_post_0) | **POST** /auth/register | Register Web User
|
|
129
|
+
*MailSafePro::AuthenticationApi* | [**rotate_api_key_auth_rotate_key_post**](docs/AuthenticationApi.md#rotate_api_key_auth_rotate_key_post) | **POST** /auth/rotate-key | Rotate Api Key
|
|
130
|
+
*MailSafePro::AuthenticationApi* | [**rotate_api_key_auth_rotate_key_post_0**](docs/AuthenticationApi.md#rotate_api_key_auth_rotate_key_post_0) | **POST** /auth/rotate-key | Rotate Api Key
|
|
131
|
+
*MailSafePro::BillingApi* | [**change_plan_billing_billing_change_plan_post**](docs/BillingApi.md#change_plan_billing_billing_change_plan_post) | **POST** /billing/billing/change-plan | Change Plan
|
|
132
|
+
*MailSafePro::BillingApi* | [**change_plan_billing_billing_change_plan_post_0**](docs/BillingApi.md#change_plan_billing_billing_change_plan_post_0) | **POST** /billing/billing/change-plan | Change Plan
|
|
133
|
+
*MailSafePro::BillingApi* | [**create_checkout_session_billing_billing_create_checkout_session_post**](docs/BillingApi.md#create_checkout_session_billing_billing_create_checkout_session_post) | **POST** /billing/billing/create-checkout-session | Create Checkout Session
|
|
134
|
+
*MailSafePro::BillingApi* | [**create_checkout_session_billing_billing_create_checkout_session_post_0**](docs/BillingApi.md#create_checkout_session_billing_billing_create_checkout_session_post_0) | **POST** /billing/billing/create-checkout-session | Create Checkout Session
|
|
135
|
+
*MailSafePro::BillingApi* | [**get_subscription_billing_billing_subscription_get**](docs/BillingApi.md#get_subscription_billing_billing_subscription_get) | **GET** /billing/billing/subscription | Get Subscription
|
|
136
|
+
*MailSafePro::BillingApi* | [**get_subscription_billing_billing_subscription_get_0**](docs/BillingApi.md#get_subscription_billing_billing_subscription_get_0) | **GET** /billing/billing/subscription | Get Subscription
|
|
137
|
+
*MailSafePro::BillingApi* | [**stripe_webhook_billing_billing_webhook_post**](docs/BillingApi.md#stripe_webhook_billing_billing_webhook_post) | **POST** /billing/billing/webhook | Stripe Webhook
|
|
138
|
+
*MailSafePro::BillingApi* | [**stripe_webhook_billing_billing_webhook_post_0**](docs/BillingApi.md#stripe_webhook_billing_billing_webhook_post_0) | **POST** /billing/billing/webhook | Stripe Webhook
|
|
139
|
+
*MailSafePro::BillingApi* | [**test_notification_billing_billing_test_notification_post**](docs/BillingApi.md#test_notification_billing_billing_test_notification_post) | **POST** /billing/billing/test-notification | Test Notification
|
|
140
|
+
*MailSafePro::BillingApi* | [**test_notification_billing_billing_test_notification_post_0**](docs/BillingApi.md#test_notification_billing_billing_test_notification_post_0) | **POST** /billing/billing/test-notification | Test Notification
|
|
141
|
+
*MailSafePro::DefaultApi* | [**ask_gemini_gemini_get**](docs/DefaultApi.md#ask_gemini_gemini_get) | **GET** /gemini | Ask Gemini
|
|
142
|
+
*MailSafePro::DefaultApi* | [**run_audit_admin_audit_project_post**](docs/DefaultApi.md#run_audit_admin_audit_project_post) | **POST** /admin/audit_project | Run Audit
|
|
143
|
+
*MailSafePro::DeveloperToolsApi* | [**clear_request_logs_logs_logs_requests_delete**](docs/DeveloperToolsApi.md#clear_request_logs_logs_logs_requests_delete) | **DELETE** /logs/logs/requests | Clear Request Logs
|
|
144
|
+
*MailSafePro::DeveloperToolsApi* | [**get_request_logs_logs_logs_requests_get**](docs/DeveloperToolsApi.md#get_request_logs_logs_logs_requests_get) | **GET** /logs/logs/requests | Get Request Logs
|
|
145
|
+
*MailSafePro::EmailValidationApi* | [**batch_validate_emails_validate_batch_post**](docs/EmailValidationApi.md#batch_validate_emails_validate_batch_post) | **POST** /validate/batch | Batch Email Validation
|
|
146
|
+
*MailSafePro::EmailValidationApi* | [**batch_validate_upload_validate_batch_upload_post**](docs/EmailValidationApi.md#batch_validate_upload_validate_batch_upload_post) | **POST** /validate/batch/upload | Batch Email Validation via File Upload
|
|
147
|
+
*MailSafePro::EmailValidationApi* | [**get_cache_stats_validate_stats_cache_get**](docs/EmailValidationApi.md#get_cache_stats_validate_stats_cache_get) | **GET** /validate/stats/cache | Get Cache Stats
|
|
148
|
+
*MailSafePro::EmailValidationApi* | [**get_usage_stats_validate_stats_usage_get**](docs/EmailValidationApi.md#get_usage_stats_validate_stats_usage_get) | **GET** /validate/stats/usage | Get Usage Stats
|
|
149
|
+
*MailSafePro::EmailValidationApi* | [**health_check_validate_health_get**](docs/EmailValidationApi.md#health_check_validate_health_get) | **GET** /validate/health | Health Check
|
|
150
|
+
*MailSafePro::EmailValidationApi* | [**health_check_validate_health_head**](docs/EmailValidationApi.md#health_check_validate_health_head) | **HEAD** /validate/health | Health Check
|
|
151
|
+
*MailSafePro::EmailValidationApi* | [**validate_email_endpoint_validate_email_post**](docs/EmailValidationApi.md#validate_email_endpoint_validate_email_post) | **POST** /validate/email | Validate Email Endpoint
|
|
152
|
+
*MailSafePro::HealthApi* | [**basic_health_health_get**](docs/HealthApi.md#basic_health_health_get) | **GET** /health | Basic health check
|
|
153
|
+
*MailSafePro::HealthApi* | [**basic_health_health_get_0**](docs/HealthApi.md#basic_health_health_get_0) | **GET** /health | Basic health check
|
|
154
|
+
*MailSafePro::HealthApi* | [**circuit_breaker_status_admin_circuit_breaker_status_get**](docs/HealthApi.md#circuit_breaker_status_admin_circuit_breaker_status_get) | **GET** /admin/circuit-breaker-status | Circuit Breaker Status
|
|
155
|
+
*MailSafePro::HealthApi* | [**detailed_health_health_detailed_get**](docs/HealthApi.md#detailed_health_health_detailed_get) | **GET** /health/detailed | Detailed health check
|
|
156
|
+
*MailSafePro::HealthApi* | [**detailed_health_health_detailed_get_0**](docs/HealthApi.md#detailed_health_health_detailed_get_0) | **GET** /health/detailed | Detailed health check
|
|
157
|
+
*MailSafePro::HealthApi* | [**healthcheck_healthcheck_get**](docs/HealthApi.md#healthcheck_healthcheck_get) | **GET** /healthcheck | Healthcheck
|
|
158
|
+
*MailSafePro::HealthApi* | [**healthcheck_healthcheck_head**](docs/HealthApi.md#healthcheck_healthcheck_head) | **HEAD** /healthcheck | Healthcheck
|
|
159
|
+
*MailSafePro::HealthApi* | [**liveness_check_health_liveness_get**](docs/HealthApi.md#liveness_check_health_liveness_get) | **GET** /health/liveness | Liveness Check
|
|
160
|
+
*MailSafePro::HealthApi* | [**liveness_health_live_get**](docs/HealthApi.md#liveness_health_live_get) | **GET** /health/live | Liveness probe (Kubernetes)
|
|
161
|
+
*MailSafePro::HealthApi* | [**liveness_health_live_get_0**](docs/HealthApi.md#liveness_health_live_get_0) | **GET** /health/live | Liveness probe (Kubernetes)
|
|
162
|
+
*MailSafePro::HealthApi* | [**readiness_check_health_readiness_get**](docs/HealthApi.md#readiness_check_health_readiness_get) | **GET** /health/readiness | Readiness Check
|
|
163
|
+
*MailSafePro::HealthApi* | [**readiness_health_ready_get**](docs/HealthApi.md#readiness_health_ready_get) | **GET** /health/ready | Readiness probe (Kubernetes)
|
|
164
|
+
*MailSafePro::HealthApi* | [**readiness_health_ready_get_0**](docs/HealthApi.md#readiness_health_ready_get_0) | **GET** /health/ready | Readiness probe (Kubernetes)
|
|
165
|
+
*MailSafePro::HealthApi* | [**service_status_status_get**](docs/HealthApi.md#service_status_status_get) | **GET** /status | Service Status
|
|
166
|
+
*MailSafePro::HealthApi* | [**startup_check_health_startup_get**](docs/HealthApi.md#startup_check_health_startup_get) | **GET** /health/startup | Startup Check
|
|
167
|
+
*MailSafePro::JobsApi* | [**create_job_jobs_v1_jobs_post**](docs/JobsApi.md#create_job_jobs_v1_jobs_post) | **POST** /jobs/v1/jobs | Create validation job
|
|
168
|
+
*MailSafePro::JobsApi* | [**create_job_jobs_v1_jobs_post_0**](docs/JobsApi.md#create_job_jobs_v1_jobs_post_0) | **POST** /jobs/v1/jobs | Create validation job
|
|
169
|
+
*MailSafePro::JobsApi* | [**get_job_results_jobs_v1_jobs_job_id_results_get**](docs/JobsApi.md#get_job_results_jobs_v1_jobs_job_id_results_get) | **GET** /jobs/v1/jobs/{job_id}/results | Get job results (paged)
|
|
170
|
+
*MailSafePro::JobsApi* | [**get_job_results_jobs_v1_jobs_job_id_results_get_0**](docs/JobsApi.md#get_job_results_jobs_v1_jobs_job_id_results_get_0) | **GET** /jobs/v1/jobs/{job_id}/results | Get job results (paged)
|
|
171
|
+
*MailSafePro::JobsApi* | [**get_job_status_jobs_v1_jobs_job_id_get**](docs/JobsApi.md#get_job_status_jobs_v1_jobs_job_id_get) | **GET** /jobs/v1/jobs/{job_id} | Get job status
|
|
172
|
+
*MailSafePro::JobsApi* | [**get_job_status_jobs_v1_jobs_job_id_get_0**](docs/JobsApi.md#get_job_status_jobs_v1_jobs_job_id_get_0) | **GET** /jobs/v1/jobs/{job_id} | Get job status
|
|
173
|
+
*MailSafePro::LogsApi* | [**clear_request_logs_logs_logs_requests_delete**](docs/LogsApi.md#clear_request_logs_logs_logs_requests_delete) | **DELETE** /logs/logs/requests | Clear Request Logs
|
|
174
|
+
*MailSafePro::LogsApi* | [**get_request_logs_logs_logs_requests_get**](docs/LogsApi.md#get_request_logs_logs_logs_requests_get) | **GET** /logs/logs/requests | Get Request Logs
|
|
175
|
+
*MailSafePro::ValidationApi* | [**batch_validate_emails_validate_batch_post**](docs/ValidationApi.md#batch_validate_emails_validate_batch_post) | **POST** /validate/batch | Batch Email Validation
|
|
176
|
+
*MailSafePro::ValidationApi* | [**batch_validate_upload_validate_batch_upload_post**](docs/ValidationApi.md#batch_validate_upload_validate_batch_upload_post) | **POST** /validate/batch/upload | Batch Email Validation via File Upload
|
|
177
|
+
*MailSafePro::ValidationApi* | [**get_cache_stats_validate_stats_cache_get**](docs/ValidationApi.md#get_cache_stats_validate_stats_cache_get) | **GET** /validate/stats/cache | Get Cache Stats
|
|
178
|
+
*MailSafePro::ValidationApi* | [**get_usage_stats_validate_stats_usage_get**](docs/ValidationApi.md#get_usage_stats_validate_stats_usage_get) | **GET** /validate/stats/usage | Get Usage Stats
|
|
179
|
+
*MailSafePro::ValidationApi* | [**health_check_validate_health_get**](docs/ValidationApi.md#health_check_validate_health_get) | **GET** /validate/health | Health Check
|
|
180
|
+
*MailSafePro::ValidationApi* | [**health_check_validate_health_head**](docs/ValidationApi.md#health_check_validate_health_head) | **HEAD** /validate/health | Health Check
|
|
181
|
+
*MailSafePro::ValidationApi* | [**validate_email_endpoint_validate_email_post**](docs/ValidationApi.md#validate_email_endpoint_validate_email_post) | **POST** /validate/email | Validate Email Endpoint
|
|
182
|
+
*MailSafePro::WebhooksApi* | [**create_webhook_webhooks_management_webhooks_post**](docs/WebhooksApi.md#create_webhook_webhooks_management_webhooks_post) | **POST** /webhooks-management/webhooks/ | Create Webhook
|
|
183
|
+
*MailSafePro::WebhooksApi* | [**delete_webhook_webhooks_management_webhooks_webhook_id_delete**](docs/WebhooksApi.md#delete_webhook_webhooks_management_webhooks_webhook_id_delete) | **DELETE** /webhooks-management/webhooks/{webhook_id} | Delete Webhook
|
|
184
|
+
*MailSafePro::WebhooksApi* | [**get_deliveries_webhooks_management_webhooks_webhook_id_deliveries_get**](docs/WebhooksApi.md#get_deliveries_webhooks_management_webhooks_webhook_id_deliveries_get) | **GET** /webhooks-management/webhooks/{webhook_id}/deliveries | Get Deliveries
|
|
185
|
+
*MailSafePro::WebhooksApi* | [**get_webhook_webhooks_management_webhooks_webhook_id_get**](docs/WebhooksApi.md#get_webhook_webhooks_management_webhooks_webhook_id_get) | **GET** /webhooks-management/webhooks/{webhook_id} | Get Webhook
|
|
186
|
+
*MailSafePro::WebhooksApi* | [**list_webhooks_webhooks_management_webhooks_get**](docs/WebhooksApi.md#list_webhooks_webhooks_management_webhooks_get) | **GET** /webhooks-management/webhooks/ | List Webhooks
|
|
187
|
+
*MailSafePro::WebhooksApi* | [**register_endpoint_webhooks_v1_webhooks_endpoints_register_post**](docs/WebhooksApi.md#register_endpoint_webhooks_v1_webhooks_endpoints_register_post) | **POST** /webhooks/v1/webhooks/endpoints/register | Register Endpoint
|
|
188
|
+
*MailSafePro::WebhooksApi* | [**register_endpoint_webhooks_v1_webhooks_endpoints_register_post_0**](docs/WebhooksApi.md#register_endpoint_webhooks_v1_webhooks_endpoints_register_post_0) | **POST** /webhooks/v1/webhooks/endpoints/register | Register Endpoint
|
|
189
|
+
*MailSafePro::WebhooksApi* | [**rotate_secret_webhooks_v1_webhooks_endpoints_rotate_post**](docs/WebhooksApi.md#rotate_secret_webhooks_v1_webhooks_endpoints_rotate_post) | **POST** /webhooks/v1/webhooks/endpoints/rotate | Rotate Secret
|
|
190
|
+
*MailSafePro::WebhooksApi* | [**rotate_secret_webhooks_v1_webhooks_endpoints_rotate_post_0**](docs/WebhooksApi.md#rotate_secret_webhooks_v1_webhooks_endpoints_rotate_post_0) | **POST** /webhooks/v1/webhooks/endpoints/rotate | Rotate Secret
|
|
191
|
+
*MailSafePro::WebhooksApi* | [**test_webhook_webhooks_management_webhooks_webhook_id_test_post**](docs/WebhooksApi.md#test_webhook_webhooks_management_webhooks_webhook_id_test_post) | **POST** /webhooks-management/webhooks/{webhook_id}/test | Test Webhook
|
|
192
|
+
*MailSafePro::WebhooksApi* | [**update_webhook_webhooks_management_webhooks_webhook_id_patch**](docs/WebhooksApi.md#update_webhook_webhooks_management_webhooks_webhook_id_patch) | **PATCH** /webhooks-management/webhooks/{webhook_id} | Update Webhook
|
|
193
|
+
*MailSafePro::WebhooksManagementApi* | [**create_webhook_webhooks_management_webhooks_post**](docs/WebhooksManagementApi.md#create_webhook_webhooks_management_webhooks_post) | **POST** /webhooks-management/webhooks/ | Create Webhook
|
|
194
|
+
*MailSafePro::WebhooksManagementApi* | [**delete_webhook_webhooks_management_webhooks_webhook_id_delete**](docs/WebhooksManagementApi.md#delete_webhook_webhooks_management_webhooks_webhook_id_delete) | **DELETE** /webhooks-management/webhooks/{webhook_id} | Delete Webhook
|
|
195
|
+
*MailSafePro::WebhooksManagementApi* | [**get_deliveries_webhooks_management_webhooks_webhook_id_deliveries_get**](docs/WebhooksManagementApi.md#get_deliveries_webhooks_management_webhooks_webhook_id_deliveries_get) | **GET** /webhooks-management/webhooks/{webhook_id}/deliveries | Get Deliveries
|
|
196
|
+
*MailSafePro::WebhooksManagementApi* | [**get_webhook_webhooks_management_webhooks_webhook_id_get**](docs/WebhooksManagementApi.md#get_webhook_webhooks_management_webhooks_webhook_id_get) | **GET** /webhooks-management/webhooks/{webhook_id} | Get Webhook
|
|
197
|
+
*MailSafePro::WebhooksManagementApi* | [**list_webhooks_webhooks_management_webhooks_get**](docs/WebhooksManagementApi.md#list_webhooks_webhooks_management_webhooks_get) | **GET** /webhooks-management/webhooks/ | List Webhooks
|
|
198
|
+
*MailSafePro::WebhooksManagementApi* | [**test_webhook_webhooks_management_webhooks_webhook_id_test_post**](docs/WebhooksManagementApi.md#test_webhook_webhooks_management_webhooks_webhook_id_test_post) | **POST** /webhooks-management/webhooks/{webhook_id}/test | Test Webhook
|
|
199
|
+
*MailSafePro::WebhooksManagementApi* | [**update_webhook_webhooks_management_webhooks_webhook_id_patch**](docs/WebhooksManagementApi.md#update_webhook_webhooks_management_webhooks_webhook_id_patch) | **PATCH** /webhooks-management/webhooks/{webhook_id} | Update Webhook
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
## Documentation for Models
|
|
203
|
+
|
|
204
|
+
- [MailSafePro::APIKeyCreateRequest](docs/APIKeyCreateRequest.md)
|
|
205
|
+
- [MailSafePro::APIKeyListResponse](docs/APIKeyListResponse.md)
|
|
206
|
+
- [MailSafePro::APIKeyMeta](docs/APIKeyMeta.md)
|
|
207
|
+
- [MailSafePro::BatchEmailResponse](docs/BatchEmailResponse.md)
|
|
208
|
+
- [MailSafePro::BatchValidationRequest](docs/BatchValidationRequest.md)
|
|
209
|
+
- [MailSafePro::BodyChangePlanBillingBillingChangePlanPost](docs/BodyChangePlanBillingBillingChangePlanPost.md)
|
|
210
|
+
- [MailSafePro::CheckoutRequest](docs/CheckoutRequest.md)
|
|
211
|
+
- [MailSafePro::CheckoutSessionResponse](docs/CheckoutSessionResponse.md)
|
|
212
|
+
- [MailSafePro::DNSInfo](docs/DNSInfo.md)
|
|
213
|
+
- [MailSafePro::DNSRecordDKIM](docs/DNSRecordDKIM.md)
|
|
214
|
+
- [MailSafePro::DNSRecordDMARC](docs/DNSRecordDMARC.md)
|
|
215
|
+
- [MailSafePro::DNSRecordSPF](docs/DNSRecordSPF.md)
|
|
216
|
+
- [MailSafePro::EmailResponse](docs/EmailResponse.md)
|
|
217
|
+
- [MailSafePro::EmailValidationRequest](docs/EmailValidationRequest.md)
|
|
218
|
+
- [MailSafePro::HTTPValidationError](docs/HTTPValidationError.md)
|
|
219
|
+
- [MailSafePro::JobCreateRequest](docs/JobCreateRequest.md)
|
|
220
|
+
- [MailSafePro::JobCreateResponse](docs/JobCreateResponse.md)
|
|
221
|
+
- [MailSafePro::JobResultEntry](docs/JobResultEntry.md)
|
|
222
|
+
- [MailSafePro::JobResultsPage](docs/JobResultsPage.md)
|
|
223
|
+
- [MailSafePro::JobStatusResponse](docs/JobStatusResponse.md)
|
|
224
|
+
- [MailSafePro::KeyRotationRequest](docs/KeyRotationRequest.md)
|
|
225
|
+
- [MailSafePro::PlanEnum](docs/PlanEnum.md)
|
|
226
|
+
- [MailSafePro::PriorityEnum](docs/PriorityEnum.md)
|
|
227
|
+
- [MailSafePro::RegisterEndpoint](docs/RegisterEndpoint.md)
|
|
228
|
+
- [MailSafePro::ResponseTestNotificationBillingBillingTestNotificationPostValue](docs/ResponseTestNotificationBillingBillingTestNotificationPostValue.md)
|
|
229
|
+
- [MailSafePro::RiskLevelEnum](docs/RiskLevelEnum.md)
|
|
230
|
+
- [MailSafePro::RotateSecret](docs/RotateSecret.md)
|
|
231
|
+
- [MailSafePro::SMTPInfo](docs/SMTPInfo.md)
|
|
232
|
+
- [MailSafePro::SubscriptionResponse](docs/SubscriptionResponse.md)
|
|
233
|
+
- [MailSafePro::UserLogin](docs/UserLogin.md)
|
|
234
|
+
- [MailSafePro::UserRegister](docs/UserRegister.md)
|
|
235
|
+
- [MailSafePro::ValidationError](docs/ValidationError.md)
|
|
236
|
+
- [MailSafePro::ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
|
|
237
|
+
- [MailSafePro::WebhookCreate](docs/WebhookCreate.md)
|
|
238
|
+
- [MailSafePro::WebhookResponse](docs/WebhookResponse.md)
|
|
239
|
+
- [MailSafePro::WebhookUpdate](docs/WebhookUpdate.md)
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
## Documentation for Authorization
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
Authentication schemes defined for the API:
|
|
246
|
+
### Bearer
|
|
247
|
+
|
|
248
|
+
- **Type**: Bearer authentication (JWT)
|
|
249
|
+
|
|
250
|
+
### ApiKeyAuth
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
- **Type**: API key
|
|
254
|
+
- **API key parameter name**: X-API-Key
|
|
255
|
+
- **Location**: HTTP header
|
|
256
|
+
|
data/Rakefile
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# MailSafePro::APIKeyCreateRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | | [optional] |
|
|
8
|
+
| **scopes** | **Array<String>** | Access scopes for the API Key | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'mailsafepro'
|
|
14
|
+
|
|
15
|
+
instance = MailSafePro::APIKeyCreateRequest.new(
|
|
16
|
+
name: null,
|
|
17
|
+
scopes: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# MailSafePro::APIKeyListResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **keys** | [**Array<APIKeyMeta>**](APIKeyMeta.md) | List of API keys | |
|
|
8
|
+
| **total_count** | **Integer** | Total number of keys | |
|
|
9
|
+
| **active_count** | **Integer** | Number of active keys | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'mailsafepro'
|
|
15
|
+
|
|
16
|
+
instance = MailSafePro::APIKeyListResponse.new(
|
|
17
|
+
keys: null,
|
|
18
|
+
total_count: null,
|
|
19
|
+
active_count: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/APIKeyMeta.md
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# MailSafePro::APIKeyMeta
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique key identifier | |
|
|
8
|
+
| **key_hash** | **String** | Hashed key value | |
|
|
9
|
+
| **plan** | [**PlanEnum**](PlanEnum.md) | Associated plan | |
|
|
10
|
+
| **created_at** | **Time** | Creation timestamp | |
|
|
11
|
+
| **revoked** | **Boolean** | Revocation status | |
|
|
12
|
+
| **revoked_at** | **Time** | | [optional] |
|
|
13
|
+
| **scopes** | **Array<String>** | Access scopes | [optional] |
|
|
14
|
+
| **name** | **String** | | [optional] |
|
|
15
|
+
| **last_used** | **Time** | | [optional] |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'mailsafepro'
|
|
21
|
+
|
|
22
|
+
instance = MailSafePro::APIKeyMeta.new(
|
|
23
|
+
id: null,
|
|
24
|
+
key_hash: null,
|
|
25
|
+
plan: null,
|
|
26
|
+
created_at: null,
|
|
27
|
+
revoked: null,
|
|
28
|
+
revoked_at: null,
|
|
29
|
+
scopes: null,
|
|
30
|
+
name: null,
|
|
31
|
+
last_used: null
|
|
32
|
+
)
|
|
33
|
+
```
|
|
34
|
+
|