mailslurp_client 7.0.8 → 7.2.4

data/docs/ContactControllerApi.md

@@ -1,274 +0,0 @@
-# MailSlurpClient::ContactControllerApi
-
-All URIs are relative to *https://api.mailslurp.com*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create_contact**](ContactControllerApi.md#create_contact) | **POST** /contacts | Create a contact
-[**delete_contact**](ContactControllerApi.md#delete_contact) | **DELETE** /contacts/{contactId} | Delete contact
-[**get_all_contacts**](ContactControllerApi.md#get_all_contacts) | **GET** /contacts/paginated | Get all contacts
-[**get_contact**](ContactControllerApi.md#get_contact) | **GET** /contacts/{contactId} | Get contact
-[**get_contacts**](ContactControllerApi.md#get_contacts) | **GET** /contacts | Get all contacts
-
-
-
-## create_contact
-
-> ContactDto create_contact(create_contact_options)
-
-Create a contact
-
-### 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::ContactControllerApi.new
-create_contact_options = MailSlurpClient::CreateContactOptions.new # CreateContactOptions | createContactOptions
-
-begin
-  #Create a contact
-  result = api_instance.create_contact(create_contact_options)
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling ContactControllerApi->create_contact: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **create_contact_options** | [**CreateContactOptions**](CreateContactOptions.md)| createContactOptions | 
-
-### Return type
-
-[**ContactDto**](ContactDto.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## delete_contact
-
-> delete_contact(contact_id)
-
-Delete contact
-
-### 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::ContactControllerApi.new
-contact_id = 'contact_id_example' # String | contactId
-
-begin
-  #Delete contact
-  api_instance.delete_contact(contact_id)
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling ContactControllerApi->delete_contact: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **contact_id** | [**String**](.md)| contactId | 
-
-### 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_contacts
-
-> PageContactProjection get_all_contacts(opts)
-
-Get all contacts
-
-### 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::ContactControllerApi.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 contacts
-  result = api_instance.get_all_contacts(opts)
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling ContactControllerApi->get_all_contacts: #{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
-
-[**PageContactProjection**](PageContactProjection.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_contact
-
-> ContactDto get_contact(contact_id)
-
-Get contact
-
-### 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::ContactControllerApi.new
-contact_id = 'contact_id_example' # String | contactId
-
-begin
-  #Get contact
-  result = api_instance.get_contact(contact_id)
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling ContactControllerApi->get_contact: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **contact_id** | [**String**](.md)| contactId | 
-
-### Return type
-
-[**ContactDto**](ContactDto.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_contacts
-
-> Array<ContactProjection> get_contacts
-
-Get all contacts
-
-### 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::ContactControllerApi.new
-
-begin
-  #Get all contacts
-  result = api_instance.get_contacts
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling ContactControllerApi->get_contacts: #{e}"
-end
-```
-
-### Parameters
-
-This endpoint does not need any parameter.
-
-### Return type
-
-[**Array<ContactProjection>**](ContactProjection.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/ContactDto.md

@@ -1,31 +0,0 @@
-# MailSlurpClient::ContactDto
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**company** | **String** |  | [optional] 
-**email_addresses** | **Array<String>** |  | 
-**first_name** | **String** |  | [optional] 
-**id** | **String** |  | 
-**last_name** | **String** |  | [optional] 
-**meta_data** | [**JsonNode**](JsonNode.md) |  | [optional] 
-**opt_out** | **Boolean** |  | [optional] 
-**tags** | **Array<String>** |  | 
-
-## Code Sample
-
-```ruby
-require 'MailSlurpClient'
-
-instance = MailSlurpClient::ContactDto.new(company: null,
-                                 email_addresses: null,
-                                 first_name: null,
-                                 id: null,
-                                 last_name: null,
-                                 meta_data: null,
-                                 opt_out: null,
-                                 tags: null)
-```
-
-

data/docs/ContactProjection.md

@@ -1,27 +0,0 @@
-# MailSlurpClient::ContactProjection
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**company** | **String** |  | [optional] 
-**created_at** | **DateTime** |  | 
-**first_name** | **String** |  | [optional] 
-**id** | **String** |  | 
-**last_name** | **String** |  | [optional] 
-**opt_out** | **Boolean** |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'MailSlurpClient'
-
-instance = MailSlurpClient::ContactProjection.new(company: null,
-                                 created_at: null,
-                                 first_name: null,
-                                 id: null,
-                                 last_name: null,
-                                 opt_out: null)
-```
-
-

data/docs/CreateAnonymousAliasOptions.md

@@ -1,17 +0,0 @@
-# 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/CreateContactOptions.md

@@ -1,31 +0,0 @@
-# MailSlurpClient::CreateContactOptions
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**email_addresses** | **Array<String>** | Set of email addresses belonging to the contact | [optional] 
-**first_name** | **String** |  | [optional] 
-**group_id** | **String** | Group IDs that contact belongs to | [optional] 
-**meta_data** | [**JsonNode**](JsonNode.md) |  | [optional] 
-**opt_out** | **Boolean** | Has the user explicitly or implicitly opted out of being contacted? If so MailSlurp will ignore them in all actions. | [optional] 
-**tags** | **Array<String>** | Tags that can be used to search and group contacts | [optional] 
-**last_name** | **String** |  | [optional] 
-**company** | **String** |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'MailSlurpClient'
-
-instance = MailSlurpClient::CreateContactOptions.new(email_addresses: null,
-                                 first_name: null,
-                                 group_id: null,
-                                 meta_data: null,
-                                 opt_out: null,
-                                 tags: null,
-                                 last_name: null,
-                                 company: null)
-```
-
-

data/docs/CreateDomainOptions.md

@@ -1,17 +0,0 @@
-# MailSlurpClient::CreateDomainOptions
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**domain** | **String** | The top level domain you wish to use with MailSlurp | [optional] 
-
-## Code Sample
-
-```ruby
-require 'MailSlurpClient'
-
-instance = MailSlurpClient::CreateDomainOptions.new(domain: null)
-```
-
-

data/docs/CreateGroupOptions.md

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

data/docs/CreateOwnedAliasOptions.md

@@ -1,23 +0,0 @@
-# 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)
-```
-
-