mailslurp_client 4.3.3 → 7.2.5

data/LICENSE

@@ -1,22 +0,0 @@
-
-MIT License
-
-Copyright (c) MailSlurp, PettmanOU
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

data/README.md

@@ -1,126 +0,0 @@
-# mailslurp_client
-
-MailSlurpClient - the Ruby gem for the MailSlurp API
-
-For documentation see [developer guide](https://www.mailslurp.com/developers). [Create an account](https://app.mailslurp.com) in the MailSlurp Dashboard to [view your API Key](https://app). For all bugs, feature requests, or help please [see support](https://www.mailslurp.com/support/).
-
-This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
-
-- API version: 0.0.1-alpha
-- Package version: 4.3.3
-- Build package: org.openapitools.codegen.languages.RubyClientCodegen
-For more information, please visit [https://www.mailslurp.com](https://www.mailslurp.com)
-
-## Installation
-
-### Build a gem
-
-To build the Ruby code into a gem:
-
-```shell
-gem build mailslurp_client.gemspec
-```
-
-Then either install the gem locally:
-
-```shell
-gem install ./mailslurp_client-4.3.3.gem
-```
-(for development, run `gem install --dev ./mailslurp_client-4.3.3.gem` to install the development dependencies)
-
-or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
-
-Finally add this to the Gemfile:
-
-    gem 'mailslurp_client', '~> 4.3.3'
-
-### Install from Git
-
-If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
-
-    gem 'mailslurp_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
-
-### Include the Ruby code directly
-
-Include the Ruby code directly using `-I` as follows:
-
-```shell
-ruby -Ilib script.rb
-```
-
-## Getting Started
-
-Please follow the [installation](#installation) procedure and then run the following code:
-```ruby
-# Load the gem
-require 'mailslurp_client'
-
-# Setup authorization
-MailSlurpClient.configure do |config|
-  # Configure API key authorization: API_KEY
-  config.api_key['x-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['x-api-key'] = 'Bearer'
-end
-
-api_instance = MailSlurpClient::CommonOperationsApi.new
-
-begin
-  #Create new email address
-  result = api_instance.create_new_email_address
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling CommonOperationsApi->create_new_email_address: #{e}"
-end
-
-```
-
-## Documentation for API Endpoints
-
-All URIs are relative to *https://api.mailslurp.com*
-
-Class | Method | HTTP request | Description
------------- | ------------- | ------------- | -------------
-*MailSlurpClient::CommonOperationsApi* | [**create_new_email_address**](docs/CommonOperationsApi.md#create_new_email_address) | **POST** /newEmailAddress | Create new email address
-*MailSlurpClient::CommonOperationsApi* | [**send_email_simple**](docs/CommonOperationsApi.md#send_email_simple) | **POST** /sendEmail | Send an email from a random email address
-*MailSlurpClient::CommonOperationsApi* | [**wait_for_latest_email**](docs/CommonOperationsApi.md#wait_for_latest_email) | **GET** /fetchLatestEmail | Fetch inbox's latest email or if empty wait for email to arrive
-*MailSlurpClient::ExtraOperationsApi* | [**bulk_create_inboxes**](docs/ExtraOperationsApi.md#bulk_create_inboxes) | **POST** /bulk/inboxes | Bulk create Inboxes (email addresses)
-*MailSlurpClient::ExtraOperationsApi* | [**bulk_delete_inboxes**](docs/ExtraOperationsApi.md#bulk_delete_inboxes) | **DELETE** /bulk/inboxes | Bulk Delete Inboxes
-*MailSlurpClient::ExtraOperationsApi* | [**bulk_send_emails**](docs/ExtraOperationsApi.md#bulk_send_emails) | **POST** /bulk/send | Bulk Send Emails
-*MailSlurpClient::ExtraOperationsApi* | [**create_inbox**](docs/ExtraOperationsApi.md#create_inbox) | **POST** /inboxes | Create an Inbox (email address)
-*MailSlurpClient::ExtraOperationsApi* | [**create_webhook**](docs/ExtraOperationsApi.md#create_webhook) | **POST** /inboxes/{inboxId}/webhooks | Attach a WebHook URL to an inbox
-*MailSlurpClient::ExtraOperationsApi* | [**delete_email**](docs/ExtraOperationsApi.md#delete_email) | **DELETE** /emails/{emailId} | Delete Email
-*MailSlurpClient::ExtraOperationsApi* | [**delete_inbox**](docs/ExtraOperationsApi.md#delete_inbox) | **DELETE** /inboxes/{inboxId} | Delete Inbox / Email Address
-*MailSlurpClient::ExtraOperationsApi* | [**delete_webhook**](docs/ExtraOperationsApi.md#delete_webhook) | **DELETE** /inboxes/{inboxId}/webhooks/{webhookId} | Delete and disable a WebHook for an Inbox
-*MailSlurpClient::ExtraOperationsApi* | [**download_attachment**](docs/ExtraOperationsApi.md#download_attachment) | **GET** /emails/{emailId}/attachments/{attachmentId} | Get email attachment
-*MailSlurpClient::ExtraOperationsApi* | [**get_email**](docs/ExtraOperationsApi.md#get_email) | **GET** /emails/{emailId} | Get Email Content
-*MailSlurpClient::ExtraOperationsApi* | [**get_emails**](docs/ExtraOperationsApi.md#get_emails) | **GET** /inboxes/{inboxId}/emails | List Emails in an Inbox / EmailAddress
-*MailSlurpClient::ExtraOperationsApi* | [**get_inbox**](docs/ExtraOperationsApi.md#get_inbox) | **GET** /inboxes/{inboxId} | Get Inbox / EmailAddress
-*MailSlurpClient::ExtraOperationsApi* | [**get_inboxes**](docs/ExtraOperationsApi.md#get_inboxes) | **GET** /inboxes | List Inboxes / Email Addresses
-*MailSlurpClient::ExtraOperationsApi* | [**get_raw_email_contents**](docs/ExtraOperationsApi.md#get_raw_email_contents) | **GET** /emails/{emailId}/raw | Get Raw Email Content
-*MailSlurpClient::ExtraOperationsApi* | [**get_webhooks**](docs/ExtraOperationsApi.md#get_webhooks) | **GET** /inboxes/{inboxId}/webhooks | Get all WebHooks for an Inbox
-*MailSlurpClient::ExtraOperationsApi* | [**send_email**](docs/ExtraOperationsApi.md#send_email) | **POST** /inboxes/{inboxId} | Send Email
-
-
-## Documentation for Models
-
- - [MailSlurpClient::BasicAuthOptions](docs/BasicAuthOptions.md)
- - [MailSlurpClient::BulkSendEmailOptions](docs/BulkSendEmailOptions.md)
- - [MailSlurpClient::CreateWebhookOptions](docs/CreateWebhookOptions.md)
- - [MailSlurpClient::Email](docs/Email.md)
- - [MailSlurpClient::EmailAnalysis](docs/EmailAnalysis.md)
- - [MailSlurpClient::EmailPreview](docs/EmailPreview.md)
- - [MailSlurpClient::Inbox](docs/Inbox.md)
- - [MailSlurpClient::SendEmailOptions](docs/SendEmailOptions.md)
- - [MailSlurpClient::Webhook](docs/Webhook.md)
-
-
-## Documentation for Authorization
-
-
-### API_KEY
-
-- **Type**: API key
-- **API key parameter name**: x-api-key
-- **Location**: HTTP header
-

data/Rakefile

@@ -1,10 +0,0 @@
-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/BasicAuthOptions.md

@@ -1,9 +0,0 @@
-# MailSlurpClient::BasicAuthOptions
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**username** | **String** |  | 
-**password** | **String** |  | 
-
-

data/docs/BulkSendEmailOptions.md

@@ -1,9 +0,0 @@
-# MailSlurpClient::BulkSendEmailOptions
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**inbox_ids** | **Array<String>** | Inboxes to send from | [optional] 
-**send_email_options** | [**SendEmailOptions**](SendEmailOptions.md) |  | 
-
-

data/docs/CommonOperationsApi.md

@@ -1,166 +0,0 @@
-# MailSlurpClient::CommonOperationsApi
-
-All URIs are relative to *https://api.mailslurp.com*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create_new_email_address**](CommonOperationsApi.md#create_new_email_address) | **POST** /newEmailAddress | Create new email address
-[**send_email_simple**](CommonOperationsApi.md#send_email_simple) | **POST** /sendEmail | Send an email from a random email address
-[**wait_for_latest_email**](CommonOperationsApi.md#wait_for_latest_email) | **GET** /fetchLatestEmail | Fetch inbox's latest email or if empty wait for email to arrive
-
-
-# **create_new_email_address**
-> Inbox create_new_email_address
-
-Create new email address
-
-Returns an Inbox with an `id` and an `emailAddress`
-
-### Example
-```ruby
-# load the gem
-require 'mailslurp_client'
-# setup authorization
-MailSlurpClient.configure do |config|
-  # Configure API key authorization: API_KEY
-  config.api_key['x-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['x-api-key'] = 'Bearer'
-end
-
-api_instance = MailSlurpClient::CommonOperationsApi.new
-
-begin
-  #Create new email address
-  result = api_instance.create_new_email_address
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling CommonOperationsApi->create_new_email_address: #{e}"
-end
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-[**Inbox**](Inbox.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **send_email_simple**
-> send_email_simple(send_email_options)
-
-Send an email from a random email address
-
-To specify an email address first create an inbox and use that with the other send email methods
-
-### Example
-```ruby
-# load the gem
-require 'mailslurp_client'
-# setup authorization
-MailSlurpClient.configure do |config|
-  # Configure API key authorization: API_KEY
-  config.api_key['x-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['x-api-key'] = 'Bearer'
-end
-
-api_instance = MailSlurpClient::CommonOperationsApi.new
-send_email_options = MailSlurpClient::SendEmailOptions.new # SendEmailOptions | sendEmailOptions
-
-begin
-  #Send an email from a random email address
-  api_instance.send_email_simple(send_email_options)
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling CommonOperationsApi->send_email_simple: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **send_email_options** | [**SendEmailOptions**](SendEmailOptions.md)| sendEmailOptions | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: Not defined
-
-
-
-# **wait_for_latest_email**
-> Email wait_for_latest_email(opts)
-
-Fetch inbox's latest email or if empty wait for email to arrive
-
-Will return either the last received email or wait for an email to arrive and return that. If you need to wait for an email for a non-empty inbox see the other receive methods.
-
-### Example
-```ruby
-# load the gem
-require 'mailslurp_client'
-# setup authorization
-MailSlurpClient.configure do |config|
-  # Configure API key authorization: API_KEY
-  config.api_key['x-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['x-api-key'] = 'Bearer'
-end
-
-api_instance = MailSlurpClient::CommonOperationsApi.new
-opts = {
-  inbox_email_address: 'inbox_email_address_example', # String | Email address of the inbox we are fetching emails from
-  inbox_id: 'inbox_id_example' # String | Id of the inbox we are fetching emails from
-}
-
-begin
-  #Fetch inbox's latest email or if empty wait for email to arrive
-  result = api_instance.wait_for_latest_email(opts)
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling CommonOperationsApi->wait_for_latest_email: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **inbox_email_address** | **String**| Email address of the inbox we are fetching emails from | [optional] 
- **inbox_id** | [**String**](.md)| Id of the inbox we are fetching emails from | [optional] 
-
-### Return type
-
-[**Email**](Email.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-

data/docs/CreateWebhookOptions.md

@@ -1,10 +0,0 @@
-# MailSlurpClient::CreateWebhookOptions
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**basic_auth** | [**BasicAuthOptions**](BasicAuthOptions.md) |  | [optional] 
-**url** | **String** | Public URL (including protocol) that MailSlurp can post WebhookNotificationObjects to when an email is received | [optional] 
-**name** | **String** |  | [optional] 
-
-

data/docs/Email.md

@@ -1,22 +0,0 @@
-# MailSlurpClient::Email
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**analysis** | [**EmailAnalysis**](EmailAnalysis.md) |  | [optional] 
-**attachments** | **Array<String>** |  | [optional] 
-**bcc** | **Array<String>** |  | [optional] 
-**body** | **String** |  | [optional] 
-**cc** | **Array<String>** |  | [optional] 
-**created_at** | **DateTime** |  | 
-**from** | **String** |  | [optional] 
-**headers** | **Hash<String, String>** |  | [optional] 
-**id** | **String** |  | 
-**inbox_id** | **String** |  | 
-**raw_url** | **String** |  | [optional] 
-**subject** | **String** |  | [optional] 
-**to** | **Array<String>** |  | 
-**updated_at** | **DateTime** |  | 
-**user_id** | **String** |  | 
-
-

data/docs/EmailAnalysis.md

@@ -1,12 +0,0 @@
-# MailSlurpClient::EmailAnalysis
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**dkim_verdict** | **String** |  | 
-**dmarc_verdict** | **String** |  | 
-**spam_verdict** | **String** |  | 
-**spf_verdict** | **String** |  | 
-**virus_verdict** | **String** |  | 
-
-

data/docs/EmailPreview.md

@@ -1,9 +0,0 @@
-# MailSlurpClient::EmailPreview
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**created** | **DateTime** |  | 
-**id** | **String** |  | 
-
-

data/docs/ExtraOperationsApi.md

@@ -1,855 +0,0 @@
-# MailSlurpClient::ExtraOperationsApi
-
-All URIs are relative to *https://api.mailslurp.com*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**bulk_create_inboxes**](ExtraOperationsApi.md#bulk_create_inboxes) | **POST** /bulk/inboxes | Bulk create Inboxes (email addresses)
-[**bulk_delete_inboxes**](ExtraOperationsApi.md#bulk_delete_inboxes) | **DELETE** /bulk/inboxes | Bulk Delete Inboxes
-[**bulk_send_emails**](ExtraOperationsApi.md#bulk_send_emails) | **POST** /bulk/send | Bulk Send Emails
-[**create_inbox**](ExtraOperationsApi.md#create_inbox) | **POST** /inboxes | Create an Inbox (email address)
-[**create_webhook**](ExtraOperationsApi.md#create_webhook) | **POST** /inboxes/{inboxId}/webhooks | Attach a WebHook URL to an inbox
-[**delete_email**](ExtraOperationsApi.md#delete_email) | **DELETE** /emails/{emailId} | Delete Email
-[**delete_inbox**](ExtraOperationsApi.md#delete_inbox) | **DELETE** /inboxes/{inboxId} | Delete Inbox / Email Address
-[**delete_webhook**](ExtraOperationsApi.md#delete_webhook) | **DELETE** /inboxes/{inboxId}/webhooks/{webhookId} | Delete and disable a WebHook for an Inbox
-[**download_attachment**](ExtraOperationsApi.md#download_attachment) | **GET** /emails/{emailId}/attachments/{attachmentId} | Get email attachment
-[**get_email**](ExtraOperationsApi.md#get_email) | **GET** /emails/{emailId} | Get Email Content
-[**get_emails**](ExtraOperationsApi.md#get_emails) | **GET** /inboxes/{inboxId}/emails | List Emails in an Inbox / EmailAddress
-[**get_inbox**](ExtraOperationsApi.md#get_inbox) | **GET** /inboxes/{inboxId} | Get Inbox / EmailAddress
-[**get_inboxes**](ExtraOperationsApi.md#get_inboxes) | **GET** /inboxes | List Inboxes / Email Addresses
-[**get_raw_email_contents**](ExtraOperationsApi.md#get_raw_email_contents) | **GET** /emails/{emailId}/raw | Get Raw Email Content
-[**get_webhooks**](ExtraOperationsApi.md#get_webhooks) | **GET** /inboxes/{inboxId}/webhooks | Get all WebHooks for an Inbox
-[**send_email**](ExtraOperationsApi.md#send_email) | **POST** /inboxes/{inboxId} | Send Email
-
-
-# **bulk_create_inboxes**
-> Array<Inbox> bulk_create_inboxes(count)
-
-Bulk create Inboxes (email addresses)
-
-Enterprise Plan Required
-
-### Example
-```ruby
-# load the gem
-require 'mailslurp_client'
-# setup authorization
-MailSlurpClient.configure do |config|
-  # Configure API key authorization: API_KEY
-  config.api_key['x-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['x-api-key'] = 'Bearer'
-end
-
-api_instance = MailSlurpClient::ExtraOperationsApi.new
-count = 56 # Integer | Number of inboxes to be created in bulk
-
-begin
-  #Bulk create Inboxes (email addresses)
-  result = api_instance.bulk_create_inboxes(count)
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling ExtraOperationsApi->bulk_create_inboxes: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **count** | **Integer**| Number of inboxes to be created in bulk | 
-
-### Return type
-
-[**Array<Inbox>**](Inbox.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **bulk_delete_inboxes**
-> bulk_delete_inboxes(request_body)
-
-Bulk Delete Inboxes
-
-Enterprise Plan Required
-
-### Example
-```ruby
-# load the gem
-require 'mailslurp_client'
-# setup authorization
-MailSlurpClient.configure do |config|
-  # Configure API key authorization: API_KEY
-  config.api_key['x-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['x-api-key'] = 'Bearer'
-end
-
-api_instance = MailSlurpClient::ExtraOperationsApi.new
-request_body = nil # Array<String> | ids
-
-begin
-  #Bulk Delete Inboxes
-  api_instance.bulk_delete_inboxes(request_body)
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling ExtraOperationsApi->bulk_delete_inboxes: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **request_body** | [**Array&lt;String&gt;**](Array.md)| ids | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: Not defined
-
-
-
-# **bulk_send_emails**
-> bulk_send_emails(bulk_send_email_options)
-
-Bulk Send Emails
-
-Enterprise Plan Required
-
-### Example
-```ruby
-# load the gem
-require 'mailslurp_client'
-# setup authorization
-MailSlurpClient.configure do |config|
-  # Configure API key authorization: API_KEY
-  config.api_key['x-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['x-api-key'] = 'Bearer'
-end
-
-api_instance = MailSlurpClient::ExtraOperationsApi.new
-bulk_send_email_options = MailSlurpClient::BulkSendEmailOptions.new # BulkSendEmailOptions | bulkSendEmailOptions
-
-begin
-  #Bulk Send Emails
-  api_instance.bulk_send_emails(bulk_send_email_options)
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling ExtraOperationsApi->bulk_send_emails: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **bulk_send_email_options** | [**BulkSendEmailOptions**](BulkSendEmailOptions.md)| bulkSendEmailOptions | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: Not defined
-
-
-
-# **create_inbox**
-> Inbox create_inbox
-
-Create an Inbox (email address)
-
-Create a new inbox and ephemeral email address to send and receive from. This is a necessary step before sending or receiving emails. The response contains the inbox's ID and its associated email address. It is recommended that you create a new inbox during each test method so that it is unique and empty
-
-### Example
-```ruby
-# load the gem
-require 'mailslurp_client'
-# setup authorization
-MailSlurpClient.configure do |config|
-  # Configure API key authorization: API_KEY
-  config.api_key['x-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['x-api-key'] = 'Bearer'
-end
-
-api_instance = MailSlurpClient::ExtraOperationsApi.new
-
-begin
-  #Create an Inbox (email address)
-  result = api_instance.create_inbox
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling ExtraOperationsApi->create_inbox: #{e}"
-end
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-[**Inbox**](Inbox.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **create_webhook**
-> Webhook create_webhook(inbox_id, create_webhook_options)
-
-Attach a WebHook URL to an inbox
-
-Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint.
-
-### Example
-```ruby
-# load the gem
-require 'mailslurp_client'
-# setup authorization
-MailSlurpClient.configure do |config|
-  # Configure API key authorization: API_KEY
-  config.api_key['x-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['x-api-key'] = 'Bearer'
-end
-
-api_instance = MailSlurpClient::ExtraOperationsApi.new
-inbox_id = 'inbox_id_example' # String | inboxId
-create_webhook_options = MailSlurpClient::CreateWebhookOptions.new # CreateWebhookOptions | options
-
-begin
-  #Attach a WebHook URL to an inbox
-  result = api_instance.create_webhook(inbox_id, create_webhook_options)
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling ExtraOperationsApi->create_webhook: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **inbox_id** | [**String**](.md)| inboxId | 
- **create_webhook_options** | [**CreateWebhookOptions**](CreateWebhookOptions.md)| options | 
-
-### Return type
-
-[**Webhook**](Webhook.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **delete_email**
-> delete_email(email_id)
-
-Delete Email
-
-Deletes an email and removes it from the inbox
-
-### Example
-```ruby
-# load the gem
-require 'mailslurp_client'
-# setup authorization
-MailSlurpClient.configure do |config|
-  # Configure API key authorization: API_KEY
-  config.api_key['x-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['x-api-key'] = 'Bearer'
-end
-
-api_instance = MailSlurpClient::ExtraOperationsApi.new
-email_id = 'email_id_example' # String | emailId
-
-begin
-  #Delete Email
-  api_instance.delete_email(email_id)
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling ExtraOperationsApi->delete_email: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **email_id** | [**String**](.md)| emailId | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-
-# **delete_inbox**
-> delete_inbox(inbox_id)
-
-Delete Inbox / Email Address
-
-Permanently delete an inbox and associated email address
-
-### Example
-```ruby
-# load the gem
-require 'mailslurp_client'
-# setup authorization
-MailSlurpClient.configure do |config|
-  # Configure API key authorization: API_KEY
-  config.api_key['x-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['x-api-key'] = 'Bearer'
-end
-
-api_instance = MailSlurpClient::ExtraOperationsApi.new
-inbox_id = 'inbox_id_example' # String | inboxId
-
-begin
-  #Delete Inbox / Email Address
-  api_instance.delete_inbox(inbox_id)
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling ExtraOperationsApi->delete_inbox: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **inbox_id** | [**String**](.md)| inboxId | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-
-# **delete_webhook**
-> delete_webhook(inbox_id, webhook_id)
-
-Delete and disable a WebHook for an Inbox
-
-### Example
-```ruby
-# load the gem
-require 'mailslurp_client'
-# setup authorization
-MailSlurpClient.configure do |config|
-  # Configure API key authorization: API_KEY
-  config.api_key['x-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['x-api-key'] = 'Bearer'
-end
-
-api_instance = MailSlurpClient::ExtraOperationsApi.new
-inbox_id = 'inbox_id_example' # String | inboxId
-webhook_id = 'webhook_id_example' # String | webhookId
-
-begin
-  #Delete and disable a WebHook for an Inbox
-  api_instance.delete_webhook(inbox_id, webhook_id)
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling ExtraOperationsApi->delete_webhook: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **inbox_id** | [**String**](.md)| inboxId | 
- **webhook_id** | [**String**](.md)| webhookId | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-
-# **download_attachment**
-> download_attachment(attachment_id, email_id)
-
-Get email attachment
-
-Returns the specified attachment for a given email as a byte stream (file download). Get the attachmentId from the email response. Requires enterprise account.
-
-### Example
-```ruby
-# load the gem
-require 'mailslurp_client'
-# setup authorization
-MailSlurpClient.configure do |config|
-  # Configure API key authorization: API_KEY
-  config.api_key['x-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['x-api-key'] = 'Bearer'
-end
-
-api_instance = MailSlurpClient::ExtraOperationsApi.new
-attachment_id = 'attachment_id_example' # String | attachmentId
-email_id = 'email_id_example' # String | emailId
-
-begin
-  #Get email attachment
-  api_instance.download_attachment(attachment_id, email_id)
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling ExtraOperationsApi->download_attachment: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **attachment_id** | **String**| attachmentId | 
- **email_id** | [**String**](.md)| emailId | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-
-# **get_email**
-> Email get_email(email_id)
-
-Get Email Content
-
-Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawMessage endpoint
-
-### Example
-```ruby
-# load the gem
-require 'mailslurp_client'
-# setup authorization
-MailSlurpClient.configure do |config|
-  # Configure API key authorization: API_KEY
-  config.api_key['x-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['x-api-key'] = 'Bearer'
-end
-
-api_instance = MailSlurpClient::ExtraOperationsApi.new
-email_id = 'email_id_example' # String | emailId
-
-begin
-  #Get Email Content
-  result = api_instance.get_email(email_id)
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling ExtraOperationsApi->get_email: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **email_id** | [**String**](.md)| emailId | 
-
-### Return type
-
-[**Email**](Email.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **get_emails**
-> Array&lt;EmailPreview&gt; get_emails(inbox_id, opts)
-
-List Emails in an Inbox / EmailAddress
-
-List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the `minCount` parameter. The server will retry the inbox database until the `minCount` is satisfied or the `retryTimeout` is reached
-
-### Example
-```ruby
-# load the gem
-require 'mailslurp_client'
-# setup authorization
-MailSlurpClient.configure do |config|
-  # Configure API key authorization: API_KEY
-  config.api_key['x-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['x-api-key'] = 'Bearer'
-end
-
-api_instance = MailSlurpClient::ExtraOperationsApi.new
-inbox_id = 'inbox_id_example' # String | Id of inbox that emails belongs to
-opts = {
-  limit: 56, # Integer | Limit the result set, ordered by descending received date time
-  min_count: 56, # Integer | Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.
-  retry_timeout: 56, # Integer | Maximum milliseconds to spend retrying inbox database until minCount emails are returned
-  since: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Exclude emails received before this ISO 8601 date time
-}
-
-begin
-  #List Emails in an Inbox / EmailAddress
-  result = api_instance.get_emails(inbox_id, opts)
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling ExtraOperationsApi->get_emails: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **inbox_id** | [**String**](.md)| Id of inbox that emails belongs to | 
- **limit** | **Integer**| Limit the result set, ordered by descending received date time | [optional] 
- **min_count** | **Integer**| Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached. | [optional] 
- **retry_timeout** | **Integer**| Maximum milliseconds to spend retrying inbox database until minCount emails are returned | [optional] 
- **since** | **DateTime**| Exclude emails received before this ISO 8601 date time | [optional] 
-
-### Return type
-
-[**Array&lt;EmailPreview&gt;**](EmailPreview.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **get_inbox**
-> Inbox get_inbox(inbox_id)
-
-Get Inbox / EmailAddress
-
-Returns an inbox's properties, including its email address and ID.
-
-### Example
-```ruby
-# load the gem
-require 'mailslurp_client'
-# setup authorization
-MailSlurpClient.configure do |config|
-  # Configure API key authorization: API_KEY
-  config.api_key['x-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['x-api-key'] = 'Bearer'
-end
-
-api_instance = MailSlurpClient::ExtraOperationsApi.new
-inbox_id = 'inbox_id_example' # String | inboxId
-
-begin
-  #Get Inbox / EmailAddress
-  result = api_instance.get_inbox(inbox_id)
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling ExtraOperationsApi->get_inbox: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **inbox_id** | [**String**](.md)| inboxId | 
-
-### Return type
-
-[**Inbox**](Inbox.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **get_inboxes**
-> Array&lt;Inbox&gt; get_inboxes
-
-List Inboxes / Email Addresses
-
-List the inboxes you have created
-
-### Example
-```ruby
-# load the gem
-require 'mailslurp_client'
-# setup authorization
-MailSlurpClient.configure do |config|
-  # Configure API key authorization: API_KEY
-  config.api_key['x-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['x-api-key'] = 'Bearer'
-end
-
-api_instance = MailSlurpClient::ExtraOperationsApi.new
-
-begin
-  #List Inboxes / Email Addresses
-  result = api_instance.get_inboxes
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling ExtraOperationsApi->get_inboxes: #{e}"
-end
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-[**Array&lt;Inbox&gt;**](Inbox.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **get_raw_email_contents**
-> String get_raw_email_contents(email_id)
-
-Get Raw Email Content
-
-Returns a raw, unparsed and unprocessed email
-
-### Example
-```ruby
-# load the gem
-require 'mailslurp_client'
-# setup authorization
-MailSlurpClient.configure do |config|
-  # Configure API key authorization: API_KEY
-  config.api_key['x-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['x-api-key'] = 'Bearer'
-end
-
-api_instance = MailSlurpClient::ExtraOperationsApi.new
-email_id = 'email_id_example' # String | emailId
-
-begin
-  #Get Raw Email Content
-  result = api_instance.get_raw_email_contents(email_id)
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling ExtraOperationsApi->get_raw_email_contents: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **email_id** | [**String**](.md)| emailId | 
-
-### Return type
-
-**String**
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **get_webhooks**
-> Array&lt;Webhook&gt; get_webhooks(inbox_id)
-
-Get all WebHooks for an Inbox
-
-### Example
-```ruby
-# load the gem
-require 'mailslurp_client'
-# setup authorization
-MailSlurpClient.configure do |config|
-  # Configure API key authorization: API_KEY
-  config.api_key['x-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['x-api-key'] = 'Bearer'
-end
-
-api_instance = MailSlurpClient::ExtraOperationsApi.new
-inbox_id = 'inbox_id_example' # String | inboxId
-
-begin
-  #Get all WebHooks for an Inbox
-  result = api_instance.get_webhooks(inbox_id)
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling ExtraOperationsApi->get_webhooks: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **inbox_id** | [**String**](.md)| inboxId | 
-
-### Return type
-
-[**Array&lt;Webhook&gt;**](Webhook.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **send_email**
-> send_email(inbox_id, send_email_options)
-
-Send Email
-
-Send an email from the inbox's email address. Specify the email recipients and contents in the request body. See the `SendEmailOptions` for more information. Note the `inboxId` refers to the inbox's id NOT its email address
-
-### Example
-```ruby
-# load the gem
-require 'mailslurp_client'
-# setup authorization
-MailSlurpClient.configure do |config|
-  # Configure API key authorization: API_KEY
-  config.api_key['x-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['x-api-key'] = 'Bearer'
-end
-
-api_instance = MailSlurpClient::ExtraOperationsApi.new
-inbox_id = 'inbox_id_example' # String | inboxId
-send_email_options = MailSlurpClient::SendEmailOptions.new # SendEmailOptions | sendEmailOptions
-
-begin
-  #Send Email
-  api_instance.send_email(inbox_id, send_email_options)
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling ExtraOperationsApi->send_email: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **inbox_id** | [**String**](.md)| inboxId | 
- **send_email_options** | [**SendEmailOptions**](SendEmailOptions.md)| sendEmailOptions | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: Not defined
-
-
-