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
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# MailSafePro::CheckoutRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **plan** | **String** | Plan: PREMIUM o ENTERPRISE | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'mailsafepro'
|
|
13
|
+
|
|
14
|
+
instance = MailSafePro::CheckoutRequest.new(
|
|
15
|
+
plan: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# MailSafePro::CheckoutSessionResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **session_id** | **String** | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'mailsafepro'
|
|
13
|
+
|
|
14
|
+
instance = MailSafePro::CheckoutSessionResponse.new(
|
|
15
|
+
session_id: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
data/docs/DNSInfo.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# MailSafePro::DNSInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **spf** | [**DNSRecordSPF**](DNSRecordSPF.md) | | [optional] |
|
|
8
|
+
| **dkim** | [**DNSRecordDKIM**](DNSRecordDKIM.md) | | [optional] |
|
|
9
|
+
| **dmarc** | [**DNSRecordDMARC**](DNSRecordDMARC.md) | | [optional] |
|
|
10
|
+
| **mx_records** | **Array<String>** | MX records | [optional] |
|
|
11
|
+
| **ns_records** | **Array<String>** | Name servers | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'mailsafepro'
|
|
17
|
+
|
|
18
|
+
instance = MailSafePro::DNSInfo.new(
|
|
19
|
+
spf: null,
|
|
20
|
+
dkim: null,
|
|
21
|
+
dmarc: null,
|
|
22
|
+
mx_records: null,
|
|
23
|
+
ns_records: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# MailSafePro::DNSRecordDKIM
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **status** | **String** | | [optional] |
|
|
8
|
+
| **selector** | **String** | | [optional] |
|
|
9
|
+
| **key_type** | **String** | | [optional] |
|
|
10
|
+
| **key_length** | **Integer** | | [optional] |
|
|
11
|
+
| **record** | **String** | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'mailsafepro'
|
|
17
|
+
|
|
18
|
+
instance = MailSafePro::DNSRecordDKIM.new(
|
|
19
|
+
status: null,
|
|
20
|
+
selector: null,
|
|
21
|
+
key_type: null,
|
|
22
|
+
key_length: null,
|
|
23
|
+
record: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# MailSafePro::DNSRecordDMARC
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **status** | **String** | | [optional] |
|
|
8
|
+
| **policy** | **String** | | [optional] |
|
|
9
|
+
| **record** | **String** | | [optional] |
|
|
10
|
+
| **pct** | **Integer** | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'mailsafepro'
|
|
16
|
+
|
|
17
|
+
instance = MailSafePro::DNSRecordDMARC.new(
|
|
18
|
+
status: null,
|
|
19
|
+
policy: null,
|
|
20
|
+
record: null,
|
|
21
|
+
pct: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# MailSafePro::DNSRecordSPF
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **status** | **String** | | [optional] |
|
|
8
|
+
| **record** | **String** | | [optional] |
|
|
9
|
+
| **mechanism** | **String** | | [optional] |
|
|
10
|
+
| **domain** | **String** | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'mailsafepro'
|
|
16
|
+
|
|
17
|
+
instance = MailSafePro::DNSRecordSPF.new(
|
|
18
|
+
status: null,
|
|
19
|
+
record: null,
|
|
20
|
+
mechanism: null,
|
|
21
|
+
domain: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
data/docs/DefaultApi.md
ADDED
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
# MailSafePro::DefaultApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**ask_gemini_gemini_get**](DefaultApi.md#ask_gemini_gemini_get) | **GET** /gemini | Ask Gemini |
|
|
8
|
+
| [**run_audit_admin_audit_project_post**](DefaultApi.md#run_audit_admin_audit_project_post) | **POST** /admin/audit_project | Run Audit |
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## ask_gemini_gemini_get
|
|
12
|
+
|
|
13
|
+
> Object ask_gemini_gemini_get(prompt)
|
|
14
|
+
|
|
15
|
+
Ask Gemini
|
|
16
|
+
|
|
17
|
+
Llama a Gemini para generar texto a partir de un prompt
|
|
18
|
+
|
|
19
|
+
### Examples
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'time'
|
|
23
|
+
require 'mailsafepro'
|
|
24
|
+
|
|
25
|
+
api_instance = MailSafePro::DefaultApi.new
|
|
26
|
+
prompt = 'prompt_example' # String |
|
|
27
|
+
|
|
28
|
+
begin
|
|
29
|
+
# Ask Gemini
|
|
30
|
+
result = api_instance.ask_gemini_gemini_get(prompt)
|
|
31
|
+
p result
|
|
32
|
+
rescue MailSafePro::ApiError => e
|
|
33
|
+
puts "Error when calling DefaultApi->ask_gemini_gemini_get: #{e}"
|
|
34
|
+
end
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
#### Using the ask_gemini_gemini_get_with_http_info variant
|
|
38
|
+
|
|
39
|
+
This returns an Array which contains the response data, status code and headers.
|
|
40
|
+
|
|
41
|
+
> <Array(Object, Integer, Hash)> ask_gemini_gemini_get_with_http_info(prompt)
|
|
42
|
+
|
|
43
|
+
```ruby
|
|
44
|
+
begin
|
|
45
|
+
# Ask Gemini
|
|
46
|
+
data, status_code, headers = api_instance.ask_gemini_gemini_get_with_http_info(prompt)
|
|
47
|
+
p status_code # => 2xx
|
|
48
|
+
p headers # => { ... }
|
|
49
|
+
p data # => Object
|
|
50
|
+
rescue MailSafePro::ApiError => e
|
|
51
|
+
puts "Error when calling DefaultApi->ask_gemini_gemini_get_with_http_info: #{e}"
|
|
52
|
+
end
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Parameters
|
|
56
|
+
|
|
57
|
+
| Name | Type | Description | Notes |
|
|
58
|
+
| ---- | ---- | ----------- | ----- |
|
|
59
|
+
| **prompt** | **String** | | |
|
|
60
|
+
|
|
61
|
+
### Return type
|
|
62
|
+
|
|
63
|
+
**Object**
|
|
64
|
+
|
|
65
|
+
### Authorization
|
|
66
|
+
|
|
67
|
+
No authorization required
|
|
68
|
+
|
|
69
|
+
### HTTP request headers
|
|
70
|
+
|
|
71
|
+
- **Content-Type**: Not defined
|
|
72
|
+
- **Accept**: application/json
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
## run_audit_admin_audit_project_post
|
|
76
|
+
|
|
77
|
+
> Object run_audit_admin_audit_project_post(opts)
|
|
78
|
+
|
|
79
|
+
Run Audit
|
|
80
|
+
|
|
81
|
+
Lanza auditoría en path (ruta absoluta o relativa a la raíz del proyecto). Header obligatorio: X-Audit-Token: <AUDIT_SECRET>
|
|
82
|
+
|
|
83
|
+
### Examples
|
|
84
|
+
|
|
85
|
+
```ruby
|
|
86
|
+
require 'time'
|
|
87
|
+
require 'mailsafepro'
|
|
88
|
+
|
|
89
|
+
api_instance = MailSafePro::DefaultApi.new
|
|
90
|
+
opts = {
|
|
91
|
+
path: 'path_example', # String |
|
|
92
|
+
x_audit_token: 'x_audit_token_example' # String |
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
begin
|
|
96
|
+
# Run Audit
|
|
97
|
+
result = api_instance.run_audit_admin_audit_project_post(opts)
|
|
98
|
+
p result
|
|
99
|
+
rescue MailSafePro::ApiError => e
|
|
100
|
+
puts "Error when calling DefaultApi->run_audit_admin_audit_project_post: #{e}"
|
|
101
|
+
end
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
#### Using the run_audit_admin_audit_project_post_with_http_info variant
|
|
105
|
+
|
|
106
|
+
This returns an Array which contains the response data, status code and headers.
|
|
107
|
+
|
|
108
|
+
> <Array(Object, Integer, Hash)> run_audit_admin_audit_project_post_with_http_info(opts)
|
|
109
|
+
|
|
110
|
+
```ruby
|
|
111
|
+
begin
|
|
112
|
+
# Run Audit
|
|
113
|
+
data, status_code, headers = api_instance.run_audit_admin_audit_project_post_with_http_info(opts)
|
|
114
|
+
p status_code # => 2xx
|
|
115
|
+
p headers # => { ... }
|
|
116
|
+
p data # => Object
|
|
117
|
+
rescue MailSafePro::ApiError => e
|
|
118
|
+
puts "Error when calling DefaultApi->run_audit_admin_audit_project_post_with_http_info: #{e}"
|
|
119
|
+
end
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### Parameters
|
|
123
|
+
|
|
124
|
+
| Name | Type | Description | Notes |
|
|
125
|
+
| ---- | ---- | ----------- | ----- |
|
|
126
|
+
| **path** | **String** | | [optional][default to '.'] |
|
|
127
|
+
| **x_audit_token** | **String** | | [optional] |
|
|
128
|
+
|
|
129
|
+
### Return type
|
|
130
|
+
|
|
131
|
+
**Object**
|
|
132
|
+
|
|
133
|
+
### Authorization
|
|
134
|
+
|
|
135
|
+
No authorization required
|
|
136
|
+
|
|
137
|
+
### HTTP request headers
|
|
138
|
+
|
|
139
|
+
- **Content-Type**: Not defined
|
|
140
|
+
- **Accept**: application/json
|
|
141
|
+
|
|
@@ -0,0 +1,154 @@
|
|
|
1
|
+
# MailSafePro::DeveloperToolsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**clear_request_logs_logs_logs_requests_delete**](DeveloperToolsApi.md#clear_request_logs_logs_logs_requests_delete) | **DELETE** /logs/logs/requests | Clear Request Logs |
|
|
8
|
+
| [**get_request_logs_logs_logs_requests_get**](DeveloperToolsApi.md#get_request_logs_logs_logs_requests_get) | **GET** /logs/logs/requests | Get Request Logs |
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## clear_request_logs_logs_logs_requests_delete
|
|
12
|
+
|
|
13
|
+
> Object clear_request_logs_logs_logs_requests_delete
|
|
14
|
+
|
|
15
|
+
Clear Request Logs
|
|
16
|
+
|
|
17
|
+
Clear all request logs for current user.
|
|
18
|
+
|
|
19
|
+
### Examples
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'time'
|
|
23
|
+
require 'mailsafepro'
|
|
24
|
+
# setup authorization
|
|
25
|
+
MailSafePro.configure do |config|
|
|
26
|
+
# Configure Bearer authorization (JWT): Bearer
|
|
27
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
api_instance = MailSafePro::DeveloperToolsApi.new
|
|
31
|
+
|
|
32
|
+
begin
|
|
33
|
+
# Clear Request Logs
|
|
34
|
+
result = api_instance.clear_request_logs_logs_logs_requests_delete
|
|
35
|
+
p result
|
|
36
|
+
rescue MailSafePro::ApiError => e
|
|
37
|
+
puts "Error when calling DeveloperToolsApi->clear_request_logs_logs_logs_requests_delete: #{e}"
|
|
38
|
+
end
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
#### Using the clear_request_logs_logs_logs_requests_delete_with_http_info variant
|
|
42
|
+
|
|
43
|
+
This returns an Array which contains the response data, status code and headers.
|
|
44
|
+
|
|
45
|
+
> <Array(Object, Integer, Hash)> clear_request_logs_logs_logs_requests_delete_with_http_info
|
|
46
|
+
|
|
47
|
+
```ruby
|
|
48
|
+
begin
|
|
49
|
+
# Clear Request Logs
|
|
50
|
+
data, status_code, headers = api_instance.clear_request_logs_logs_logs_requests_delete_with_http_info
|
|
51
|
+
p status_code # => 2xx
|
|
52
|
+
p headers # => { ... }
|
|
53
|
+
p data # => Object
|
|
54
|
+
rescue MailSafePro::ApiError => e
|
|
55
|
+
puts "Error when calling DeveloperToolsApi->clear_request_logs_logs_logs_requests_delete_with_http_info: #{e}"
|
|
56
|
+
end
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### Parameters
|
|
60
|
+
|
|
61
|
+
This endpoint does not need any parameter.
|
|
62
|
+
|
|
63
|
+
### Return type
|
|
64
|
+
|
|
65
|
+
**Object**
|
|
66
|
+
|
|
67
|
+
### Authorization
|
|
68
|
+
|
|
69
|
+
[Bearer](../README.md#Bearer)
|
|
70
|
+
|
|
71
|
+
### HTTP request headers
|
|
72
|
+
|
|
73
|
+
- **Content-Type**: Not defined
|
|
74
|
+
- **Accept**: application/json
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
## get_request_logs_logs_logs_requests_get
|
|
78
|
+
|
|
79
|
+
> Object get_request_logs_logs_logs_requests_get(opts)
|
|
80
|
+
|
|
81
|
+
Get Request Logs
|
|
82
|
+
|
|
83
|
+
Get request logs for authenticated user.
|
|
84
|
+
|
|
85
|
+
### Examples
|
|
86
|
+
|
|
87
|
+
```ruby
|
|
88
|
+
require 'time'
|
|
89
|
+
require 'mailsafepro'
|
|
90
|
+
# setup authorization
|
|
91
|
+
MailSafePro.configure do |config|
|
|
92
|
+
# Configure Bearer authorization (JWT): Bearer
|
|
93
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
94
|
+
end
|
|
95
|
+
|
|
96
|
+
api_instance = MailSafePro::DeveloperToolsApi.new
|
|
97
|
+
opts = {
|
|
98
|
+
limit: 56, # Integer | Max results to return
|
|
99
|
+
status_code: 56, # Integer | Filter by HTTP status code
|
|
100
|
+
endpoint: 'endpoint_example', # String | Filter by endpoint path
|
|
101
|
+
method: 'method_example', # String | Filter by HTTP method (GET, POST, etc)
|
|
102
|
+
since: Time.parse('2013-10-20T19:20:30+01:00') # Time | Filter by timestamp (ISO 8601)
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
begin
|
|
106
|
+
# Get Request Logs
|
|
107
|
+
result = api_instance.get_request_logs_logs_logs_requests_get(opts)
|
|
108
|
+
p result
|
|
109
|
+
rescue MailSafePro::ApiError => e
|
|
110
|
+
puts "Error when calling DeveloperToolsApi->get_request_logs_logs_logs_requests_get: #{e}"
|
|
111
|
+
end
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
#### Using the get_request_logs_logs_logs_requests_get_with_http_info variant
|
|
115
|
+
|
|
116
|
+
This returns an Array which contains the response data, status code and headers.
|
|
117
|
+
|
|
118
|
+
> <Array(Object, Integer, Hash)> get_request_logs_logs_logs_requests_get_with_http_info(opts)
|
|
119
|
+
|
|
120
|
+
```ruby
|
|
121
|
+
begin
|
|
122
|
+
# Get Request Logs
|
|
123
|
+
data, status_code, headers = api_instance.get_request_logs_logs_logs_requests_get_with_http_info(opts)
|
|
124
|
+
p status_code # => 2xx
|
|
125
|
+
p headers # => { ... }
|
|
126
|
+
p data # => Object
|
|
127
|
+
rescue MailSafePro::ApiError => e
|
|
128
|
+
puts "Error when calling DeveloperToolsApi->get_request_logs_logs_logs_requests_get_with_http_info: #{e}"
|
|
129
|
+
end
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
### Parameters
|
|
133
|
+
|
|
134
|
+
| Name | Type | Description | Notes |
|
|
135
|
+
| ---- | ---- | ----------- | ----- |
|
|
136
|
+
| **limit** | **Integer** | Max results to return | [optional][default to 100] |
|
|
137
|
+
| **status_code** | **Integer** | Filter by HTTP status code | [optional] |
|
|
138
|
+
| **endpoint** | **String** | Filter by endpoint path | [optional] |
|
|
139
|
+
| **method** | **String** | Filter by HTTP method (GET, POST, etc) | [optional] |
|
|
140
|
+
| **since** | **Time** | Filter by timestamp (ISO 8601) | [optional] |
|
|
141
|
+
|
|
142
|
+
### Return type
|
|
143
|
+
|
|
144
|
+
**Object**
|
|
145
|
+
|
|
146
|
+
### Authorization
|
|
147
|
+
|
|
148
|
+
[Bearer](../README.md#Bearer)
|
|
149
|
+
|
|
150
|
+
### HTTP request headers
|
|
151
|
+
|
|
152
|
+
- **Content-Type**: Not defined
|
|
153
|
+
- **Accept**: application/json
|
|
154
|
+
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# MailSafePro::EmailResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **email** | **String** | Validated email address | |
|
|
8
|
+
| **valid** | **Boolean** | Overall validation result | |
|
|
9
|
+
| **detail** | **String** | Validation details summary | [optional][default to ''] |
|
|
10
|
+
| **processing_time** | **Float** | | [optional] |
|
|
11
|
+
| **provider** | **String** | | [optional] |
|
|
12
|
+
| **reputation** | **Float** | | [optional] |
|
|
13
|
+
| **fingerprint** | **String** | | [optional] |
|
|
14
|
+
| **quality_score** | **Float** | | [optional] |
|
|
15
|
+
| **risk_level** | [**RiskLevelEnum**](RiskLevelEnum.md) | | [optional] |
|
|
16
|
+
| **suggestions** | **Array<String>** | Improvement suggestions | [optional] |
|
|
17
|
+
| **smtp** | [**SMTPInfo**](SMTPInfo.md) | | [optional] |
|
|
18
|
+
| **dns** | [**DNSInfo**](DNSInfo.md) | | [optional] |
|
|
19
|
+
| **risk_score** | **Float** | | [optional] |
|
|
20
|
+
| **validation_tier** | **String** | | [optional] |
|
|
21
|
+
| **suggested_action** | **String** | | [optional] |
|
|
22
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
require 'mailsafepro'
|
|
27
|
+
|
|
28
|
+
instance = MailSafePro::EmailResponse.new(
|
|
29
|
+
email: null,
|
|
30
|
+
valid: null,
|
|
31
|
+
detail: null,
|
|
32
|
+
processing_time: null,
|
|
33
|
+
provider: null,
|
|
34
|
+
reputation: null,
|
|
35
|
+
fingerprint: null,
|
|
36
|
+
quality_score: null,
|
|
37
|
+
risk_level: null,
|
|
38
|
+
suggestions: null,
|
|
39
|
+
smtp: null,
|
|
40
|
+
dns: null,
|
|
41
|
+
risk_score: null,
|
|
42
|
+
validation_tier: null,
|
|
43
|
+
suggested_action: null
|
|
44
|
+
)
|
|
45
|
+
```
|
|
46
|
+
|