mailslurp_client 7.0.8 → 7.2.4

data/docs/EmailPreview.md

@@ -1,31 +0,0 @@
-# MailSlurpClient::EmailPreview
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**attachments** | **Array<String>** | List of IDs of attachments found in the email. Use these IDs with the Inbox and Email Controllers to download attachments and attachment meta data such as filesize, name, extension. | [optional] 
-**bcc** | **Array<String>** | List of `BCC` recipients email was addressed to | [optional] 
-**cc** | **Array<String>** | List of `CC` recipients email was addressed to | [optional] 
-**created_at** | **DateTime** | When was the email received by MailSlurp | [optional] 
-**id** | **String** | ID of the email | [optional] 
-**read** | **Boolean** | Has the email been viewed ever | [optional] 
-**subject** | **String** | The subject line of the email message | [optional] 
-**to** | **Array<String>** | List of `To` recipients email was addressed to | [optional] 
-
-## Code Sample
-
-```ruby
-require 'MailSlurpClient'
-
-instance = MailSlurpClient::EmailPreview.new(attachments: null,
-                                 bcc: null,
-                                 cc: null,
-                                 created_at: null,
-                                 id: null,
-                                 read: null,
-                                 subject: null,
-                                 to: null)
-```
-
-

data/docs/EmailProjection.md

@@ -1,33 +0,0 @@
-# MailSlurpClient::EmailProjection
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**attachments** | **Array<String>** |  | [optional] 
-**bcc** | **Array<String>** |  | [optional] 
-**cc** | **Array<String>** |  | [optional] 
-**created_at** | **DateTime** |  | 
-**id** | **String** |  | 
-**inbox_id** | **String** |  | 
-**read** | **Boolean** |  | [optional] 
-**subject** | **String** |  | [optional] 
-**to** | **Array<String>** |  | 
-
-## Code Sample
-
-```ruby
-require 'MailSlurpClient'
-
-instance = MailSlurpClient::EmailProjection.new(attachments: null,
-                                 bcc: null,
-                                 cc: null,
-                                 created_at: null,
-                                 id: null,
-                                 inbox_id: null,
-                                 read: null,
-                                 subject: null,
-                                 to: null)
-```
-
-

data/docs/FormControllerApi.md

@@ -1,79 +0,0 @@
-# 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

@@ -1,23 +0,0 @@
-# MailSlurpClient::ForwardEmailOptions
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**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(bcc: null,
-                                 cc: null,
-                                 subject: null,
-                                 to: null)
-```
-
-

data/docs/GroupContactsDto.md

@@ -1,19 +0,0 @@
-# MailSlurpClient::GroupContactsDto
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**contacts** | [**Array<ContactDto>**](ContactDto.md) |  | 
-**group** | [**GroupDto**](GroupDto.md) |  | 
-
-## Code Sample
-
-```ruby
-require 'MailSlurpClient'
-
-instance = MailSlurpClient::GroupContactsDto.new(contacts: null,
-                                 group: null)
-```
-
-

data/docs/GroupControllerApi.md

@@ -1,437 +0,0 @@
-# MailSlurpClient::GroupControllerApi
-
-All URIs are relative to *https://api.mailslurp.com*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**add_contacts_to_group**](GroupControllerApi.md#add_contacts_to_group) | **PUT** /groups/{groupId}/contacts | Add contacts to a group
-[**create_group**](GroupControllerApi.md#create_group) | **POST** /groups | Create a group
-[**delete_group**](GroupControllerApi.md#delete_group) | **DELETE** /groups/{groupId} | Delete group
-[**get_all_groups**](GroupControllerApi.md#get_all_groups) | **GET** /groups/paginated | Get all Contact Groups in paginated format
-[**get_group**](GroupControllerApi.md#get_group) | **GET** /groups/{groupId} | Get group
-[**get_group_with_contacts**](GroupControllerApi.md#get_group_with_contacts) | **GET** /groups/{groupId}/contacts | Get group and contacts belonging to it
-[**get_groups**](GroupControllerApi.md#get_groups) | **GET** /groups | Get all groups
-[**remove_contacts_from_group**](GroupControllerApi.md#remove_contacts_from_group) | **DELETE** /groups/{groupId}/contacts | Remove contacts from a group
-
-
-
-## add_contacts_to_group
-
-> GroupContactsDto add_contacts_to_group(group_id, update_group_contacts_option)
-
-Add contacts to a group
-
-### 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::GroupControllerApi.new
-group_id = 'group_id_example' # String | groupId
-update_group_contacts_option = MailSlurpClient::UpdateGroupContacts.new # UpdateGroupContacts | updateGroupContactsOption
-
-begin
-  #Add contacts to a group
-  result = api_instance.add_contacts_to_group(group_id, update_group_contacts_option)
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling GroupControllerApi->add_contacts_to_group: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **group_id** | [**String**](.md)| groupId | 
- **update_group_contacts_option** | [**UpdateGroupContacts**](UpdateGroupContacts.md)| updateGroupContactsOption | 
-
-### Return type
-
-[**GroupContactsDto**](GroupContactsDto.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## create_group
-
-> GroupDto create_group(create_group_options)
-
-Create a group
-
-### 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::GroupControllerApi.new
-create_group_options = MailSlurpClient::CreateGroupOptions.new # CreateGroupOptions | createGroupOptions
-
-begin
-  #Create a group
-  result = api_instance.create_group(create_group_options)
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling GroupControllerApi->create_group: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **create_group_options** | [**CreateGroupOptions**](CreateGroupOptions.md)| createGroupOptions | 
-
-### Return type
-
-[**GroupDto**](GroupDto.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## delete_group
-
-> delete_group(group_id)
-
-Delete group
-
-### 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::GroupControllerApi.new
-group_id = 'group_id_example' # String | groupId
-
-begin
-  #Delete group
-  api_instance.delete_group(group_id)
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling GroupControllerApi->delete_group: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **group_id** | [**String**](.md)| groupId | 
-
-### 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_groups
-
-> PageGroupProjection get_all_groups(opts)
-
-Get all Contact Groups 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::GroupControllerApi.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 Contact Groups in paginated format
-  result = api_instance.get_all_groups(opts)
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling GroupControllerApi->get_all_groups: #{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
-
-[**PageGroupProjection**](PageGroupProjection.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_group
-
-> GroupDto get_group(group_id)
-
-Get group
-
-### 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::GroupControllerApi.new
-group_id = 'group_id_example' # String | groupId
-
-begin
-  #Get group
-  result = api_instance.get_group(group_id)
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling GroupControllerApi->get_group: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **group_id** | [**String**](.md)| groupId | 
-
-### Return type
-
-[**GroupDto**](GroupDto.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_group_with_contacts
-
-> GroupContactsDto get_group_with_contacts(group_id)
-
-Get group and contacts belonging to it
-
-### 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::GroupControllerApi.new
-group_id = 'group_id_example' # String | groupId
-
-begin
-  #Get group and contacts belonging to it
-  result = api_instance.get_group_with_contacts(group_id)
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling GroupControllerApi->get_group_with_contacts: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **group_id** | [**String**](.md)| groupId | 
-
-### Return type
-
-[**GroupContactsDto**](GroupContactsDto.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_groups
-
-> Array<GroupProjection> get_groups
-
-Get all groups
-
-### 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::GroupControllerApi.new
-
-begin
-  #Get all groups
-  result = api_instance.get_groups
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling GroupControllerApi->get_groups: #{e}"
-end
-```
-
-### Parameters
-
-This endpoint does not need any parameter.
-
-### Return type
-
-[**Array<GroupProjection>**](GroupProjection.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## remove_contacts_from_group
-
-> GroupContactsDto remove_contacts_from_group(group_id, update_group_contacts_option)
-
-Remove contacts from a group
-
-### 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::GroupControllerApi.new
-group_id = 'group_id_example' # String | groupId
-update_group_contacts_option = MailSlurpClient::UpdateGroupContacts.new # UpdateGroupContacts | updateGroupContactsOption
-
-begin
-  #Remove contacts from a group
-  result = api_instance.remove_contacts_from_group(group_id, update_group_contacts_option)
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling GroupControllerApi->remove_contacts_from_group: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **group_id** | [**String**](.md)| groupId | 
- **update_group_contacts_option** | [**UpdateGroupContacts**](UpdateGroupContacts.md)| updateGroupContactsOption | 
-
-### Return type
-
-[**GroupContactsDto**](GroupContactsDto.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-