{"id":26395642,"url":"https://github.com/elasticemail/elasticemail-ruby","last_synced_at":"2025-03-17T11:18:52.648Z","repository":{"id":84264517,"uuid":"366327922","full_name":"ElasticEmail/elasticemail-ruby","owner":"ElasticEmail","description":"ElasticEmail - Ruby library for the Elastic Email REST API","archived":false,"fork":false,"pushed_at":"2024-12-05T12:37:54.000Z","size":485,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2024-12-05T13:34:23.266Z","etag":null,"topics":["api","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ElasticEmail.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"docs/SecurityApi.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-05-11T09:31:46.000Z","updated_at":"2024-12-05T12:37:58.000Z","dependencies_parsed_at":"2024-07-08T11:29:08.895Z","dependency_job_id":"17f652a6-6096-4edc-8bfa-4e503a110a0c","html_url":"https://github.com/ElasticEmail/elasticemail-ruby","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ElasticEmail%2Felasticemail-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ElasticEmail%2Felasticemail-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ElasticEmail%2Felasticemail-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ElasticEmail%2Felasticemail-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ElasticEmail","download_url":"https://codeload.github.com/ElasticEmail/elasticemail-ruby/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244022684,"owners_count":20385134,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","ruby"],"created_at":"2025-03-17T11:18:52.227Z","updated_at":"2025-03-17T11:18:52.639Z","avatar_url":"https://github.com/ElasticEmail.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ElasticEmail\n\nElasticEmail - the Ruby gem for the Elastic Email REST API\n\nThis API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach.\r\n\r\nEvery API call is established on which specific request type (GET, POST, PUT, DELETE) will be used.\r\n\r\nThe API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request.\r\n\r\nTo start using this API, you will need your Access Token (available [here](https://app.elasticemail.com/marketing/settings/new/manage-api)). Remember to keep it safe. Required access levels are listed in the given request’s description.\r\n\r\nDownloadable library clients can be found in our Github repository [here](https://github.com/ElasticEmail?tab=repositories\u0026q=%22rest+api%22+in%3Areadme)\n\nThis SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 4.0.0\n- Package version: 4.0.25\n- Generator version: 7.5.0\n- Build package: org.openapitools.codegen.languages.RubyClientCodegen\n\n## Installation\n\n### Build a gem\n\nTo build the Ruby code into a gem:\n\n```shell\ngem build ElasticEmail.gemspec\n```\n\nThen either install the gem locally:\n\n```shell\ngem install ./ElasticEmail-4.0.25.gem\n```\n\n(for development, run `gem install --dev ./ElasticEmail-4.0.25.gem` to install the development dependencies)\n\nor publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).\n\nFinally add this to the Gemfile:\n\n    gem 'ElasticEmail', '~\u003e 4.0.25'\n\n### Install from Git\n\nIf the Ruby gem is hosted at a git repository: https://github.com/elasticemail/elasticemail-ruby, then add the following in the Gemfile:\n\n    gem 'ElasticEmail', :git =\u003e 'https://github.com/elasticemail/elasticemail-ruby.git'\n\n### Include the Ruby code directly\n\nInclude the Ruby code directly using `-I` as follows:\n\n```shell\nruby -Ilib script.rb\n```\n\n## Getting Started\n\nPlease follow the [installation](#installation) procedure and then run the following code:\n\n```ruby\n# Load the gem\nrequire 'ElasticEmail'\n\n# Setup authorization\nElasticEmail.configure do |config|\n  # Configure API key authorization: apikey\n  config.api_key['apikey'] = 'YOUR API KEY'\n  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)\n  # config.api_key_prefix['apikey'] = 'Bearer'\nend\n\napi_instance = ElasticEmail::CampaignsApi.new\nname = 'name_example' # String | Name of Campaign to delete\n\nbegin\n  #Delete Campaign\n  api_instance.campaigns_by_name_delete(name)\nrescue ElasticEmail::ApiError =\u003e e\n  puts \"Exception when calling CampaignsApi-\u003ecampaigns_by_name_delete: #{e}\"\nend\n\n```\n\n\n\nAll URIs are relative to *https://api.elasticemail.com/v4*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*ElasticEmail::CampaignsApi* | [**campaigns_by_name_delete**](docs/CampaignsApi.md#campaigns_by_name_delete) | **DELETE** /campaigns/{name} | Delete Campaign\n*ElasticEmail::CampaignsApi* | [**campaigns_by_name_get**](docs/CampaignsApi.md#campaigns_by_name_get) | **GET** /campaigns/{name} | Load Campaign\n*ElasticEmail::CampaignsApi* | [**campaigns_by_name_pause_put**](docs/CampaignsApi.md#campaigns_by_name_pause_put) | **PUT** /campaigns/{name}/pause | Pause Campaign\n*ElasticEmail::CampaignsApi* | [**campaigns_by_name_put**](docs/CampaignsApi.md#campaigns_by_name_put) | **PUT** /campaigns/{name} | Update Campaign\n*ElasticEmail::CampaignsApi* | [**campaigns_get**](docs/CampaignsApi.md#campaigns_get) | **GET** /campaigns | Load Campaigns\n*ElasticEmail::CampaignsApi* | [**campaigns_post**](docs/CampaignsApi.md#campaigns_post) | **POST** /campaigns | Add Campaign\n*ElasticEmail::ContactsApi* | [**contacts_by_email_delete**](docs/ContactsApi.md#contacts_by_email_delete) | **DELETE** /contacts/{email} | Delete Contact\n*ElasticEmail::ContactsApi* | [**contacts_by_email_get**](docs/ContactsApi.md#contacts_by_email_get) | **GET** /contacts/{email} | Load Contact\n*ElasticEmail::ContactsApi* | [**contacts_by_email_put**](docs/ContactsApi.md#contacts_by_email_put) | **PUT** /contacts/{email} | Update Contact\n*ElasticEmail::ContactsApi* | [**contacts_delete_post**](docs/ContactsApi.md#contacts_delete_post) | **POST** /contacts/delete | Delete Contacts Bulk\n*ElasticEmail::ContactsApi* | [**contacts_export_by_id_status_get**](docs/ContactsApi.md#contacts_export_by_id_status_get) | **GET** /contacts/export/{id}/status | Check Export Status\n*ElasticEmail::ContactsApi* | [**contacts_export_post**](docs/ContactsApi.md#contacts_export_post) | **POST** /contacts/export | Export Contacts\n*ElasticEmail::ContactsApi* | [**contacts_get**](docs/ContactsApi.md#contacts_get) | **GET** /contacts | Load Contacts\n*ElasticEmail::ContactsApi* | [**contacts_import_post**](docs/ContactsApi.md#contacts_import_post) | **POST** /contacts/import | Upload Contacts\n*ElasticEmail::ContactsApi* | [**contacts_post**](docs/ContactsApi.md#contacts_post) | **POST** /contacts | Add Contact\n*ElasticEmail::DomainsApi* | [**domains_by_domain_delete**](docs/DomainsApi.md#domains_by_domain_delete) | **DELETE** /domains/{domain} | Delete Domain\n*ElasticEmail::DomainsApi* | [**domains_by_domain_get**](docs/DomainsApi.md#domains_by_domain_get) | **GET** /domains/{domain} | Load Domain\n*ElasticEmail::DomainsApi* | [**domains_by_domain_put**](docs/DomainsApi.md#domains_by_domain_put) | **PUT** /domains/{domain} | Update Domain\n*ElasticEmail::DomainsApi* | [**domains_by_domain_restricted_get**](docs/DomainsApi.md#domains_by_domain_restricted_get) | **GET** /domains/{domain}/restricted | Check for domain restriction\n*ElasticEmail::DomainsApi* | [**domains_by_domain_verification_put**](docs/DomainsApi.md#domains_by_domain_verification_put) | **PUT** /domains/{domain}/verification | Verify Domain\n*ElasticEmail::DomainsApi* | [**domains_by_email_default_patch**](docs/DomainsApi.md#domains_by_email_default_patch) | **PATCH** /domains/{email}/default | Set Default\n*ElasticEmail::DomainsApi* | [**domains_get**](docs/DomainsApi.md#domains_get) | **GET** /domains | Load Domains\n*ElasticEmail::DomainsApi* | [**domains_post**](docs/DomainsApi.md#domains_post) | **POST** /domains | Add Domain\n*ElasticEmail::EmailsApi* | [**emails_by_msgid_view_get**](docs/EmailsApi.md#emails_by_msgid_view_get) | **GET** /emails/{msgid}/view | View Email\n*ElasticEmail::EmailsApi* | [**emails_by_transactionid_status_get**](docs/EmailsApi.md#emails_by_transactionid_status_get) | **GET** /emails/{transactionid}/status | Get Status\n*ElasticEmail::EmailsApi* | [**emails_mergefile_post**](docs/EmailsApi.md#emails_mergefile_post) | **POST** /emails/mergefile | Send Bulk Emails CSV\n*ElasticEmail::EmailsApi* | [**emails_post**](docs/EmailsApi.md#emails_post) | **POST** /emails | Send Bulk Emails\n*ElasticEmail::EmailsApi* | [**emails_transactional_post**](docs/EmailsApi.md#emails_transactional_post) | **POST** /emails/transactional | Send Transactional Email\n*ElasticEmail::EventsApi* | [**events_by_transactionid_get**](docs/EventsApi.md#events_by_transactionid_get) | **GET** /events/{transactionid} | Load Email Events\n*ElasticEmail::EventsApi* | [**events_channels_by_name_export_post**](docs/EventsApi.md#events_channels_by_name_export_post) | **POST** /events/channels/{name}/export | Export Channel Events\n*ElasticEmail::EventsApi* | [**events_channels_by_name_get**](docs/EventsApi.md#events_channels_by_name_get) | **GET** /events/channels/{name} | Load Channel Events\n*ElasticEmail::EventsApi* | [**events_channels_export_by_id_status_get**](docs/EventsApi.md#events_channels_export_by_id_status_get) | **GET** /events/channels/export/{id}/status | Check Channel Export Status\n*ElasticEmail::EventsApi* | [**events_export_by_id_status_get**](docs/EventsApi.md#events_export_by_id_status_get) | **GET** /events/export/{id}/status | Check Export Status\n*ElasticEmail::EventsApi* | [**events_export_post**](docs/EventsApi.md#events_export_post) | **POST** /events/export | Export Events\n*ElasticEmail::EventsApi* | [**events_get**](docs/EventsApi.md#events_get) | **GET** /events | Load Events\n*ElasticEmail::FilesApi* | [**files_by_name_delete**](docs/FilesApi.md#files_by_name_delete) | **DELETE** /files/{name} | Delete File\n*ElasticEmail::FilesApi* | [**files_by_name_get**](docs/FilesApi.md#files_by_name_get) | **GET** /files/{name} | Download File\n*ElasticEmail::FilesApi* | [**files_by_name_info_get**](docs/FilesApi.md#files_by_name_info_get) | **GET** /files/{name}/info | Load File Details\n*ElasticEmail::FilesApi* | [**files_get**](docs/FilesApi.md#files_get) | **GET** /files | List Files\n*ElasticEmail::FilesApi* | [**files_post**](docs/FilesApi.md#files_post) | **POST** /files | Upload File\n*ElasticEmail::InboundRouteApi* | [**inboundroute_by_id_delete**](docs/InboundRouteApi.md#inboundroute_by_id_delete) | **DELETE** /inboundroute/{id} | Delete Route\n*ElasticEmail::InboundRouteApi* | [**inboundroute_by_id_get**](docs/InboundRouteApi.md#inboundroute_by_id_get) | **GET** /inboundroute/{id} | Get Route\n*ElasticEmail::InboundRouteApi* | [**inboundroute_by_id_put**](docs/InboundRouteApi.md#inboundroute_by_id_put) | **PUT** /inboundroute/{id} | Update Route\n*ElasticEmail::InboundRouteApi* | [**inboundroute_get**](docs/InboundRouteApi.md#inboundroute_get) | **GET** /inboundroute | Get Routes\n*ElasticEmail::InboundRouteApi* | [**inboundroute_order_put**](docs/InboundRouteApi.md#inboundroute_order_put) | **PUT** /inboundroute/order | Update Sorting\n*ElasticEmail::InboundRouteApi* | [**inboundroute_post**](docs/InboundRouteApi.md#inboundroute_post) | **POST** /inboundroute | Create Route\n*ElasticEmail::ListsApi* | [**lists_by_listname_contacts_get**](docs/ListsApi.md#lists_by_listname_contacts_get) | **GET** /lists/{listname}/contacts | Load Contacts in List\n*ElasticEmail::ListsApi* | [**lists_by_name_contacts_post**](docs/ListsApi.md#lists_by_name_contacts_post) | **POST** /lists/{name}/contacts | Add Contacts to List\n*ElasticEmail::ListsApi* | [**lists_by_name_contacts_remove_post**](docs/ListsApi.md#lists_by_name_contacts_remove_post) | **POST** /lists/{name}/contacts/remove | Remove Contacts from List\n*ElasticEmail::ListsApi* | [**lists_by_name_delete**](docs/ListsApi.md#lists_by_name_delete) | **DELETE** /lists/{name} | Delete List\n*ElasticEmail::ListsApi* | [**lists_by_name_get**](docs/ListsApi.md#lists_by_name_get) | **GET** /lists/{name} | Load List\n*ElasticEmail::ListsApi* | [**lists_by_name_put**](docs/ListsApi.md#lists_by_name_put) | **PUT** /lists/{name} | Update List\n*ElasticEmail::ListsApi* | [**lists_get**](docs/ListsApi.md#lists_get) | **GET** /lists | Load Lists\n*ElasticEmail::ListsApi* | [**lists_post**](docs/ListsApi.md#lists_post) | **POST** /lists | Add List\n*ElasticEmail::SecurityApi* | [**security_apikeys_by_name_delete**](docs/SecurityApi.md#security_apikeys_by_name_delete) | **DELETE** /security/apikeys/{name} | Delete ApiKey\n*ElasticEmail::SecurityApi* | [**security_apikeys_by_name_get**](docs/SecurityApi.md#security_apikeys_by_name_get) | **GET** /security/apikeys/{name} | Load ApiKey\n*ElasticEmail::SecurityApi* | [**security_apikeys_by_name_put**](docs/SecurityApi.md#security_apikeys_by_name_put) | **PUT** /security/apikeys/{name} | Update ApiKey\n*ElasticEmail::SecurityApi* | [**security_apikeys_get**](docs/SecurityApi.md#security_apikeys_get) | **GET** /security/apikeys | List ApiKeys\n*ElasticEmail::SecurityApi* | [**security_apikeys_post**](docs/SecurityApi.md#security_apikeys_post) | **POST** /security/apikeys | Add ApiKey\n*ElasticEmail::SecurityApi* | [**security_smtp_by_name_delete**](docs/SecurityApi.md#security_smtp_by_name_delete) | **DELETE** /security/smtp/{name} | Delete SMTP Credential\n*ElasticEmail::SecurityApi* | [**security_smtp_by_name_get**](docs/SecurityApi.md#security_smtp_by_name_get) | **GET** /security/smtp/{name} | Load SMTP Credential\n*ElasticEmail::SecurityApi* | [**security_smtp_by_name_put**](docs/SecurityApi.md#security_smtp_by_name_put) | **PUT** /security/smtp/{name} | Update SMTP Credential\n*ElasticEmail::SecurityApi* | [**security_smtp_get**](docs/SecurityApi.md#security_smtp_get) | **GET** /security/smtp | List SMTP Credentials\n*ElasticEmail::SecurityApi* | [**security_smtp_post**](docs/SecurityApi.md#security_smtp_post) | **POST** /security/smtp | Add SMTP Credential\n*ElasticEmail::SegmentsApi* | [**segments_by_name_delete**](docs/SegmentsApi.md#segments_by_name_delete) | **DELETE** /segments/{name} | Delete Segment\n*ElasticEmail::SegmentsApi* | [**segments_by_name_get**](docs/SegmentsApi.md#segments_by_name_get) | **GET** /segments/{name} | Load Segment\n*ElasticEmail::SegmentsApi* | [**segments_by_name_put**](docs/SegmentsApi.md#segments_by_name_put) | **PUT** /segments/{name} | Update Segment\n*ElasticEmail::SegmentsApi* | [**segments_get**](docs/SegmentsApi.md#segments_get) | **GET** /segments | Load Segments\n*ElasticEmail::SegmentsApi* | [**segments_post**](docs/SegmentsApi.md#segments_post) | **POST** /segments | Add Segment\n*ElasticEmail::StatisticsApi* | [**statistics_campaigns_by_name_get**](docs/StatisticsApi.md#statistics_campaigns_by_name_get) | **GET** /statistics/campaigns/{name} | Load Campaign Stats\n*ElasticEmail::StatisticsApi* | [**statistics_campaigns_get**](docs/StatisticsApi.md#statistics_campaigns_get) | **GET** /statistics/campaigns | Load Campaigns Stats\n*ElasticEmail::StatisticsApi* | [**statistics_channels_by_name_get**](docs/StatisticsApi.md#statistics_channels_by_name_get) | **GET** /statistics/channels/{name} | Load Channel Stats\n*ElasticEmail::StatisticsApi* | [**statistics_channels_get**](docs/StatisticsApi.md#statistics_channels_get) | **GET** /statistics/channels | Load Channels Stats\n*ElasticEmail::StatisticsApi* | [**statistics_get**](docs/StatisticsApi.md#statistics_get) | **GET** /statistics | Load Statistics\n*ElasticEmail::SubAccountsApi* | [**subaccounts_by_email_credits_patch**](docs/SubAccountsApi.md#subaccounts_by_email_credits_patch) | **PATCH** /subaccounts/{email}/credits | Add, Subtract Email Credits\n*ElasticEmail::SubAccountsApi* | [**subaccounts_by_email_delete**](docs/SubAccountsApi.md#subaccounts_by_email_delete) | **DELETE** /subaccounts/{email} | Delete SubAccount\n*ElasticEmail::SubAccountsApi* | [**subaccounts_by_email_get**](docs/SubAccountsApi.md#subaccounts_by_email_get) | **GET** /subaccounts/{email} | Load SubAccount\n*ElasticEmail::SubAccountsApi* | [**subaccounts_by_email_settings_email_put**](docs/SubAccountsApi.md#subaccounts_by_email_settings_email_put) | **PUT** /subaccounts/{email}/settings/email | Update SubAccount Email Settings\n*ElasticEmail::SubAccountsApi* | [**subaccounts_get**](docs/SubAccountsApi.md#subaccounts_get) | **GET** /subaccounts | Load SubAccounts\n*ElasticEmail::SubAccountsApi* | [**subaccounts_post**](docs/SubAccountsApi.md#subaccounts_post) | **POST** /subaccounts | Add SubAccount\n*ElasticEmail::SuppressionsApi* | [**suppressions_bounces_get**](docs/SuppressionsApi.md#suppressions_bounces_get) | **GET** /suppressions/bounces | Get Bounce List\n*ElasticEmail::SuppressionsApi* | [**suppressions_bounces_import_post**](docs/SuppressionsApi.md#suppressions_bounces_import_post) | **POST** /suppressions/bounces/import | Add Bounces Async\n*ElasticEmail::SuppressionsApi* | [**suppressions_bounces_post**](docs/SuppressionsApi.md#suppressions_bounces_post) | **POST** /suppressions/bounces | Add Bounces\n*ElasticEmail::SuppressionsApi* | [**suppressions_by_email_delete**](docs/SuppressionsApi.md#suppressions_by_email_delete) | **DELETE** /suppressions/{email} | Delete Suppression\n*ElasticEmail::SuppressionsApi* | [**suppressions_by_email_get**](docs/SuppressionsApi.md#suppressions_by_email_get) | **GET** /suppressions/{email} | Get Suppression\n*ElasticEmail::SuppressionsApi* | [**suppressions_complaints_get**](docs/SuppressionsApi.md#suppressions_complaints_get) | **GET** /suppressions/complaints | Get Complaints List\n*ElasticEmail::SuppressionsApi* | [**suppressions_complaints_import_post**](docs/SuppressionsApi.md#suppressions_complaints_import_post) | **POST** /suppressions/complaints/import | Add Complaints Async\n*ElasticEmail::SuppressionsApi* | [**suppressions_complaints_post**](docs/SuppressionsApi.md#suppressions_complaints_post) | **POST** /suppressions/complaints | Add Complaints\n*ElasticEmail::SuppressionsApi* | [**suppressions_get**](docs/SuppressionsApi.md#suppressions_get) | **GET** /suppressions | Get Suppressions\n*ElasticEmail::SuppressionsApi* | [**suppressions_unsubscribes_get**](docs/SuppressionsApi.md#suppressions_unsubscribes_get) | **GET** /suppressions/unsubscribes | Get Unsubscribes List\n*ElasticEmail::SuppressionsApi* | [**suppressions_unsubscribes_import_post**](docs/SuppressionsApi.md#suppressions_unsubscribes_import_post) | **POST** /suppressions/unsubscribes/import | Add Unsubscribes Async\n*ElasticEmail::SuppressionsApi* | [**suppressions_unsubscribes_post**](docs/SuppressionsApi.md#suppressions_unsubscribes_post) | **POST** /suppressions/unsubscribes | Add Unsubscribes\n*ElasticEmail::TemplatesApi* | [**templates_by_name_delete**](docs/TemplatesApi.md#templates_by_name_delete) | **DELETE** /templates/{name} | Delete Template\n*ElasticEmail::TemplatesApi* | [**templates_by_name_get**](docs/TemplatesApi.md#templates_by_name_get) | **GET** /templates/{name} | Load Template\n*ElasticEmail::TemplatesApi* | [**templates_by_name_put**](docs/TemplatesApi.md#templates_by_name_put) | **PUT** /templates/{name} | Update Template\n*ElasticEmail::TemplatesApi* | [**templates_get**](docs/TemplatesApi.md#templates_get) | **GET** /templates | Load Templates\n*ElasticEmail::TemplatesApi* | [**templates_post**](docs/TemplatesApi.md#templates_post) | **POST** /templates | Add Template\n*ElasticEmail::VerificationsApi* | [**verifications_by_email_delete**](docs/VerificationsApi.md#verifications_by_email_delete) | **DELETE** /verifications/{email} | Delete Email Verification Result\n*ElasticEmail::VerificationsApi* | [**verifications_by_email_get**](docs/VerificationsApi.md#verifications_by_email_get) | **GET** /verifications/{email} | Get Email Verification Result\n*ElasticEmail::VerificationsApi* | [**verifications_by_email_post**](docs/VerificationsApi.md#verifications_by_email_post) | **POST** /verifications/{email} | Verify Email\n*ElasticEmail::VerificationsApi* | [**verifications_files_by_id_delete**](docs/VerificationsApi.md#verifications_files_by_id_delete) | **DELETE** /verifications/files/{id} | Delete File Verification Result\n*ElasticEmail::VerificationsApi* | [**verifications_files_by_id_result_download_get**](docs/VerificationsApi.md#verifications_files_by_id_result_download_get) | **GET** /verifications/files/{id}/result/download | Download File Verification Result\n*ElasticEmail::VerificationsApi* | [**verifications_files_by_id_result_get**](docs/VerificationsApi.md#verifications_files_by_id_result_get) | **GET** /verifications/files/{id}/result | Get Detailed File Verification Result\n*ElasticEmail::VerificationsApi* | [**verifications_files_by_id_verification_post**](docs/VerificationsApi.md#verifications_files_by_id_verification_post) | **POST** /verifications/files/{id}/verification | Start verification\n*ElasticEmail::VerificationsApi* | [**verifications_files_post**](docs/VerificationsApi.md#verifications_files_post) | **POST** /verifications/files | Upload File with Emails\n*ElasticEmail::VerificationsApi* | [**verifications_files_result_get**](docs/VerificationsApi.md#verifications_files_result_get) | **GET** /verifications/files/result | Get Files Verification Results\n*ElasticEmail::VerificationsApi* | [**verifications_get**](docs/VerificationsApi.md#verifications_get) | **GET** /verifications | Get Emails Verification Results\n\n\n## Documentation for Models\n\n - [ElasticEmail::AccessLevel](docs/AccessLevel.md)\n - [ElasticEmail::AccountStatusEnum](docs/AccountStatusEnum.md)\n - [ElasticEmail::ApiKey](docs/ApiKey.md)\n - [ElasticEmail::ApiKeyPayload](docs/ApiKeyPayload.md)\n - [ElasticEmail::BodyContentType](docs/BodyContentType.md)\n - [ElasticEmail::BodyPart](docs/BodyPart.md)\n - [ElasticEmail::Campaign](docs/Campaign.md)\n - [ElasticEmail::CampaignOptions](docs/CampaignOptions.md)\n - [ElasticEmail::CampaignRecipient](docs/CampaignRecipient.md)\n - [ElasticEmail::CampaignStatus](docs/CampaignStatus.md)\n - [ElasticEmail::CampaignTemplate](docs/CampaignTemplate.md)\n - [ElasticEmail::CertificateValidationStatus](docs/CertificateValidationStatus.md)\n - [ElasticEmail::ChannelLogStatusSummary](docs/ChannelLogStatusSummary.md)\n - [ElasticEmail::CompressionFormat](docs/CompressionFormat.md)\n - [ElasticEmail::ConsentData](docs/ConsentData.md)\n - [ElasticEmail::ConsentTracking](docs/ConsentTracking.md)\n - [ElasticEmail::Contact](docs/Contact.md)\n - [ElasticEmail::ContactActivity](docs/ContactActivity.md)\n - [ElasticEmail::ContactPayload](docs/ContactPayload.md)\n - [ElasticEmail::ContactSource](docs/ContactSource.md)\n - [ElasticEmail::ContactStatus](docs/ContactStatus.md)\n - [ElasticEmail::ContactUpdatePayload](docs/ContactUpdatePayload.md)\n - [ElasticEmail::ContactsList](docs/ContactsList.md)\n - [ElasticEmail::DeliveryOptimizationType](docs/DeliveryOptimizationType.md)\n - [ElasticEmail::DomainData](docs/DomainData.md)\n - [ElasticEmail::DomainDetail](docs/DomainDetail.md)\n - [ElasticEmail::DomainOwner](docs/DomainOwner.md)\n - [ElasticEmail::DomainPayload](docs/DomainPayload.md)\n - [ElasticEmail::DomainUpdatePayload](docs/DomainUpdatePayload.md)\n - [ElasticEmail::EmailContent](docs/EmailContent.md)\n - [ElasticEmail::EmailData](docs/EmailData.md)\n - [ElasticEmail::EmailJobFailedStatus](docs/EmailJobFailedStatus.md)\n - [ElasticEmail::EmailJobStatus](docs/EmailJobStatus.md)\n - [ElasticEmail::EmailMessageData](docs/EmailMessageData.md)\n - [ElasticEmail::EmailPredictedValidationStatus](docs/EmailPredictedValidationStatus.md)\n - [ElasticEmail::EmailRecipient](docs/EmailRecipient.md)\n - [ElasticEmail::EmailSend](docs/EmailSend.md)\n - [ElasticEmail::EmailStatus](docs/EmailStatus.md)\n - [ElasticEmail::EmailTransactionalMessageData](docs/EmailTransactionalMessageData.md)\n - [ElasticEmail::EmailValidationResult](docs/EmailValidationResult.md)\n - [ElasticEmail::EmailValidationStatus](docs/EmailValidationStatus.md)\n - [ElasticEmail::EmailView](docs/EmailView.md)\n - [ElasticEmail::EmailsPayload](docs/EmailsPayload.md)\n - [ElasticEmail::EncodingType](docs/EncodingType.md)\n - [ElasticEmail::EventType](docs/EventType.md)\n - [ElasticEmail::EventsOrderBy](docs/EventsOrderBy.md)\n - [ElasticEmail::ExportFileFormats](docs/ExportFileFormats.md)\n - [ElasticEmail::ExportLink](docs/ExportLink.md)\n - [ElasticEmail::ExportStatus](docs/ExportStatus.md)\n - [ElasticEmail::FileInfo](docs/FileInfo.md)\n - [ElasticEmail::FilePayload](docs/FilePayload.md)\n - [ElasticEmail::FileUploadResult](docs/FileUploadResult.md)\n - [ElasticEmail::InboundPayload](docs/InboundPayload.md)\n - [ElasticEmail::InboundRoute](docs/InboundRoute.md)\n - [ElasticEmail::InboundRouteActionType](docs/InboundRouteActionType.md)\n - [ElasticEmail::InboundRouteFilterType](docs/InboundRouteFilterType.md)\n - [ElasticEmail::ListPayload](docs/ListPayload.md)\n - [ElasticEmail::ListUpdatePayload](docs/ListUpdatePayload.md)\n - [ElasticEmail::LogJobStatus](docs/LogJobStatus.md)\n - [ElasticEmail::LogStatusSummary](docs/LogStatusSummary.md)\n - [ElasticEmail::MergeEmailPayload](docs/MergeEmailPayload.md)\n - [ElasticEmail::MessageAttachment](docs/MessageAttachment.md)\n - [ElasticEmail::MessageCategory](docs/MessageCategory.md)\n - [ElasticEmail::MessageCategoryEnum](docs/MessageCategoryEnum.md)\n - [ElasticEmail::NewApiKey](docs/NewApiKey.md)\n - [ElasticEmail::NewSmtpCredentials](docs/NewSmtpCredentials.md)\n - [ElasticEmail::Options](docs/Options.md)\n - [ElasticEmail::RecipientEvent](docs/RecipientEvent.md)\n - [ElasticEmail::Segment](docs/Segment.md)\n - [ElasticEmail::SegmentPayload](docs/SegmentPayload.md)\n - [ElasticEmail::SmtpCredentials](docs/SmtpCredentials.md)\n - [ElasticEmail::SmtpCredentialsPayload](docs/SmtpCredentialsPayload.md)\n - [ElasticEmail::SortOrderItem](docs/SortOrderItem.md)\n - [ElasticEmail::SplitOptimizationType](docs/SplitOptimizationType.md)\n - [ElasticEmail::SplitOptions](docs/SplitOptions.md)\n - [ElasticEmail::SubAccountInfo](docs/SubAccountInfo.md)\n - [ElasticEmail::SubaccountEmailCreditsPayload](docs/SubaccountEmailCreditsPayload.md)\n - [ElasticEmail::SubaccountEmailSettings](docs/SubaccountEmailSettings.md)\n - [ElasticEmail::SubaccountEmailSettingsPayload](docs/SubaccountEmailSettingsPayload.md)\n - [ElasticEmail::SubaccountPayload](docs/SubaccountPayload.md)\n - [ElasticEmail::SubaccountSettingsInfo](docs/SubaccountSettingsInfo.md)\n - [ElasticEmail::SubaccountSettingsInfoPayload](docs/SubaccountSettingsInfoPayload.md)\n - [ElasticEmail::Suppression](docs/Suppression.md)\n - [ElasticEmail::Template](docs/Template.md)\n - [ElasticEmail::TemplatePayload](docs/TemplatePayload.md)\n - [ElasticEmail::TemplateScope](docs/TemplateScope.md)\n - [ElasticEmail::TemplateType](docs/TemplateType.md)\n - [ElasticEmail::TrackingType](docs/TrackingType.md)\n - [ElasticEmail::TrackingValidationStatus](docs/TrackingValidationStatus.md)\n - [ElasticEmail::TransactionalRecipient](docs/TransactionalRecipient.md)\n - [ElasticEmail::Utm](docs/Utm.md)\n - [ElasticEmail::VerificationFileResult](docs/VerificationFileResult.md)\n - [ElasticEmail::VerificationFileResultDetails](docs/VerificationFileResultDetails.md)\n - [ElasticEmail::VerificationStatus](docs/VerificationStatus.md)\n\n\n## Documentation for Authorization\n\n\nAuthentication schemes defined for the API:\n### apikey\n\n\n- **Type**: API key\n- **API key parameter name**: X-ElasticEmail-ApiKey\n- **Location**: HTTP header\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felasticemail%2Felasticemail-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felasticemail%2Felasticemail-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felasticemail%2Felasticemail-ruby/lists"}