mailslurp_client 7.0.7 → 7.0.8

data/docs/AttachmentControllerApi.md

@@ -88,7 +88,8 @@ api_instance = MailSlurpClient::AttachmentControllerApi.new
 file = File.new('/path/to/file') # File | file
 opts = {
   content_type: 'content_type_example', # String | contentType
-  filename: 'filename_example' # String | filename
+  filename: 'filename_example', # String | filename
+  x_filename: 'x_filename_example' # String | x-filename
 }
 
 begin
@@ -108,6 +109,7 @@ Name | Type | Description  | Notes
  **file** | **File**| file | 
  **content_type** | **String**| contentType | [optional] 
  **filename** | **String**| filename | [optional] 
+ **x_filename** | **String**| x-filename | [optional] 
 
 ### Return type
 

data/docs/AttachmentMetaData.md

@@ -4,10 +4,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**content_length** | **Integer** |  | 
-**content_type** | **String** |  | 
-**id** | **String** |  | 
-**name** | **String** |  | 
+**content_length** | **Integer** | Size of attachment in bytes | [optional] 
+**content_type** | **String** | Content type of attachment | [optional] 
+**id** | **String** | ID of attachment | [optional] 
+**name** | **String** | Name of attachment | [optional] 
 
 ## Code Sample
 

data/docs/BulkSendEmailOptions.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **inbox_ids** | **Array<String>** | Inboxes to send the email from | [optional] 
-**send_email_options** | [**SendEmailOptions**](SendEmailOptions.md) |  | 
+**send_email_options** | [**SendEmailOptions**](SendEmailOptions.md) |  | [optional] 
 
 ## Code Sample
 

data/docs/CommonActionsControllerApi.md

@@ -4,9 +4,10 @@ All URIs are relative to *https://api.mailslurp.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**create_new_email_address**](CommonActionsControllerApi.md#create_new_email_address) | **POST** /newEmailAddress | Create new random inbox
+[**create_new_email_address**](CommonActionsControllerApi.md#create_new_email_address) | **POST** /createInbox | Create new random inbox
+[**create_new_email_address1**](CommonActionsControllerApi.md#create_new_email_address1) | **POST** /newEmailAddress | Create new random inbox
 [**empty_inbox**](CommonActionsControllerApi.md#empty_inbox) | **DELETE** /emptyInbox | Delete all emails in an inbox
-[**send_email_simple**](CommonActionsControllerApi.md#send_email_simple) | **POST** /sendEmail | Send an email from a random email address
+[**send_email_simple**](CommonActionsControllerApi.md#send_email_simple) | **POST** /sendEmail | Send an email
 
 
 
@@ -60,6 +61,56 @@ This endpoint does not need any parameter.
 - **Accept**: application/json
 
 
+## create_new_email_address1
+
+> Inbox create_new_email_address1
+
+Create new random inbox
+
+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::CommonActionsControllerApi.new
+
+begin
+  #Create new random inbox
+  result = api_instance.create_new_email_address1
+  p result
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling CommonActionsControllerApi->create_new_email_address1: #{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
+
+
 ## empty_inbox
 
 > empty_inbox(inbox_id)
@@ -115,11 +166,11 @@ nil (empty response body)
 
 ## send_email_simple
 
-> send_email_simple(send_email_options)
+> send_email_simple(email_options)
 
-Send an email from a random email address
+Send an email
 
-To specify an email address first create an inbox and use that with the other send email methods
+If no senderId or inboxId provided a random email address will be used to send from.
 
 ### Example
 
@@ -135,11 +186,11 @@ MailSlurpClient.configure do |config|
 end
 
 api_instance = MailSlurpClient::CommonActionsControllerApi.new
-send_email_options = MailSlurpClient::SendEmailOptions.new # SendEmailOptions | sendEmailOptions
+email_options = MailSlurpClient::SimpleSendEmailOptions.new # SimpleSendEmailOptions | emailOptions
 
 begin
-  #Send an email from a random email address
-  api_instance.send_email_simple(send_email_options)
+  #Send an email
+  api_instance.send_email_simple(email_options)
 rescue MailSlurpClient::ApiError => e
   puts "Exception when calling CommonActionsControllerApi->send_email_simple: #{e}"
 end
@@ -150,7 +201,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **send_email_options** | [**SendEmailOptions**](SendEmailOptions.md)| sendEmailOptions | 
+ **email_options** | [**SimpleSendEmailOptions**](SimpleSendEmailOptions.md)| emailOptions | 
 
 ### Return type
 

data/docs/CreateAnonymousAliasOptions.md

@@ -0,0 +1,17 @@
+# MailSlurpClient::CreateAnonymousAliasOptions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email_address** | **String** | Email address to be hidden behind alias | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::CreateAnonymousAliasOptions.new(email_address: null)
+```
+
+

data/docs/CreateOwnedAliasOptions.md

@@ -0,0 +1,23 @@
+# MailSlurpClient::CreateOwnedAliasOptions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email_address** | **String** | Email address to be hidden behind alias | [optional] 
+**inbox_id** | **String** | Optional inbox ID to attach to alias. Emails received by this inbox will be forwarded to the alias email address | [optional] 
+**name** | **String** | Optional name for alias | [optional] 
+**proxied** | **Boolean** | Optional proxied flag. When proxied is true alias will forward the incoming emails to the aliased email address via a proxy inbox. A new proxy is created for every new email thread. By replying to the proxy you can correspond with using your email alias without revealing your real email address. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::CreateOwnedAliasOptions.new(email_address: null,
+                                 inbox_id: null,
+                                 name: null,
+                                 proxied: null)
+```
+
+

data/docs/EmailAnalysis.md

@@ -4,11 +4,11 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**dkim_verdict** | **String** |  | [optional] 
-**dmarc_verdict** | **String** |  | [optional] 
-**spam_verdict** | **String** |  | [optional] 
-**spf_verdict** | **String** |  | [optional] 
-**virus_verdict** | **String** |  | [optional] 
+**dkim_verdict** | **String** | Verdict of DomainKeys Identified Mail analysis | [optional] 
+**dmarc_verdict** | **String** | Verdict of Domain-based Message Authentication Reporting and Conformance analysis | [optional] 
+**spam_verdict** | **String** | Verdict of spam ranking analysis | [optional] 
+**spf_verdict** | **String** | Verdict of Send Policy Framework record spoofing analysis | [optional] 
+**virus_verdict** | **String** | Verdict of virus scan analysis | [optional] 
 
 ## Code Sample
 

data/docs/FormControllerApi.md

@@ -0,0 +1,79 @@
+# MailSlurpClient::FormControllerApi
+
+All URIs are relative to *https://api.mailslurp.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**submit_form**](FormControllerApi.md#submit_form) | **POST** /forms | Submit a form to be parsed and sent as an email to an address determined by the form fields
+
+
+
+## submit_form
+
+> String submit_form(opts)
+
+Submit a form to be parsed and sent as an email to an address determined by the form fields
+
+This endpoint allows you to submit HTML forms and receive the field values and files via email.   #### Parameters The endpoint looks for special meta parameters in the form fields OR in the URL request parameters. The meta parameters can be used to specify the behaviour of the email.   You must provide at-least a `_to` email address or a `_toAlias` email alias ID to tell the endpoint where the form should be emailed. These can be submitted as hidden HTML input fields with the corresponding `name` attributes or as URL query parameters such as `?_to=test@example.com`  The endpoint takes all other form fields that are named and includes them in the message body of the email. Files are sent as attachments.  #### Submitting This endpoint accepts form submission via POST method. It accepts `application/x-www-form-urlencoded`, and `multipart/form-data` content-types.  #### HTML Example ```html <form    action=\"https://api.mailslurp.com/forms\"   method=\"post\" >   <input name=\"_to\" type=\"hidden\" value=\"test@example.com\"/>   <textarea name=\"feedback\"></textarea>   <button type=\"submit\">Submit</button> </form> ```  #### URL Example ```html <form    action=\"https://api.mailslurp.com/forms?_toAlias=test@example.com\"   method=\"post\" >   <textarea name=\"feedback\"></textarea>   <button type=\"submit\">Submit</button> </form> ```    The email address is specified by a `_to` field OR is extracted from an email alias specified by a `_toAlias` field (see the alias controller for more information).  Endpoint accepts .  You can specify a content type in HTML forms using the `enctype` attribute, for instance: `<form enctype=\"multipart/form-data\">`.  
+
+### 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::FormControllerApi.new
+opts = {
+  _email_address: '_email_address_example', # String | Email address of the submitting user. Include this if you wish to record the submitters email address and reply to it later.
+  _redirect_to: '_redirect_to_example', # String | Optional URL to redirect form submitter to after submission. If not present user will see a success message.
+  _spam_check: '_spam_check_example', # String | Optional but recommended field that catches spammers out. Include as a hidden form field but LEAVE EMPTY. Spam-bots will usually fill every field. If the _spamCheck field is filled the form submission will be ignored.
+  _subject: '_subject_example', # String | Optional subject of the email that will be sent.
+  _success_message: '_success_message_example', # String | Optional success message to display if no _redirectTo present.
+  _to: '_to_example', # String | The email address that submitted form should be sent to. Either this or _toAlias must be present for a form to be successfully submitted..
+  _to_alias: '_to_alias_example', # String | ID of an email alias to that form should be sent to. Aliases must be created before submission and can be used to hide an email address and reduce spam.
+  other_parameters: 'other_parameters_example' # String | All other parameters or fields will be accepted and attached to the sent email. This includes files and any HTML form field with a name. These fields will become the body of the email that is sent.
+}
+
+begin
+  #Submit a form to be parsed and sent as an email to an address determined by the form fields
+  result = api_instance.submit_form(opts)
+  p result
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling FormControllerApi->submit_form: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **_email_address** | **String**| Email address of the submitting user. Include this if you wish to record the submitters email address and reply to it later. | [optional] 
+ **_redirect_to** | **String**| Optional URL to redirect form submitter to after submission. If not present user will see a success message. | [optional] 
+ **_spam_check** | **String**| Optional but recommended field that catches spammers out. Include as a hidden form field but LEAVE EMPTY. Spam-bots will usually fill every field. If the _spamCheck field is filled the form submission will be ignored. | [optional] 
+ **_subject** | **String**| Optional subject of the email that will be sent. | [optional] 
+ **_success_message** | **String**| Optional success message to display if no _redirectTo present. | [optional] 
+ **_to** | **String**| The email address that submitted form should be sent to. Either this or _toAlias must be present for a form to be successfully submitted.. | [optional] 
+ **_to_alias** | **String**| ID of an email alias to that form should be sent to. Aliases must be created before submission and can be used to hide an email address and reduce spam. | [optional] 
+ **other_parameters** | **String**| All other parameters or fields will be accepted and attached to the sent email. This includes files and any HTML form field with a name. These fields will become the body of the email that is sent. | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
+- **Accept**: application/json
+

data/docs/ForwardEmailOptions.md

@@ -4,20 +4,20 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**to** | **Array<String>** |  | 
-**subject** | **String** |  | [optional] 
-**cc** | **Array<String>** |  | [optional] 
-**bcc** | **Array<String>** |  | [optional] 
+**bcc** | **Array<String>** | Optional bcc recipients | [optional] 
+**cc** | **Array<String>** | Optional cc recipients | [optional] 
+**subject** | **String** | Subject for forwarded email | [optional] 
+**to** | **Array<String>** | To recipients for forwarded email | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'MailSlurpClient'
 
-instance = MailSlurpClient::ForwardEmailOptions.new(to: null,
-                                 subject: null,
+instance = MailSlurpClient::ForwardEmailOptions.new(bcc: null,
                                  cc: null,
-                                 bcc: null)
+                                 subject: null,
+                                 to: null)
 ```
 
 

data/docs/InboxControllerApi.md

@@ -11,6 +11,7 @@ Method | HTTP request | Description
 [**get_emails**](InboxControllerApi.md#get_emails) | **GET** /inboxes/{inboxId}/emails | Get emails in an Inbox
 [**get_inbox**](InboxControllerApi.md#get_inbox) | **GET** /inboxes/{inboxId} | Get Inbox
 [**get_inbox_emails_paginated**](InboxControllerApi.md#get_inbox_emails_paginated) | **GET** /inboxes/{inboxId}/emails/paginated | Get inbox emails paginated
+[**get_inbox_tags**](InboxControllerApi.md#get_inbox_tags) | **GET** /inboxes/tags | Get inbox tags
 [**get_inboxes**](InboxControllerApi.md#get_inboxes) | **GET** /inboxes | List Inboxes / Email Addresses
 [**send_email**](InboxControllerApi.md#send_email) | **POST** /inboxes/{inboxId} | Send Email
 [**set_inbox_favourited**](InboxControllerApi.md#set_inbox_favourited) | **PUT** /inboxes/{inboxId}/favourite | Set inbox favourited state
@@ -213,7 +214,8 @@ opts = {
   page: 0, # Integer | Optional page index in inbox list pagination
   search: 'search_example', # String | Optionally filter by search words partial matching ID, tags, name, and email address
   size: 20, # Integer | Optional page size in inbox list pagination
-  sort: 'ASC' # String | Optional createdAt sort direction ASC or DESC
+  sort: 'ASC', # String | Optional createdAt sort direction ASC or DESC
+  tag: 'tag_example' # String | Optionally filter by tags
 }
 
 begin
@@ -235,6 +237,7 @@ Name | Type | Description  | Notes
  **search** | **String**| Optionally filter by search words partial matching ID, tags, name, and email address | [optional] 
  **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']
+ **tag** | **String**| Optionally filter by tags | [optional] 
 
 ### Return type
 
@@ -432,6 +435,56 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## get_inbox_tags
+
+> Array<String> get_inbox_tags
+
+Get inbox tags
+
+Get all inbox tags
+
+### 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::InboxControllerApi.new
+
+begin
+  #Get inbox tags
+  result = api_instance.get_inbox_tags
+  p result
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling InboxControllerApi->get_inbox_tags: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Array<String>**
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_inboxes
 
 > Array<Inbox> get_inboxes

data/docs/ModelAlias.md

@@ -0,0 +1,31 @@
+# MailSlurpClient::ModelAlias
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | **DateTime** |  | 
+**email_address** | **String** |  | 
+**id** | **String** |  | [optional] 
+**inbox_id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**proxied** | **Boolean** |  | [optional] 
+**updated_at** | **DateTime** |  | 
+**user_id** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::ModelAlias.new(created_at: null,
+                                 email_address: null,
+                                 id: null,
+                                 inbox_id: null,
+                                 name: null,
+                                 proxied: null,
+                                 updated_at: null,
+                                 user_id: null)
+```
+
+

data/docs/PageAlias.md

@@ -0,0 +1,37 @@
+# MailSlurpClient::PageAlias
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | [**Array<ModelAlias>**](ModelAlias.md) |  | [optional] 
+**empty** | **Boolean** |  | [optional] 
+**first** | **Boolean** |  | [optional] 
+**last** | **Boolean** |  | [optional] 
+**number** | **Integer** |  | [optional] 
+**number_of_elements** | **Integer** |  | [optional] 
+**pageable** | [**Pageable**](Pageable.md) |  | [optional] 
+**size** | **Integer** |  | [optional] 
+**sort** | [**Sort**](Sort.md) |  | [optional] 
+**total_elements** | **Integer** |  | [optional] 
+**total_pages** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::PageAlias.new(content: null,
+                                 empty: null,
+                                 first: null,
+                                 last: null,
+                                 number: null,
+                                 number_of_elements: null,
+                                 pageable: null,
+                                 size: null,
+                                 sort: null,
+                                 total_elements: null,
+                                 total_pages: null)
+```
+
+