mailslurp_client 5.0.0 → 7.0.7

data/docs/ContactDto.md

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

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

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

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

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

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

data/docs/CreateWebhookOptions.md

@@ -1,10 +1,21 @@
 # MailSlurpClient::CreateWebhookOptions
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **basic_auth** | [**BasicAuthOptions**](BasicAuthOptions.md) |  | [optional] 
-**url** | **String** | Public URL (including protocol) that MailSlurp can post WebhookNotificationObjects to when an email is received | [optional] 
-**name** | **String** |  | [optional] 
+**name** | **String** | Optional name for the webhook | [optional] 
+**url** | **String** | Public URL on your server that MailSlurp can post WebhookNotification payload to when an email is received. The payload of the submitted JSON is described by https://api.mailslurp.com/schemas/webhook-payload | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::CreateWebhookOptions.new(basic_auth: null,
+                                 name: null,
+                                 url: null)
+```
 
 

data/docs/DomainControllerApi.md

@@ -0,0 +1,223 @@
+# MailSlurpClient::DomainControllerApi
+
+All URIs are relative to *https://api.mailslurp.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_domain**](DomainControllerApi.md#create_domain) | **POST** /domains | Create Domain
+[**delete_domain**](DomainControllerApi.md#delete_domain) | **DELETE** /domains/{id} | Delete a domain
+[**get_domain**](DomainControllerApi.md#get_domain) | **GET** /domains/{id} | Get a domain
+[**get_domains**](DomainControllerApi.md#get_domains) | **GET** /domains | Get domains
+
+
+
+## create_domain
+
+> DomainDto create_domain(domain_options)
+
+Create Domain
+
+Link a domain that you own with MailSlurp so you can create email addresses using it. Endpoint returns DNS records used for validation. You must add these verification records to your host provider's DNS setup to verify the domain.
+
+### 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::DomainControllerApi.new
+domain_options = MailSlurpClient::CreateDomainOptions.new # CreateDomainOptions | domainOptions
+
+begin
+  #Create Domain
+  result = api_instance.create_domain(domain_options)
+  p result
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling DomainControllerApi->create_domain: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **domain_options** | [**CreateDomainOptions**](CreateDomainOptions.md)| domainOptions | 
+
+### Return type
+
+[**DomainDto**](DomainDto.md)
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_domain
+
+> delete_domain(id)
+
+Delete a domain
+
+Delete a domain. This will disable any existing inboxes that use this domain.
+
+### 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::DomainControllerApi.new
+id = 'id_example' # String | id
+
+begin
+  #Delete a domain
+  api_instance.delete_domain(id)
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling DomainControllerApi->delete_domain: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | [**String**](.md)| id | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## get_domain
+
+> DomainDto get_domain(id)
+
+Get a domain
+
+Returns domain verification status and tokens for a given domain
+
+### 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::DomainControllerApi.new
+id = 'id_example' # String | id
+
+begin
+  #Get a domain
+  result = api_instance.get_domain(id)
+  p result
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling DomainControllerApi->get_domain: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | [**String**](.md)| id | 
+
+### Return type
+
+[**DomainDto**](DomainDto.md)
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_domains
+
+> Array<DomainPreview> get_domains
+
+Get domains
+
+List all custom domains you have created
+
+### 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::DomainControllerApi.new
+
+begin
+  #Get domains
+  result = api_instance.get_domains
+  p result
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling DomainControllerApi->get_domains: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<DomainPreview>**](DomainPreview.md)
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/DomainDto.md

@@ -0,0 +1,29 @@
+# MailSlurpClient::DomainDto
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | **DateTime** |  | 
+**domain** | **String** |  | 
+**id** | **String** |  | 
+**is_verified** | **Boolean** |  | 
+**updated_at** | **DateTime** |  | 
+**user_id** | **String** |  | 
+**verification_token** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::DomainDto.new(created_at: null,
+                                 domain: null,
+                                 id: null,
+                                 is_verified: null,
+                                 updated_at: null,
+                                 user_id: null,
+                                 verification_token: null)
+```
+
+

data/docs/DomainPreview.md

@@ -0,0 +1,21 @@
+# MailSlurpClient::DomainPreview
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | **DateTime** |  | 
+**domain** | **String** |  | 
+**id** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::DomainPreview.new(created_at: null,
+                                 domain: null,
+                                 id: null)
+```
+
+