mailslurp_client 5.0.0 → 7.2.6

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,139 +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: 5.0.0
-- 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-5.0.0.gem
-```
-(for development, run `gem install --dev ./mailslurp_client-5.0.0.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', '~> 5.0.0'
-
-### 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* | [**delete_email**](docs/CommonOperationsApi.md#delete_email) | **DELETE** /deleteEmail | Delete an email
-*MailSlurpClient::CommonOperationsApi* | [**delete_email_address**](docs/CommonOperationsApi.md#delete_email_address) | **DELETE** /deleteEmailAddress | Delete email address and its emails
-*MailSlurpClient::CommonOperationsApi* | [**empty_inbox**](docs/CommonOperationsApi.md#empty_inbox) | **DELETE** /emptyInbox | Delete all emails in an inbox
-*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_email_count**](docs/CommonOperationsApi.md#wait_for_email_count) | **GET** /waitForEmailCount | Wait for and return count number of emails 
-*MailSlurpClient::CommonOperationsApi* | [**wait_for_latest_email**](docs/CommonOperationsApi.md#wait_for_latest_email) | **GET** /waitForLatestEmail | Fetch inbox's latest email or if empty wait for email to arrive
-*MailSlurpClient::CommonOperationsApi* | [**wait_for_matching_email**](docs/CommonOperationsApi.md#wait_for_matching_email) | **POST** /waitForMatchingEmails | Wait or return list of emails that match simple matching patterns
-*MailSlurpClient::CommonOperationsApi* | [**wait_for_nth_email**](docs/CommonOperationsApi.md#wait_for_nth_email) | **GET** /waitForNthEmail | Wait for or fetch the email with a given index in the inbox specified
-*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_email1**](docs/ExtraOperationsApi.md#delete_email1) | **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* | [**forward_email**](docs/ExtraOperationsApi.md#forward_email) | **POST** /emails/{emailId}/forward | Forward Email
-*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
-*MailSlurpClient::ExtraOperationsApi* | [**upload_attachment**](docs/ExtraOperationsApi.md#upload_attachment) | **POST** /attachments | Upload an attachment for sending
-*MailSlurpClient::ExtraOperationsApi* | [**upload_multipart_form**](docs/ExtraOperationsApi.md#upload_multipart_form) | **POST** /attachments/multipart | Upload an attachment for sending using Multipart Form
-
-
-## 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::ForwardEmailOptions](docs/ForwardEmailOptions.md)
- - [MailSlurpClient::Inbox](docs/Inbox.md)
- - [MailSlurpClient::MatchOption](docs/MatchOption.md)
- - [MailSlurpClient::MatchOptions](docs/MatchOptions.md)
- - [MailSlurpClient::SendEmailOptions](docs/SendEmailOptions.md)
- - [MailSlurpClient::UploadAttachmentOptions](docs/UploadAttachmentOptions.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,499 +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
-[**delete_email**](CommonOperationsApi.md#delete_email) | **DELETE** /deleteEmail | Delete an email
-[**delete_email_address**](CommonOperationsApi.md#delete_email_address) | **DELETE** /deleteEmailAddress | Delete email address and its emails
-[**empty_inbox**](CommonOperationsApi.md#empty_inbox) | **DELETE** /emptyInbox | Delete all emails in an inbox
-[**send_email_simple**](CommonOperationsApi.md#send_email_simple) | **POST** /sendEmail | Send an email from a random email address
-[**wait_for_email_count**](CommonOperationsApi.md#wait_for_email_count) | **GET** /waitForEmailCount | Wait for and return count number of emails 
-[**wait_for_latest_email**](CommonOperationsApi.md#wait_for_latest_email) | **GET** /waitForLatestEmail | Fetch inbox's latest email or if empty wait for email to arrive
-[**wait_for_matching_email**](CommonOperationsApi.md#wait_for_matching_email) | **POST** /waitForMatchingEmails | Wait or return list of emails that match simple matching patterns
-[**wait_for_nth_email**](CommonOperationsApi.md#wait_for_nth_email) | **GET** /waitForNthEmail | Wait for or fetch the email with a given index in the inbox specified
-
-
-# **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
-
-
-
-# **delete_email**
-> delete_email(email_id)
-
-Delete an email
-
-Deletes an 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::CommonOperationsApi.new
-email_id = 'email_id_example' # String | emailId
-
-begin
-  #Delete an email
-  api_instance.delete_email(email_id)
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling CommonOperationsApi->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_email_address**
-> delete_email_address(inbox_id)
-
-Delete email address and its emails
-
-Deletes 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::CommonOperationsApi.new
-inbox_id = 'inbox_id_example' # String | inboxId
-
-begin
-  #Delete email address and its emails
-  api_instance.delete_email_address(inbox_id)
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling CommonOperationsApi->delete_email_address: #{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
-
-
-
-# **empty_inbox**
-> empty_inbox(inbox_id)
-
-Delete all emails in an inbox
-
-Deletes all emails
-
-### 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
-inbox_id = 'inbox_id_example' # String | inboxId
-
-begin
-  #Delete all emails in an inbox
-  api_instance.empty_inbox(inbox_id)
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling CommonOperationsApi->empty_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
-
-
-
-# **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_email_count**
-> Array<EmailPreview> wait_for_email_count(opts)
-
-Wait for and return count number of emails 
-
-Will only wait if count is greater that the found emails in given inbox.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 = {
-  count: 56, # Integer | Number of emails to wait for. Must be greater that 1
-  inbox_id: 'inbox_id_example', # String | Id of the inbox we are fetching emails from
-  timeout: 56 # Integer | Max milliseconds to wait
-}
-
-begin
-  #Wait for and return count number of emails 
-  result = api_instance.wait_for_email_count(opts)
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling CommonOperationsApi->wait_for_email_count: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **count** | **Integer**| Number of emails to wait for. Must be greater that 1 | [optional] 
- **inbox_id** | [**String**](.md)| Id of the inbox we are fetching emails from | [optional] 
- **timeout** | **Integer**| Max milliseconds to wait | [optional] 
-
-### Return type
-
-[**Array<EmailPreview>**](EmailPreview.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **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_id: 'inbox_id_example', # String | Id of the inbox we are fetching emails from
-  timeout: 56 # Integer | Max milliseconds to wait
-}
-
-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_id** | [**String**](.md)| Id of the inbox we are fetching emails from | [optional] 
- **timeout** | **Integer**| Max milliseconds to wait | [optional] 
-
-### Return type
-
-[**Email**](Email.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **wait_for_matching_email**
-> Array<EmailPreview> wait_for_matching_email(match_options, opts)
-
-Wait or return list of emails that match simple matching patterns
-
-Results must also meet provided count. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM.
-
-### 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
-match_options = MailSlurpClient::MatchOptions.new # MatchOptions | matchOptions
-opts = {
-  count: 56, # Integer | Number of emails to wait for. Must be greater that 1
-  inbox_id: 'inbox_id_example', # String | Id of the inbox we are fetching emails from
-  timeout: 56 # Integer | Max milliseconds to wait
-}
-
-begin
-  #Wait or return list of emails that match simple matching patterns
-  result = api_instance.wait_for_matching_email(match_options, opts)
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling CommonOperationsApi->wait_for_matching_email: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **match_options** | [**MatchOptions**](MatchOptions.md)| matchOptions | 
- **count** | **Integer**| Number of emails to wait for. Must be greater that 1 | [optional] 
- **inbox_id** | [**String**](.md)| Id of the inbox we are fetching emails from | [optional] 
- **timeout** | **Integer**| Max milliseconds to wait | [optional] 
-
-### Return type
-
-[**Array<EmailPreview>**](EmailPreview.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **wait_for_nth_email**
-> Email wait_for_nth_email(opts)
-
-Wait for or fetch the email with a given index in the inbox specified
-
-### 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_id: 'inbox_id_example', # String | Id of the inbox we are fetching emails from
-  index: 56, # Integer | Zero based index of the email to wait for
-  timeout: 56 # Integer | Max milliseconds to wait
-}
-
-begin
-  #Wait for or fetch the email with a given index in the inbox specified
-  result = api_instance.wait_for_nth_email(opts)
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling CommonOperationsApi->wait_for_nth_email: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **inbox_id** | [**String**](.md)| Id of the inbox we are fetching emails from | [optional] 
- **index** | **Integer**| Zero based index of the email to wait for | [optional] 
- **timeout** | **Integer**| Max milliseconds to wait | [optional] 
-
-### Return type
-
-[**Email**](Email.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-