mailodds 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/README.md +64 -0
- data/Rakefile +10 -0
- data/docs/AddPolicyRule201Response.md +18 -0
- data/docs/AddSuppressionRequest.md +18 -0
- data/docs/AddSuppressionRequestEntriesInner.md +22 -0
- data/docs/AddSuppressionResponse.md +22 -0
- data/docs/BulkValidationApi.md +659 -0
- data/docs/CheckSuppressionRequest.md +18 -0
- data/docs/CreateJobFromS3Request.md +20 -0
- data/docs/CreateJobRequest.md +26 -0
- data/docs/CreatePolicyFromPresetRequest.md +22 -0
- data/docs/CreatePolicyRequest.md +24 -0
- data/docs/DeleteJob200Response.md +20 -0
- data/docs/DeletePolicy200Response.md +20 -0
- data/docs/DeletePolicyRule200Response.md +18 -0
- data/docs/EmailValidationApi.md +77 -0
- data/docs/ErrorResponse.md +22 -0
- data/docs/GetPresignedUploadRequest.md +20 -0
- data/docs/HealthCheck200Response.md +20 -0
- data/docs/Job.md +34 -0
- data/docs/JobListResponse.md +22 -0
- data/docs/JobResponse.md +20 -0
- data/docs/JobSummary.md +26 -0
- data/docs/Pagination.md +24 -0
- data/docs/Policy.md +34 -0
- data/docs/PolicyListResponse.md +22 -0
- data/docs/PolicyListResponseLimits.md +22 -0
- data/docs/PolicyPresetsResponse.md +20 -0
- data/docs/PolicyPresetsResponsePresetsInner.md +24 -0
- data/docs/PolicyResponse.md +20 -0
- data/docs/PolicyRule.md +28 -0
- data/docs/PolicyRuleAction.md +18 -0
- data/docs/PolicyTestResponse.md +26 -0
- data/docs/PresignedUploadResponse.md +20 -0
- data/docs/PresignedUploadResponseUpload.md +24 -0
- data/docs/RemoveSuppression200Response.md +20 -0
- data/docs/RemoveSuppressionRequest.md +18 -0
- data/docs/ResultsResponse.md +22 -0
- data/docs/SuppressionCheckResponse.md +26 -0
- data/docs/SuppressionEntry.md +26 -0
- data/docs/SuppressionListResponse.md +22 -0
- data/docs/SuppressionListsApi.md +362 -0
- data/docs/SuppressionStatsResponse.md +22 -0
- data/docs/SuppressionStatsResponseByType.md +20 -0
- data/docs/SystemApi.md +141 -0
- data/docs/TelemetrySummary.md +32 -0
- data/docs/TelemetrySummaryRates.md +24 -0
- data/docs/TelemetrySummaryTopDomainsInner.md +28 -0
- data/docs/TelemetrySummaryTopReasonsInner.md +20 -0
- data/docs/TelemetrySummaryTotals.md +20 -0
- data/docs/TestPolicyRequest.md +20 -0
- data/docs/TestPolicyRequestTestResult.md +26 -0
- data/docs/UpdatePolicyRequest.md +24 -0
- data/docs/ValidateRequest.md +20 -0
- data/docs/ValidationPoliciesApi.md +712 -0
- data/docs/ValidationResponse.md +40 -0
- data/docs/ValidationResponseSuppressionMatch.md +22 -0
- data/docs/ValidationResult.md +26 -0
- data/git_push.sh +57 -0
- data/lib/mailodds/api/bulk_validation_api.rb +651 -0
- data/lib/mailodds/api/email_validation_api.rb +90 -0
- data/lib/mailodds/api/suppression_lists_api.rb +356 -0
- data/lib/mailodds/api/system_api.rb +143 -0
- data/lib/mailodds/api/validation_policies_api.rb +686 -0
- data/lib/mailodds/api_client.rb +397 -0
- data/lib/mailodds/api_error.rb +58 -0
- data/lib/mailodds/api_model_base.rb +88 -0
- data/lib/mailodds/configuration.rb +308 -0
- data/lib/mailodds/models/add_policy_rule201_response.rb +147 -0
- data/lib/mailodds/models/add_suppression_request.rb +166 -0
- data/lib/mailodds/models/add_suppression_request_entries_inner.rb +223 -0
- data/lib/mailodds/models/add_suppression_response.rb +165 -0
- data/lib/mailodds/models/check_suppression_request.rb +164 -0
- data/lib/mailodds/models/create_job_from_s3_request.rb +176 -0
- data/lib/mailodds/models/create_job_request.rb +219 -0
- data/lib/mailodds/models/create_policy_from_preset_request.rb +225 -0
- data/lib/mailodds/models/create_policy_request.rb +223 -0
- data/lib/mailodds/models/delete_job200_response.rb +156 -0
- data/lib/mailodds/models/delete_policy200_response.rb +156 -0
- data/lib/mailodds/models/delete_policy_rule200_response.rb +147 -0
- data/lib/mailodds/models/error_response.rb +201 -0
- data/lib/mailodds/models/get_presigned_upload_request.rb +175 -0
- data/lib/mailodds/models/health_check200_response.rb +156 -0
- data/lib/mailodds/models/job.rb +281 -0
- data/lib/mailodds/models/job_list_response.rb +167 -0
- data/lib/mailodds/models/job_response.rb +156 -0
- data/lib/mailodds/models/job_summary.rb +183 -0
- data/lib/mailodds/models/pagination.rb +174 -0
- data/lib/mailodds/models/policy.rb +221 -0
- data/lib/mailodds/models/policy_list_response.rb +167 -0
- data/lib/mailodds/models/policy_list_response_limits.rb +166 -0
- data/lib/mailodds/models/policy_presets_response.rb +158 -0
- data/lib/mailodds/models/policy_presets_response_presets_inner.rb +176 -0
- data/lib/mailodds/models/policy_response.rb +156 -0
- data/lib/mailodds/models/policy_rule.rb +269 -0
- data/lib/mailodds/models/policy_rule_action.rb +181 -0
- data/lib/mailodds/models/policy_test_response.rb +187 -0
- data/lib/mailodds/models/presigned_upload_response.rb +156 -0
- data/lib/mailodds/models/presigned_upload_response_upload.rb +174 -0
- data/lib/mailodds/models/remove_suppression200_response.rb +156 -0
- data/lib/mailodds/models/remove_suppression_request.rb +166 -0
- data/lib/mailodds/models/results_response.rb +167 -0
- data/lib/mailodds/models/suppression_check_response.rb +217 -0
- data/lib/mailodds/models/suppression_entry.rb +217 -0
- data/lib/mailodds/models/suppression_list_response.rb +167 -0
- data/lib/mailodds/models/suppression_stats_response.rb +165 -0
- data/lib/mailodds/models/suppression_stats_response_by_type.rb +156 -0
- data/lib/mailodds/models/telemetry_summary.rb +251 -0
- data/lib/mailodds/models/telemetry_summary_rates.rb +179 -0
- data/lib/mailodds/models/telemetry_summary_top_domains_inner.rb +192 -0
- data/lib/mailodds/models/telemetry_summary_top_reasons_inner.rb +156 -0
- data/lib/mailodds/models/telemetry_summary_totals.rb +158 -0
- data/lib/mailodds/models/test_policy_request.rb +190 -0
- data/lib/mailodds/models/test_policy_request_test_result.rb +184 -0
- data/lib/mailodds/models/update_policy_request.rb +174 -0
- data/lib/mailodds/models/validate_request.rb +175 -0
- data/lib/mailodds/models/validation_response.rb +326 -0
- data/lib/mailodds/models/validation_response_suppression_match.rb +199 -0
- data/lib/mailodds/models/validation_result.rb +183 -0
- data/lib/mailodds/version.rb +15 -0
- data/lib/mailodds.rb +96 -0
- data/mailodds.gemspec +31 -0
- data/spec/api/bulk_validation_api_spec.rb +151 -0
- data/spec/api/email_validation_api_spec.rb +47 -0
- data/spec/api/suppression_lists_api_spec.rb +97 -0
- data/spec/api/system_api_spec.rb +58 -0
- data/spec/api/validation_policies_api_spec.rb +157 -0
- data/spec/models/add_policy_rule201_response_spec.rb +36 -0
- data/spec/models/add_suppression_request_entries_inner_spec.rb +52 -0
- data/spec/models/add_suppression_request_spec.rb +36 -0
- data/spec/models/add_suppression_response_spec.rb +48 -0
- data/spec/models/check_suppression_request_spec.rb +36 -0
- data/spec/models/create_job_from_s3_request_spec.rb +42 -0
- data/spec/models/create_job_request_spec.rb +60 -0
- data/spec/models/create_policy_from_preset_request_spec.rb +52 -0
- data/spec/models/create_policy_request_spec.rb +54 -0
- data/spec/models/delete_job200_response_spec.rb +42 -0
- data/spec/models/delete_policy200_response_spec.rb +42 -0
- data/spec/models/delete_policy_rule200_response_spec.rb +36 -0
- data/spec/models/error_response_spec.rb +48 -0
- data/spec/models/get_presigned_upload_request_spec.rb +42 -0
- data/spec/models/health_check200_response_spec.rb +42 -0
- data/spec/models/job_list_response_spec.rb +48 -0
- data/spec/models/job_response_spec.rb +42 -0
- data/spec/models/job_spec.rb +88 -0
- data/spec/models/job_summary_spec.rb +60 -0
- data/spec/models/pagination_spec.rb +54 -0
- data/spec/models/policy_list_response_limits_spec.rb +48 -0
- data/spec/models/policy_list_response_spec.rb +48 -0
- data/spec/models/policy_presets_response_presets_inner_spec.rb +54 -0
- data/spec/models/policy_presets_response_spec.rb +42 -0
- data/spec/models/policy_response_spec.rb +42 -0
- data/spec/models/policy_rule_action_spec.rb +40 -0
- data/spec/models/policy_rule_spec.rb +70 -0
- data/spec/models/policy_spec.rb +84 -0
- data/spec/models/policy_test_response_spec.rb +60 -0
- data/spec/models/presigned_upload_response_spec.rb +42 -0
- data/spec/models/presigned_upload_response_upload_spec.rb +54 -0
- data/spec/models/remove_suppression200_response_spec.rb +42 -0
- data/spec/models/remove_suppression_request_spec.rb +36 -0
- data/spec/models/results_response_spec.rb +48 -0
- data/spec/models/suppression_check_response_spec.rb +64 -0
- data/spec/models/suppression_entry_spec.rb +64 -0
- data/spec/models/suppression_list_response_spec.rb +48 -0
- data/spec/models/suppression_stats_response_by_type_spec.rb +42 -0
- data/spec/models/suppression_stats_response_spec.rb +48 -0
- data/spec/models/telemetry_summary_rates_spec.rb +54 -0
- data/spec/models/telemetry_summary_spec.rb +82 -0
- data/spec/models/telemetry_summary_top_domains_inner_spec.rb +66 -0
- data/spec/models/telemetry_summary_top_reasons_inner_spec.rb +42 -0
- data/spec/models/telemetry_summary_totals_spec.rb +42 -0
- data/spec/models/test_policy_request_spec.rb +42 -0
- data/spec/models/test_policy_request_test_result_spec.rb +60 -0
- data/spec/models/update_policy_request_spec.rb +54 -0
- data/spec/models/validate_request_spec.rb +42 -0
- data/spec/models/validation_response_spec.rb +110 -0
- data/spec/models/validation_response_suppression_match_spec.rb +52 -0
- data/spec/models/validation_result_spec.rb +60 -0
- data/spec/spec_helper.rb +111 -0
- metadata +322 -0
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Mailodds::TelemetrySummaryRates
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **deliverable** | **Float** | Rate of valid + catch_all emails | [optional] |
|
|
8
|
+
| **reject** | **Float** | Rate of invalid + do_not_mail emails | [optional] |
|
|
9
|
+
| **unknown** | **Float** | Rate of unknown status | [optional] |
|
|
10
|
+
| **suppressed** | **Float** | Rate of suppressed emails | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'mailodds'
|
|
16
|
+
|
|
17
|
+
instance = Mailodds::TelemetrySummaryRates.new(
|
|
18
|
+
deliverable: null,
|
|
19
|
+
reject: null,
|
|
20
|
+
unknown: null,
|
|
21
|
+
suppressed: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Mailodds::TelemetrySummaryTopDomainsInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **domain** | **String** | | [optional] |
|
|
8
|
+
| **volume** | **Integer** | | [optional] |
|
|
9
|
+
| **deliverable** | **Float** | | [optional] |
|
|
10
|
+
| **reject** | **Float** | | [optional] |
|
|
11
|
+
| **unknown** | **Float** | | [optional] |
|
|
12
|
+
| **catch_all** | **Float** | | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'mailodds'
|
|
18
|
+
|
|
19
|
+
instance = Mailodds::TelemetrySummaryTopDomainsInner.new(
|
|
20
|
+
domain: null,
|
|
21
|
+
volume: null,
|
|
22
|
+
deliverable: null,
|
|
23
|
+
reject: null,
|
|
24
|
+
unknown: null,
|
|
25
|
+
catch_all: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Mailodds::TelemetrySummaryTopReasonsInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **reason** | **String** | | [optional] |
|
|
8
|
+
| **count** | **Integer** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'mailodds'
|
|
14
|
+
|
|
15
|
+
instance = Mailodds::TelemetrySummaryTopReasonsInner.new(
|
|
16
|
+
reason: null,
|
|
17
|
+
count: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Mailodds::TelemetrySummaryTotals
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **validations** | **Integer** | Total validations in window | [optional] |
|
|
8
|
+
| **credits_used** | **Integer** | Credits consumed | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'mailodds'
|
|
14
|
+
|
|
15
|
+
instance = Mailodds::TelemetrySummaryTotals.new(
|
|
16
|
+
validations: null,
|
|
17
|
+
credits_used: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Mailodds::TestPolicyRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **policy_id** | **Integer** | | |
|
|
8
|
+
| **test_result** | [**TestPolicyRequestTestResult**](TestPolicyRequestTestResult.md) | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'mailodds'
|
|
14
|
+
|
|
15
|
+
instance = Mailodds::TestPolicyRequest.new(
|
|
16
|
+
policy_id: null,
|
|
17
|
+
test_result: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Mailodds::TestPolicyRequestTestResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **email** | **String** | | [optional] |
|
|
8
|
+
| **status** | **String** | | [optional] |
|
|
9
|
+
| **action** | **String** | | [optional] |
|
|
10
|
+
| **domain** | **String** | | [optional] |
|
|
11
|
+
| **sub_status** | **String** | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'mailodds'
|
|
17
|
+
|
|
18
|
+
instance = Mailodds::TestPolicyRequestTestResult.new(
|
|
19
|
+
email: null,
|
|
20
|
+
status: null,
|
|
21
|
+
action: null,
|
|
22
|
+
domain: null,
|
|
23
|
+
sub_status: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Mailodds::UpdatePolicyRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | | [optional] |
|
|
8
|
+
| **description** | **String** | | [optional] |
|
|
9
|
+
| **is_enabled** | **Boolean** | | [optional] |
|
|
10
|
+
| **is_default** | **Boolean** | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'mailodds'
|
|
16
|
+
|
|
17
|
+
instance = Mailodds::UpdatePolicyRequest.new(
|
|
18
|
+
name: null,
|
|
19
|
+
description: null,
|
|
20
|
+
is_enabled: null,
|
|
21
|
+
is_default: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Mailodds::ValidateRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **email** | **String** | Email address to validate | |
|
|
8
|
+
| **policy_id** | **Integer** | Optional policy ID to use instead of default policy | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'mailodds'
|
|
14
|
+
|
|
15
|
+
instance = Mailodds::ValidateRequest.new(
|
|
16
|
+
email: null,
|
|
17
|
+
policy_id: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|