mailodds 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a1b586b3e8c6fbca5bf39745cc8da155ee85611caafe2f23874eb5c5d9db3f42
+  data.tar.gz: 2d9667abec929403174f215df4439b34ed9052a9e70e3b705358bcca2e4b040b
+SHA512:
+  metadata.gz: 93cd2e171b2a5f57b9d876d048c016100318e5afdfbf3a9b9fd155110dfaa06f39afa3434e9fd684677d44a776d7707c01c250650cba80e7366c3095ddb9786c
+  data.tar.gz: bf50cd160fba3d70a4278d5870b474b2db5506ac358855600e3772b67f2e67ccf54da8c07eff5f8c4b9bfa01c8e4d53859991049ff9b0bf658cd722aabc9bcea

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,64 @@
+# MailOdds SDK for Ruby
+
+Official Ruby client for the [MailOdds Email Validation API](https://mailodds.com/docs).
+
+## Installation
+
+```shell
+gem install mailodds
+```
+
+Or add to your Gemfile:
+
+```ruby
+gem 'mailodds', '~> 1.0'
+```
+
+## Quick Start
+
+```ruby
+require 'mailodds'
+
+Mailodds.configure do |config|
+  config.access_token = 'mo_live_your_api_key'
+end
+
+api = Mailodds::EmailValidationApi.new
+request = Mailodds::ValidateRequest.new(email: 'user@example.com')
+result = api.validate_email(request)
+
+case result.action
+when 'accept'
+  puts 'Safe to send'
+when 'accept_with_caution'
+  puts 'Valid but risky -- flag for review'
+when 'reject'
+  puts 'Do not send'
+when 'retry_later'
+  puts 'Temporary failure -- retry after backoff'
+end
+```
+
+## Response Handling
+
+Branch on the `action` field for decisioning:
+
+| Action | Meaning | Recommended |
+|--------|---------|-------------|
+| `accept` | Safe to send | Add to mailing list |
+| `accept_with_caution` | Valid but risky (catch-all, role account) | Flag for review |
+| `reject` | Invalid or disposable | Do not send |
+| `retry_later` | Temporary failure | Retry after backoff |
+
+## Test Mode
+
+Use an `mo_test_` prefixed API key with test domains for predictable responses without consuming credits.
+
+## API Reference
+
+Full API documentation: https://mailodds.com/docs
+OpenAPI spec: https://mailodds.com/openapi.yaml
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AddPolicyRule201Response.md

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

data/docs/AddSuppressionRequest.md

@@ -0,0 +1,18 @@
+# Mailodds::AddSuppressionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **entries** | [**Array<AddSuppressionRequestEntriesInner>**](AddSuppressionRequestEntriesInner.md) |  |  |
+
+## Example
+
+```ruby
+require 'mailodds'
+
+instance = Mailodds::AddSuppressionRequest.new(
+  entries: null
+)
+```
+

data/docs/AddSuppressionRequestEntriesInner.md

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

data/docs/AddSuppressionResponse.md

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