mailslurp_client 5.0.0 → 7.0.7

data/docs/UpdateGroupContacts.md

@@ -0,0 +1,17 @@
+# MailSlurpClient::UpdateGroupContacts
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**contact_ids** | **Array<String>** |  | 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::UpdateGroupContacts.new(contact_ids: null)
+```
+
+

data/docs/UpdateInboxOptions.md

@@ -0,0 +1,25 @@
+# MailSlurpClient::UpdateInboxOptions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | Optional description of an inbox for labelling purposes | [optional] 
+**expires_at** | **DateTime** | When, if ever, will the inbox expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. | [optional] 
+**favourite** | **Boolean** | Is the inbox favourited | [optional] 
+**name** | **String** | Optional name of the inbox. Displayed in the dashboard for easier search | [optional] 
+**tags** | **Array<String>** | Tags that inbox has been tagged with | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::UpdateInboxOptions.new(description: null,
+                                 expires_at: null,
+                                 favourite: null,
+                                 name: null,
+                                 tags: null)
+```
+
+

data/docs/UploadAttachmentOptions.md

@@ -1,10 +1,21 @@
 # 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] 
+**content_type** | **String** | Optional contentType for file. For instance `application/pdf` | [optional] 
 **filename** | **String** | Optional filename to save upload with | [optional] 
 
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::UploadAttachmentOptions.new(base64_contents: null,
+                                 content_type: null,
+                                 filename: null)
+```
+
 

data/docs/ValidationDto.md

@@ -0,0 +1,19 @@
+# MailSlurpClient::ValidationDto
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email_id** | **String** |  | 
+**html** | [**HTMLValidationResult**](HTMLValidationResult.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::ValidationDto.new(email_id: null,
+                                 html: null)
+```
+
+

data/docs/ValidationMessage.md

@@ -0,0 +1,19 @@
+# MailSlurpClient::ValidationMessage
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**line_number** | **Integer** |  | 
+**message** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::ValidationMessage.new(line_number: null,
+                                 message: null)
+```
+
+

data/docs/WaitForConditions.md

@@ -0,0 +1,29 @@
+# MailSlurpClient::WaitForConditions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** | Number of results that should match conditions | [optional] 
+**count_type** | **String** | Should exactly count number of results be returned or at least that many. | [optional] 
+**inbox_id** | **String** | Inbox to search within | [optional] 
+**matches** | [**Array<MatchOption>**](MatchOption.md) | Conditions that should be matched | [optional] 
+**sort_direction** | **String** | Direction to sort matching emails by created time | [optional] 
+**timeout** | **Integer** | Max time in milliseconds to wait until conditions are met | [optional] 
+**unread_only** | **Boolean** | Apply only to unread emails | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::WaitForConditions.new(count: null,
+                                 count_type: null,
+                                 inbox_id: null,
+                                 matches: null,
+                                 sort_direction: null,
+                                 timeout: null,
+                                 unread_only: null)
+```
+
+

data/docs/WaitForControllerApi.md

@@ -0,0 +1,317 @@
+# MailSlurpClient::WaitForControllerApi
+
+All URIs are relative to *https://api.mailslurp.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**wait_for**](WaitForControllerApi.md#wait_for) | **POST** /waitFor | Wait for conditions to be met
+[**wait_for_email_count**](WaitForControllerApi.md#wait_for_email_count) | **GET** /waitForEmailCount | Wait for and return count number of emails 
+[**wait_for_latest_email**](WaitForControllerApi.md#wait_for_latest_email) | **GET** /waitForLatestEmail | Fetch inbox's latest email or if empty wait for an email to arrive
+[**wait_for_matching_email**](WaitForControllerApi.md#wait_for_matching_email) | **POST** /waitForMatchingEmails | Wait or return list of emails that match simple matching patterns
+[**wait_for_nth_email**](WaitForControllerApi.md#wait_for_nth_email) | **GET** /waitForNthEmail | Wait for or fetch the email with a given index in the inbox specified
+
+
+
+## wait_for
+
+> Array<EmailPreview> wait_for(opts)
+
+Wait for conditions to be met
+
+Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met
+
+### 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::WaitForControllerApi.new
+opts = {
+  wait_for_conditions: MailSlurpClient::WaitForConditions.new # WaitForConditions | Conditions to wait for
+}
+
+begin
+  #Wait for conditions to be met
+  result = api_instance.wait_for(opts)
+  p result
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling WaitForControllerApi->wait_for: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **wait_for_conditions** | [**WaitForConditions**](WaitForConditions.md)| Conditions to wait for | [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_email_count
+
+> Array<EmailPreview> wait_for_email_count(opts)
+
+Wait for and return count number of emails 
+
+If inbox contains count or more emails at time of request then return count worth of emails. If not wait until the count is reached and return those or return an error if timeout is exceeded.
+
+### 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::WaitForControllerApi.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
+  unread_only: false # Boolean | Optional filter for unread only
+}
+
+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 WaitForControllerApi->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] 
+ **unread_only** | **Boolean**| Optional filter for unread only | [optional] [default to false]
+
+### 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 an 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 such as waitForNthEmail or waitForEmailCount.
+
+### 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::WaitForControllerApi.new
+opts = {
+  inbox_id: 'inbox_id_example', # String | Id of the inbox we are fetching emails from
+  timeout: 56, # Integer | Max milliseconds to wait
+  unread_only: false # Boolean | Optional filter for unread only
+}
+
+begin
+  #Fetch inbox's latest email or if empty wait for an email to arrive
+  result = api_instance.wait_for_latest_email(opts)
+  p result
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling WaitForControllerApi->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] 
+ **unread_only** | **Boolean**| Optional filter for unread only | [optional] [default to false]
+
+### 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
+
+Perform a search of emails in an inbox with the given patterns. If results match expected count then return or else retry the search until results are found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the `MatchOptions` object for options.
+
+### 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::WaitForControllerApi.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
+  unread_only: false # Boolean | Optional filter for unread only
+}
+
+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 WaitForControllerApi->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] 
+ **unread_only** | **Boolean**| Optional filter for unread only | [optional] [default to false]
+
+### 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
+
+If nth email is already present in inbox then return it. If not hold the connection open until timeout expires or the nth email is received and returned.
+
+### 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::WaitForControllerApi.new
+opts = {
+  inbox_id: 'inbox_id_example', # String | Id of the inbox you are fetching emails from
+  index: 56, # Integer | Zero based index of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass index=1
+  timeout: 56, # Integer | Max milliseconds to wait for the nth email if not already present
+  unread_only: false # Boolean | Optional filter for unread only
+}
+
+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 WaitForControllerApi->wait_for_nth_email: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **inbox_id** | [**String**](.md)| Id of the inbox you are fetching emails from | [optional] 
+ **index** | **Integer**| Zero based index of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass index=1 | [optional] 
+ **timeout** | **Integer**| Max milliseconds to wait for the nth email if not already present | [optional] 
+ **unread_only** | **Boolean**| Optional filter for unread only | [optional] [default to false]
+
+### Return type
+
+[**Email**](Email.md)
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+