mailslurp_client 5.0.0 → 7.0.7

data/docs/SendEmailOptions.md

@@ -1,18 +1,45 @@
 # MailSlurpClient::SendEmailOptions
 
 ## 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] 
+**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. This way you can reuse attachments with different emails once uploaded. | [optional] 
 **bcc** | **Array<String>** | Optional list of bcc destination email addresses | [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] 
+**body** | **String** | Optional contents of email. If body contains HTML then set `isHTML` to true to ensure that email clients render it correctly. You can use moustache template syntax in the email body in conjunction with `toGroup` contact variables or `templateVariables` data. If you need more templating control consider creating a template and using the `template` property instead of the body. | [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] 
+**from** | **String** | Optional from address. If not set the source inbox address will be used for this field. Beware of potential spam penalties when setting this field to an address not used by the inbox. For custom email addresses use a custom domain. | [optional] 
+**is_html** | **Boolean** | Optional HTML flag. If true the `content-type` of the email will be `text/html`. Set to true when sending HTML to ensure proper rending on email clients | [optional] 
 **reply_to** | **String** | Optional replyTo header | [optional] 
+**send_strategy** | **String** | Optional strategy to use when sending the email | [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. | 
+**template** | **String** | Optional template ID to use for body. Will override body if provided. When using a template make sure you pass the corresponding map of `templateVariables`. You can find which variables are needed by fetching the template itself or viewing it in the dashboard. | [optional] 
+**template_variables** | [**Object**](.md) | Optional map of template variables. Will replace moustache syntax variables in subject and body or template with the associated values if found. | [optional] 
+**to** | **Array<String>** | List of destination email addresses. Even single recipients must be in array form. Maximum recipients per email depends on your plan. If you need to send many emails try using contacts or contact groups or use a non standard sendStrategy to ensure that spam filters are not triggered (many recipients in one email can affect your spam rating). | [optional] 
+**to_contacts** | **Array<String>** | Optional list of contact IDs to send email to. Manage your contacts via the API or dashboard. When contacts are used the email is sent to each contact separately so they will not see other recipients. | [optional] 
+**to_group** | **String** | Optional contact group ID to send email to. You can create contacts and contact groups in the API or dashboard and use them for email campaigns. When contact groups are used the email is sent to each contact separately so they will not see other recipients | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::SendEmailOptions.new(attachments: null,
+                                 bcc: null,
+                                 body: null,
+                                 cc: null,
+                                 charset: null,
+                                 from: null,
+                                 is_html: null,
+                                 reply_to: null,
+                                 send_strategy: null,
+                                 subject: null,
+                                 template: null,
+                                 template_variables: null,
+                                 to: null,
+                                 to_contacts: null,
+                                 to_group: null)
+```
 
 

data/docs/SetInboxFavouritedOptions.md

@@ -0,0 +1,17 @@
+# MailSlurpClient::SetInboxFavouritedOptions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**state** | **Boolean** | Should the inbox be favourited? | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::SetInboxFavouritedOptions.new(state: null)
+```
+
+

data/docs/Sort.md

@@ -0,0 +1,21 @@
+# MailSlurpClient::Sort
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**empty** | **Boolean** |  | [optional] 
+**sorted** | **Boolean** |  | [optional] 
+**unsorted** | **Boolean** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::Sort.new(empty: null,
+                                 sorted: null,
+                                 unsorted: null)
+```
+
+

data/docs/TemplateControllerApi.md

@@ -0,0 +1,274 @@
+# MailSlurpClient::TemplateControllerApi
+
+All URIs are relative to *https://api.mailslurp.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_template**](TemplateControllerApi.md#create_template) | **POST** /templates | Create a Template
+[**delete_template**](TemplateControllerApi.md#delete_template) | **DELETE** /templates/{TemplateId} | Delete Template
+[**get_all_templates**](TemplateControllerApi.md#get_all_templates) | **GET** /templates/paginated | Get all Templates in paginated format
+[**get_template**](TemplateControllerApi.md#get_template) | **GET** /templates/{TemplateId} | Get Template
+[**get_templates**](TemplateControllerApi.md#get_templates) | **GET** /templates | Get all Templates
+
+
+
+## create_template
+
+> TemplateDto create_template(create_template_options)
+
+Create a Template
+
+### 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::TemplateControllerApi.new
+create_template_options = MailSlurpClient::CreateTemplateOptions.new # CreateTemplateOptions | createTemplateOptions
+
+begin
+  #Create a Template
+  result = api_instance.create_template(create_template_options)
+  p result
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling TemplateControllerApi->create_template: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_template_options** | [**CreateTemplateOptions**](CreateTemplateOptions.md)| createTemplateOptions | 
+
+### Return type
+
+[**TemplateDto**](TemplateDto.md)
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_template
+
+> delete_template(template_id)
+
+Delete Template
+
+### 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::TemplateControllerApi.new
+template_id = 'template_id_example' # String | TemplateId
+
+begin
+  #Delete Template
+  api_instance.delete_template(template_id)
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling TemplateControllerApi->delete_template: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **template_id** | [**String**](.md)| TemplateId | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## get_all_templates
+
+> PageTemplateProjection get_all_templates(opts)
+
+Get all Templates in paginated format
+
+### 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::TemplateControllerApi.new
+opts = {
+  page: 0, # Integer | Optional page index in inbox list pagination
+  size: 20, # Integer | Optional page size in inbox list pagination
+  sort: 'ASC' # String | Optional createdAt sort direction ASC or DESC
+}
+
+begin
+  #Get all Templates in paginated format
+  result = api_instance.get_all_templates(opts)
+  p result
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling TemplateControllerApi->get_all_templates: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**| Optional page index in inbox list pagination | [optional] [default to 0]
+ **size** | **Integer**| Optional page size in inbox list pagination | [optional] [default to 20]
+ **sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to 'ASC']
+
+### Return type
+
+[**PageTemplateProjection**](PageTemplateProjection.md)
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_template
+
+> TemplateDto get_template(template_id)
+
+Get Template
+
+### 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::TemplateControllerApi.new
+template_id = 'template_id_example' # String | TemplateId
+
+begin
+  #Get Template
+  result = api_instance.get_template(template_id)
+  p result
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling TemplateControllerApi->get_template: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **template_id** | [**String**](.md)| TemplateId | 
+
+### Return type
+
+[**TemplateDto**](TemplateDto.md)
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_templates
+
+> Array<TemplateProjection> get_templates
+
+Get all Templates
+
+### 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::TemplateControllerApi.new
+
+begin
+  #Get all Templates
+  result = api_instance.get_templates
+  p result
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling TemplateControllerApi->get_templates: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<TemplateProjection>**](TemplateProjection.md)
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/TemplateDto.md

@@ -0,0 +1,25 @@
+# MailSlurpClient::TemplateDto
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | **String** |  | 
+**created_at** | **DateTime** |  | 
+**id** | **String** |  | 
+**name** | **String** |  | 
+**variables** | [**Array<TemplateVariable>**](TemplateVariable.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::TemplateDto.new(content: null,
+                                 created_at: null,
+                                 id: null,
+                                 name: null,
+                                 variables: null)
+```
+
+

data/docs/TemplateProjection.md

@@ -0,0 +1,25 @@
+# MailSlurpClient::TemplateProjection
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | **DateTime** |  | 
+**id** | **String** |  | 
+**name** | **String** |  | 
+**updated_at** | **DateTime** |  | 
+**variables** | **Array<String>** |  | 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::TemplateProjection.new(created_at: null,
+                                 id: null,
+                                 name: null,
+                                 updated_at: null,
+                                 variables: null)
+```
+
+

data/docs/TemplateVariable.md

@@ -0,0 +1,19 @@
+# MailSlurpClient::TemplateVariable
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**variable_type** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::TemplateVariable.new(name: null,
+                                 variable_type: null)
+```
+
+

data/docs/UnreadCount.md

@@ -0,0 +1,17 @@
+# MailSlurpClient::UnreadCount
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::UnreadCount.new(count: null)
+```
+
+