mailslurp_client 4.3.3 → 5.0.0

data/docs/Email.md

@@ -8,9 +8,11 @@ Name | Type | Description | Notes
 **bcc** | **Array<String>** |  | [optional] 
 **body** | **String** |  | [optional] 
 **cc** | **Array<String>** |  | [optional] 
+**charset** | **String** |  | [optional] 
 **created_at** | **DateTime** |  | 
 **from** | **String** |  | [optional] 
 **headers** | **Hash<String, String>** |  | [optional] 
+**html** | **BOOLEAN** |  | [optional] 
 **id** | **String** |  | 
 **inbox_id** | **String** |  | 
 **raw_url** | **String** |  | [optional] 

data/docs/EmailPreview.md

@@ -3,7 +3,11 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**bcc** | **Array<String>** |  | [optional] 
+**cc** | **Array<String>** |  | [optional] 
 **created** | **DateTime** |  | 
 **id** | **String** |  | 
+**subject** | **String** |  | [optional] 
+**to** | **Array<String>** |  | 
 
 

data/docs/ExtraOperationsApi.md

@@ -9,10 +9,11 @@ Method | HTTP request | Description
 [**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_email1**](ExtraOperationsApi.md#delete_email1) | **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
+[**forward_email**](ExtraOperationsApi.md#forward_email) | **POST** /emails/{emailId}/forward | Forward Email
 [**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
@@ -20,6 +21,8 @@ Method | HTTP request | Description
 [**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
+[**upload_attachment**](ExtraOperationsApi.md#upload_attachment) | **POST** /attachments | Upload an attachment for sending
+[**upload_multipart_form**](ExtraOperationsApi.md#upload_multipart_form) | **POST** /attachments/multipart | Upload an attachment for sending using Multipart Form
 
 
 # **bulk_create_inboxes**
@@ -245,7 +248,7 @@ end
 
 api_instance = MailSlurpClient::ExtraOperationsApi.new
 inbox_id = 'inbox_id_example' # String | inboxId
-create_webhook_options = MailSlurpClient::CreateWebhookOptions.new # CreateWebhookOptions | options
+create_webhook_options = MailSlurpClient::CreateWebhookOptions.new # CreateWebhookOptions | webhookOptions
 
 begin
   #Attach a WebHook URL to an inbox
@@ -261,7 +264,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **inbox_id** | [**String**](.md)| inboxId | 
- **create_webhook_options** | [**CreateWebhookOptions**](CreateWebhookOptions.md)| options | 
+ **create_webhook_options** | [**CreateWebhookOptions**](CreateWebhookOptions.md)| webhookOptions | 
 
 ### Return type
 
@@ -278,8 +281,8 @@ Name | Type | Description  | Notes
 
 
 
-# **delete_email**
-> delete_email(email_id)
+# **delete_email1**
+> delete_email1(email_id)
 
 Delete Email
 
@@ -302,9 +305,9 @@ email_id = 'email_id_example' # String | emailId
 
 begin
   #Delete Email
-  api_instance.delete_email(email_id)
+  api_instance.delete_email1(email_id)
 rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling ExtraOperationsApi->delete_email: #{e}"
+  puts "Exception when calling ExtraOperationsApi->delete_email1: #{e}"
 end
 ```
 
@@ -484,6 +487,59 @@ nil (empty response body)
 
 
 
+# **forward_email**
+> forward_email(email_id, forward_email_options)
+
+Forward Email
+
+Forward email content to given recipients
+
+### 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
+forward_email_options = MailSlurpClient::ForwardEmailOptions.new # ForwardEmailOptions | forwardEmailOptions
+
+begin
+  #Forward Email
+  api_instance.forward_email(email_id, forward_email_options)
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling ExtraOperationsApi->forward_email: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email_id** | [**String**](.md)| emailId | 
+ **forward_email_options** | [**ForwardEmailOptions**](ForwardEmailOptions.md)| forwardEmailOptions | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+
 # **get_email**
 > Email get_email(email_id)
 
@@ -853,3 +909,113 @@ nil (empty response body)
 
 
 
+# **upload_attachment**
+> Array<String> upload_attachment(upload_attachment_options)
+
+Upload an attachment for sending
+
+When sending emails with attachments first upload each attachment with this endpoint. Record the returned attachment IDs. Then use these attachment IDs in the SendEmailOptions when sending an email. This means that attachments can easily be reused.
+
+### 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
+upload_attachment_options = MailSlurpClient::UploadAttachmentOptions.new # UploadAttachmentOptions | uploadOptions
+
+begin
+  #Upload an attachment for sending
+  result = api_instance.upload_attachment(upload_attachment_options)
+  p result
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling ExtraOperationsApi->upload_attachment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **upload_attachment_options** | [**UploadAttachmentOptions**](UploadAttachmentOptions.md)| uploadOptions | 
+
+### Return type
+
+**Array<String>**
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **upload_multipart_form**
+> Array<String> upload_multipart_form(file, opts)
+
+Upload an attachment for sending using Multipart Form
+
+When sending emails with attachments first upload each attachment with this endpoint. Record the returned attachment IDs. Then use these attachment IDs in the SendEmailOptions when sending an email. This means that attachments can easily be reused.
+
+### 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
+file = File.new('/path/to/file') # File | file
+opts = {
+  content_type: 'content_type_example', # String | contentType
+  filename: 'filename_example' # String | filename
+}
+
+begin
+  #Upload an attachment for sending using Multipart Form
+  result = api_instance.upload_multipart_form(file, opts)
+  p result
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling ExtraOperationsApi->upload_multipart_form: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file** | **File**| file | 
+ **content_type** | **String**| contentType | [optional] 
+ **filename** | **String**| filename | [optional] 
+
+### Return type
+
+**Array<String>**
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+

data/docs/ForwardEmailOptions.md

@@ -0,0 +1,11 @@
+# MailSlurpClient::ForwardEmailOptions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**to** | **Array<String>** |  | 
+**subject** | **String** |  | [optional] 
+**cc** | **Array<String>** |  | [optional] 
+**bcc** | **Array<String>** |  | [optional] 
+
+

data/docs/MatchOption.md

@@ -0,0 +1,10 @@
+# MailSlurpClient::MatchOption
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**field** | **String** | The email property to match on. One of SUBJECT, TO, BCC, CC or FROM | [optional] 
+**should** | **String** | What criteria to apply. CONTAIN or EQUAL. Note CONTAIN is recommended due to some SMTP servers adding new lines | [optional] 
+**value** | **String** | The value to compare to the field using EQUAL or CONTAIN | [optional] 
+
+

data/docs/MatchOptions.md

@@ -0,0 +1,8 @@
+# MailSlurpClient::MatchOptions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**matches** | [**Array<MatchOption>**](MatchOption.md) | 1 or more match options. Options are additive so if one does not match the email is excluded from results | [optional] 
+
+

data/docs/SendEmailOptions.md

@@ -3,14 +3,16 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**attachments** | **Array<String>** | Optional list of attachment IDs to send with this email. You must first upload each attachment separately in order to obtain attachment IDs | [optional] 
 **bcc** | **Array<String>** | Optional list of bcc destination email addresses | [optional] 
-**body** | **String** | Contents of email | [optional] 
+**body** | **String** | Contents of email. If HTML set isHTML to true. You can use moustache templates here if you provide a templateVariables option | [optional] 
 **cc** | **Array<String>** | Optional list of cc destination email addresses | [optional] 
 **charset** | **String** | Optional charset | [optional] 
 **from** | **String** | Optional from address. If not set source inbox address will be used | [optional] 
 **html** | **BOOLEAN** |  | [optional] 
 **reply_to** | **String** | Optional replyTo header | [optional] 
 **subject** | **String** | Optional email subject line | [optional] 
+**template_variables** | [**Object**](.md) | Optional map of template variables. Will replace moustache syntax variables in subject or body with the associated values | [optional] 
 **to** | **Array<String>** | List of destination email addresses. Even single recipients must be in array form. | 
 
 

data/docs/UploadAttachmentOptions.md

@@ -0,0 +1,10 @@
+# MailSlurpClient::UploadAttachmentOptions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**base64_contents** | **String** | Base64 encoded string of file contents | [optional] 
+**content_type** | **String** | Optional contentType for file. For instance application/pdf | [optional] 
+**filename** | **String** | Optional filename to save upload with | [optional] 
+
+

data/lib/mailslurp_client.rb

@@ -23,8 +23,12 @@ require 'mailslurp_client/models/create_webhook_options'
 require 'mailslurp_client/models/email'
 require 'mailslurp_client/models/email_analysis'
 require 'mailslurp_client/models/email_preview'
+require 'mailslurp_client/models/forward_email_options'
 require 'mailslurp_client/models/inbox'
+require 'mailslurp_client/models/match_option'
+require 'mailslurp_client/models/match_options'
 require 'mailslurp_client/models/send_email_options'
+require 'mailslurp_client/models/upload_attachment_options'
 require 'mailslurp_client/models/webhook'
 
 # APIs

data/lib/mailslurp_client/api/common_operations_api.rb

@@ -66,6 +66,159 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Delete an email
+    # Deletes an email
+    # @param email_id emailId
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_email(email_id, opts = {})
+      delete_email_with_http_info(email_id, opts)
+      nil
+    end
+
+    # Delete an email
+    # Deletes an email
+    # @param email_id emailId
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_email_with_http_info(email_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CommonOperationsApi.delete_email ...'
+      end
+      # verify the required parameter 'email_id' is set
+      if @api_client.config.client_side_validation && email_id.nil?
+        fail ArgumentError, "Missing the required parameter 'email_id' when calling CommonOperationsApi.delete_email"
+      end
+      # resource path
+      local_var_path = '/deleteEmail'
+
+      # query parameters
+      query_params = {}
+      query_params[:'emailId'] = email_id
+
+      # header parameters
+      header_params = {}
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['API_KEY']
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CommonOperationsApi#delete_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete email address and its emails
+    # Deletes an inbox
+    # @param inbox_id inboxId
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_email_address(inbox_id, opts = {})
+      delete_email_address_with_http_info(inbox_id, opts)
+      nil
+    end
+
+    # Delete email address and its emails
+    # Deletes an inbox
+    # @param inbox_id inboxId
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_email_address_with_http_info(inbox_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CommonOperationsApi.delete_email_address ...'
+      end
+      # verify the required parameter 'inbox_id' is set
+      if @api_client.config.client_side_validation && inbox_id.nil?
+        fail ArgumentError, "Missing the required parameter 'inbox_id' when calling CommonOperationsApi.delete_email_address"
+      end
+      # resource path
+      local_var_path = '/deleteEmailAddress'
+
+      # query parameters
+      query_params = {}
+      query_params[:'inboxId'] = inbox_id
+
+      # header parameters
+      header_params = {}
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['API_KEY']
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CommonOperationsApi#delete_email_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete all emails in an inbox
+    # Deletes all emails
+    # @param inbox_id inboxId
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def empty_inbox(inbox_id, opts = {})
+      empty_inbox_with_http_info(inbox_id, opts)
+      nil
+    end
+
+    # Delete all emails in an inbox
+    # Deletes all emails
+    # @param inbox_id inboxId
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def empty_inbox_with_http_info(inbox_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CommonOperationsApi.empty_inbox ...'
+      end
+      # verify the required parameter 'inbox_id' is set
+      if @api_client.config.client_side_validation && inbox_id.nil?
+        fail ArgumentError, "Missing the required parameter 'inbox_id' when calling CommonOperationsApi.empty_inbox"
+      end
+      # resource path
+      local_var_path = '/emptyInbox'
+
+      # query parameters
+      query_params = {}
+      query_params[:'inboxId'] = inbox_id
+
+      # header parameters
+      header_params = {}
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['API_KEY']
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CommonOperationsApi#empty_inbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # 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
     # @param send_email_options sendEmailOptions
@@ -118,11 +271,67 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # 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.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :count Number of emails to wait for. Must be greater that 1
+    # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
+    # @option opts [Integer] :timeout Max milliseconds to wait
+    # @return [Array<EmailPreview>]
+    def wait_for_email_count(opts = {})
+      data, _status_code, _headers = wait_for_email_count_with_http_info(opts)
+      data
+    end
+
+    # 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.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :count Number of emails to wait for. Must be greater that 1
+    # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
+    # @option opts [Integer] :timeout Max milliseconds to wait
+    # @return [Array<(Array<EmailPreview>, Fixnum, Hash)>] Array<EmailPreview> data, response status code and response headers
+    def wait_for_email_count_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CommonOperationsApi.wait_for_email_count ...'
+      end
+      # resource path
+      local_var_path = '/waitForEmailCount'
+
+      # query parameters
+      query_params = {}
+      query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
+      query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
+      query_params[:'timeout'] = opts[:'timeout'] if !opts[:'timeout'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['API_KEY']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Array<EmailPreview>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CommonOperationsApi#wait_for_email_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # 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.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :inbox_email_address Email address of the inbox we are fetching emails from
     # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
+    # @option opts [Integer] :timeout Max milliseconds to wait
     # @return [Email]
     def wait_for_latest_email(opts = {})
       data, _status_code, _headers = wait_for_latest_email_with_http_info(opts)
@@ -132,20 +341,20 @@ module MailSlurpClient
     # Fetch inbox&#39;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.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :inbox_email_address Email address of the inbox we are fetching emails from
     # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
+    # @option opts [Integer] :timeout Max milliseconds to wait
     # @return [Array<(Email, Fixnum, Hash)>] Email data, response status code and response headers
     def wait_for_latest_email_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: CommonOperationsApi.wait_for_latest_email ...'
       end
       # resource path
-      local_var_path = '/fetchLatestEmail'
+      local_var_path = '/waitForLatestEmail'
 
       # query parameters
       query_params = {}
-      query_params[:'inboxEmailAddress'] = opts[:'inbox_email_address'] if !opts[:'inbox_email_address'].nil?
       query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
+      query_params[:'timeout'] = opts[:'timeout'] if !opts[:'timeout'].nil?
 
       # header parameters
       header_params = {}
@@ -171,5 +380,123 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # 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.
+    # @param match_options matchOptions
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :count Number of emails to wait for. Must be greater that 1
+    # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
+    # @option opts [Integer] :timeout Max milliseconds to wait
+    # @return [Array<EmailPreview>]
+    def wait_for_matching_email(match_options, opts = {})
+      data, _status_code, _headers = wait_for_matching_email_with_http_info(match_options, opts)
+      data
+    end
+
+    # 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.
+    # @param match_options matchOptions
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :count Number of emails to wait for. Must be greater that 1
+    # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
+    # @option opts [Integer] :timeout Max milliseconds to wait
+    # @return [Array<(Array<EmailPreview>, Fixnum, Hash)>] Array<EmailPreview> data, response status code and response headers
+    def wait_for_matching_email_with_http_info(match_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CommonOperationsApi.wait_for_matching_email ...'
+      end
+      # verify the required parameter 'match_options' is set
+      if @api_client.config.client_side_validation && match_options.nil?
+        fail ArgumentError, "Missing the required parameter 'match_options' when calling CommonOperationsApi.wait_for_matching_email"
+      end
+      # resource path
+      local_var_path = '/waitForMatchingEmails'
+
+      # query parameters
+      query_params = {}
+      query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
+      query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
+      query_params[:'timeout'] = opts[:'timeout'] if !opts[:'timeout'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(match_options)
+      auth_names = ['API_KEY']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Array<EmailPreview>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CommonOperationsApi#wait_for_matching_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Wait for or fetch the email with a given index in the inbox specified
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
+    # @option opts [Integer] :index Zero based index of the email to wait for
+    # @option opts [Integer] :timeout Max milliseconds to wait
+    # @return [Email]
+    def wait_for_nth_email(opts = {})
+      data, _status_code, _headers = wait_for_nth_email_with_http_info(opts)
+      data
+    end
+
+    # Wait for or fetch the email with a given index in the inbox specified
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
+    # @option opts [Integer] :index Zero based index of the email to wait for
+    # @option opts [Integer] :timeout Max milliseconds to wait
+    # @return [Array<(Email, Fixnum, Hash)>] Email data, response status code and response headers
+    def wait_for_nth_email_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CommonOperationsApi.wait_for_nth_email ...'
+      end
+      # resource path
+      local_var_path = '/waitForNthEmail'
+
+      # query parameters
+      query_params = {}
+      query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
+      query_params[:'index'] = opts[:'index'] if !opts[:'index'].nil?
+      query_params[:'timeout'] = opts[:'timeout'] if !opts[:'timeout'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['API_KEY']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Email')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CommonOperationsApi#wait_for_nth_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
   end
 end