mailslurp_client 4.3.3 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 425d283104ec65eb164ab440b1fa03d1256a0701
-  data.tar.gz: d64d77df12dc5b3887d4c7be17f3748cc95da515
+SHA256:
+  metadata.gz: 6ab644202c77e9ac19da611943b30e7d49f278c27bc3e625d71bff3029657f61
+  data.tar.gz: 54c10683483eda6020cd978e1fc5b8b9824778e2e93f5380ad5605360bd0831f
 SHA512:
-  metadata.gz: cd1072e27644b56dd5444f910b60d383b357ed43d5bb0d132aded2f0bcd66e9835195e81ca92186b3e59b155da884ad9c973cfa9cc01371826ad84a18c1d0296
-  data.tar.gz: bc2556c9292654fed1cc492d2ca678086974d78300f65530294f1d5772db386c3ee87a624a443cc04905bcfbc03a6f449604c66123e3ded3521870bc261d1a25
+  metadata.gz: b5ce39607a184f9ed52b3920283ade106a85a2259426c0ba6f0a29ebc7ecf6a10bd49d398a94a2e549121c926dc1dbd49e206d0c6a79ad7aeec22965c6dd462f
+  data.tar.gz: 3068bd2b2b802a3fa0abb52a49b21d252402e9e73fcb21ede6d45e305533034f1fe8a516e58b47803a9322d5491f0823798a493dc82cea93205993b089de7fb0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mailslurp_client (4.3.3)
+    mailslurp_client (5.0.0)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 

data/README.md

@@ -7,7 +7,7 @@ For documentation see [developer guide](https://www.mailslurp.com/developers). [
 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
+- 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)
 
@@ -24,15 +24,15 @@ gem build mailslurp_client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./mailslurp_client-4.3.3.gem
+gem install ./mailslurp_client-5.0.0.gem
 ```
-(for development, run `gem install --dev ./mailslurp_client-4.3.3.gem` to install the development dependencies)
+(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', '~> 4.3.3'
+    gem 'mailslurp_client', '~> 5.0.0'
 
 ### Install from Git
 
@@ -82,17 +82,24 @@ 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_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::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_email**](docs/ExtraOperationsApi.md#delete_email) | **DELETE** /emails/{emailId} | Delete Email
+*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
@@ -100,6 +107,8 @@ Class | Method | HTTP request | Description
 *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
@@ -110,8 +119,12 @@ Class | Method | HTTP request | Description
  - [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)
 
 

data/docs/CommonOperationsApi.md

@@ -5,8 +5,14 @@ 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_latest_email**](CommonOperationsApi.md#wait_for_latest_email) | **GET** /fetchLatestEmail | Fetch inbox's latest email or if empty wait for email to arrive
+[**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**
@@ -57,6 +63,159 @@ This endpoint does not need any parameter.
 
 
 
+# **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)
 
@@ -108,6 +267,64 @@ nil (empty response body)
 
 
 
+# **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)
 
@@ -129,8 +346,8 @@ 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
+  inbox_id: 'inbox_id_example', # String | Id of the inbox we are fetching emails from
+  timeout: 56 # Integer | Max milliseconds to wait
 }
 
 begin
@@ -146,8 +363,124 @@ end
 
 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] 
+ **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