mailodds 1.0.0

data/docs/CreatePolicyFromPresetRequest.md

@@ -0,0 +1,22 @@
+# Mailodds::CreatePolicyFromPresetRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **preset_id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **is_default** | **Boolean** |  | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'mailodds'
+
+instance = Mailodds::CreatePolicyFromPresetRequest.new(
+  preset_id: null,
+  name: null,
+  is_default: null
+)
+```
+

data/docs/CreatePolicyRequest.md

@@ -0,0 +1,24 @@
+# Mailodds::CreatePolicyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **description** | **String** |  | [optional] |
+| **is_default** | **Boolean** |  | [optional][default to false] |
+| **rules** | [**Array<PolicyRule>**](PolicyRule.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mailodds'
+
+instance = Mailodds::CreatePolicyRequest.new(
+  name: null,
+  description: null,
+  is_default: null,
+  rules: null
+)
+```
+

data/docs/DeleteJob200Response.md

@@ -0,0 +1,20 @@
+# Mailodds::DeleteJob200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **schema_version** | **String** |  | [optional] |
+| **deleted** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mailodds'
+
+instance = Mailodds::DeleteJob200Response.new(
+  schema_version: null,
+  deleted: null
+)
+```
+

data/docs/DeletePolicy200Response.md

@@ -0,0 +1,20 @@
+# Mailodds::DeletePolicy200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deleted** | **Boolean** |  | [optional] |
+| **policy_id** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mailodds'
+
+instance = Mailodds::DeletePolicy200Response.new(
+  deleted: null,
+  policy_id: null
+)
+```
+

data/docs/DeletePolicyRule200Response.md

@@ -0,0 +1,18 @@
+# Mailodds::DeletePolicyRule200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deleted** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mailodds'
+
+instance = Mailodds::DeletePolicyRule200Response.new(
+  deleted: null
+)
+```
+

data/docs/EmailValidationApi.md

@@ -0,0 +1,77 @@
+# Mailodds::EmailValidationApi
+
+All URIs are relative to *https://api.mailodds.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**validate_email**](EmailValidationApi.md#validate_email) | **POST** /v1/validate | Validate single email |
+
+
+## validate_email
+
+> <ValidationResponse> validate_email(validate_request)
+
+Validate single email
+
+Validate a single email address. Returns detailed validation results including status, sub-status, and recommended action.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mailodds'
+# setup authorization
+Mailodds.configure do |config|
+  # Configure Bearer authorization: BearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Mailodds::EmailValidationApi.new
+validate_request = Mailodds::ValidateRequest.new({email: 'email_example'}) # ValidateRequest | 
+
+begin
+  # Validate single email
+  result = api_instance.validate_email(validate_request)
+  p result
+rescue Mailodds::ApiError => e
+  puts "Error when calling EmailValidationApi->validate_email: #{e}"
+end
+```
+
+#### Using the validate_email_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ValidationResponse>, Integer, Hash)> validate_email_with_http_info(validate_request)
+
+```ruby
+begin
+  # Validate single email
+  data, status_code, headers = api_instance.validate_email_with_http_info(validate_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ValidationResponse>
+rescue Mailodds::ApiError => e
+  puts "Error when calling EmailValidationApi->validate_email_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **validate_request** | [**ValidateRequest**](ValidateRequest.md) |  |  |
+
+### Return type
+
+[**ValidationResponse**](ValidationResponse.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/ErrorResponse.md

@@ -0,0 +1,22 @@
+# Mailodds::ErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **schema_version** | **String** |  | [optional] |
+| **error** | **String** | Machine-readable error code |  |
+| **message** | **String** | Human-readable error message |  |
+
+## Example
+
+```ruby
+require 'mailodds'
+
+instance = Mailodds::ErrorResponse.new(
+  schema_version: 1.0,
+  error: null,
+  message: null
+)
+```
+

data/docs/GetPresignedUploadRequest.md

@@ -0,0 +1,20 @@
+# Mailodds::GetPresignedUploadRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filename** | **String** | Original filename |  |
+| **content_type** | **String** | File MIME type | [optional] |
+
+## Example
+
+```ruby
+require 'mailodds'
+
+instance = Mailodds::GetPresignedUploadRequest.new(
+  filename: null,
+  content_type: null
+)
+```
+

data/docs/HealthCheck200Response.md

@@ -0,0 +1,20 @@
+# Mailodds::HealthCheck200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  | [optional] |
+| **timestamp** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mailodds'
+
+instance = Mailodds::HealthCheck200Response.new(
+  status: healthy,
+  timestamp: null
+)
+```
+

data/docs/Job.md

@@ -0,0 +1,34 @@
+# Mailodds::Job
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **total_count** | **Integer** |  | [optional] |
+| **processed_count** | **Integer** |  | [optional] |
+| **progress_percent** | **Integer** |  | [optional] |
+| **summary** | [**JobSummary**](JobSummary.md) |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+| **completed_at** | **Time** |  | [optional] |
+| **metadata** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mailodds'
+
+instance = Mailodds::Job.new(
+  id: job_abc123xyz,
+  status: null,
+  total_count: null,
+  processed_count: null,
+  progress_percent: null,
+  summary: null,
+  created_at: null,
+  completed_at: null,
+  metadata: null
+)
+```
+

data/docs/JobListResponse.md

@@ -0,0 +1,22 @@
+# Mailodds::JobListResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **schema_version** | **String** |  | [optional] |
+| **jobs** | [**Array<Job>**](Job.md) |  | [optional] |
+| **pagination** | [**Pagination**](Pagination.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mailodds'
+
+instance = Mailodds::JobListResponse.new(
+  schema_version: null,
+  jobs: null,
+  pagination: null
+)
+```
+

data/docs/JobResponse.md

@@ -0,0 +1,20 @@
+# Mailodds::JobResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **schema_version** | **String** |  | [optional] |
+| **job** | [**Job**](Job.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mailodds'
+
+instance = Mailodds::JobResponse.new(
+  schema_version: 1.0,
+  job: null
+)
+```
+

data/docs/JobSummary.md

@@ -0,0 +1,26 @@
+# Mailodds::JobSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **valid** | **Integer** |  | [optional] |
+| **invalid** | **Integer** |  | [optional] |
+| **do_not_mail** | **Integer** |  | [optional] |
+| **unknown** | **Integer** |  | [optional] |
+| **cancelled_pending** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mailodds'
+
+instance = Mailodds::JobSummary.new(
+  valid: null,
+  invalid: null,
+  do_not_mail: null,
+  unknown: null,
+  cancelled_pending: null
+)
+```
+

data/docs/Pagination.md

@@ -0,0 +1,24 @@
+# Mailodds::Pagination
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** |  | [optional] |
+| **per_page** | **Integer** |  | [optional] |
+| **total** | **Integer** |  | [optional] |
+| **total_pages** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mailodds'
+
+instance = Mailodds::Pagination.new(
+  page: null,
+  per_page: null,
+  total: null,
+  total_pages: null
+)
+```
+

data/docs/Policy.md

@@ -0,0 +1,34 @@
+# Mailodds::Policy
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **is_default** | **Boolean** |  | [optional] |
+| **is_enabled** | **Boolean** |  | [optional] |
+| **priority** | **Integer** |  | [optional] |
+| **rule_count** | **Integer** |  | [optional] |
+| **rules** | [**Array<PolicyRule>**](PolicyRule.md) |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mailodds'
+
+instance = Mailodds::Policy.new(
+  id: null,
+  name: null,
+  description: null,
+  is_default: null,
+  is_enabled: null,
+  priority: null,
+  rule_count: null,
+  rules: null,
+  created_at: null
+)
+```
+

data/docs/PolicyListResponse.md

@@ -0,0 +1,22 @@
+# Mailodds::PolicyListResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **schema_version** | **String** |  | [optional] |
+| **policies** | [**Array<Policy>**](Policy.md) |  | [optional] |
+| **limits** | [**PolicyListResponseLimits**](PolicyListResponseLimits.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mailodds'
+
+instance = Mailodds::PolicyListResponse.new(
+  schema_version: null,
+  policies: null,
+  limits: null
+)
+```
+

data/docs/PolicyListResponseLimits.md

@@ -0,0 +1,22 @@
+# Mailodds::PolicyListResponseLimits
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **max_policies** | **Integer** | -1 means unlimited | [optional] |
+| **max_rules_per_policy** | **Integer** |  | [optional] |
+| **plan** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mailodds'
+
+instance = Mailodds::PolicyListResponseLimits.new(
+  max_policies: null,
+  max_rules_per_policy: null,
+  plan: null
+)
+```
+

data/docs/PolicyPresetsResponse.md

@@ -0,0 +1,20 @@
+# Mailodds::PolicyPresetsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **schema_version** | **String** |  | [optional] |
+| **presets** | [**Array<PolicyPresetsResponsePresetsInner>**](PolicyPresetsResponsePresetsInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mailodds'
+
+instance = Mailodds::PolicyPresetsResponse.new(
+  schema_version: null,
+  presets: null
+)
+```
+

data/docs/PolicyPresetsResponsePresetsInner.md

@@ -0,0 +1,24 @@
+# Mailodds::PolicyPresetsResponsePresetsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **rules** | [**Array<PolicyRule>**](PolicyRule.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mailodds'
+
+instance = Mailodds::PolicyPresetsResponsePresetsInner.new(
+  id: null,
+  name: null,
+  description: null,
+  rules: null
+)
+```
+

data/docs/PolicyResponse.md

@@ -0,0 +1,20 @@
+# Mailodds::PolicyResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **schema_version** | **String** |  | [optional] |
+| **policy** | [**Policy**](Policy.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mailodds'
+
+instance = Mailodds::PolicyResponse.new(
+  schema_version: null,
+  policy: null
+)
+```
+

data/docs/PolicyRule.md

@@ -0,0 +1,28 @@
+# Mailodds::PolicyRule
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional] |
+| **type** | **String** | Rule type determines how condition is evaluated |  |
+| **condition** | **Object** | Condition depends on rule type. status_override: {status}, domain_filter: {domain_mode, domains}, check_requirement: {check, required}, sub_status_override: {sub_status} |  |
+| **action** | [**PolicyRuleAction**](PolicyRuleAction.md) |  |  |
+| **sequence** | **Integer** |  | [optional] |
+| **is_enabled** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mailodds'
+
+instance = Mailodds::PolicyRule.new(
+  id: null,
+  type: null,
+  condition: null,
+  action: null,
+  sequence: null,
+  is_enabled: null
+)
+```
+

data/docs/PolicyRuleAction.md

@@ -0,0 +1,18 @@
+# Mailodds::PolicyRuleAction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mailodds'
+
+instance = Mailodds::PolicyRuleAction.new(
+  action: null
+)
+```
+

data/docs/PolicyTestResponse.md

@@ -0,0 +1,26 @@
+# Mailodds::PolicyTestResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **schema_version** | **String** |  | [optional] |
+| **original** | **Object** | Original validation result before policy | [optional] |
+| **modified** | **Object** | Result after policy applied | [optional] |
+| **matched_rule** | **Object** | The rule that matched, or null if none matched | [optional] |
+| **rules_evaluated** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mailodds'
+
+instance = Mailodds::PolicyTestResponse.new(
+  schema_version: null,
+  original: null,
+  modified: null,
+  matched_rule: null,
+  rules_evaluated: null
+)
+```
+

data/docs/PresignedUploadResponse.md

@@ -0,0 +1,20 @@
+# Mailodds::PresignedUploadResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **schema_version** | **String** |  | [optional] |
+| **upload** | [**PresignedUploadResponseUpload**](PresignedUploadResponseUpload.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mailodds'
+
+instance = Mailodds::PresignedUploadResponse.new(
+  schema_version: null,
+  upload: null
+)
+```
+

data/docs/PresignedUploadResponseUpload.md

@@ -0,0 +1,24 @@
+# Mailodds::PresignedUploadResponseUpload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** |  | [optional] |
+| **fields** | **Object** |  | [optional] |
+| **s3_key** | **String** |  | [optional] |
+| **expires_in** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mailodds'
+
+instance = Mailodds::PresignedUploadResponseUpload.new(
+  url: null,
+  fields: null,
+  s3_key: null,
+  expires_in: null
+)
+```
+

data/docs/RemoveSuppression200Response.md

@@ -0,0 +1,20 @@
+# Mailodds::RemoveSuppression200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **schema_version** | **String** |  | [optional] |
+| **removed** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mailodds'
+
+instance = Mailodds::RemoveSuppression200Response.new(
+  schema_version: null,
+  removed: null
+)
+```
+