mailslurp_client 5.0.0 → 7.0.7

data/docs/BulkSendEmailOptions.md

@@ -1,9 +1,19 @@
 # MailSlurpClient::BulkSendEmailOptions
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**inbox_ids** | **Array<String>** | Inboxes to send from | [optional] 
+**inbox_ids** | **Array<String>** | Inboxes to send the email from | [optional] 
 **send_email_options** | [**SendEmailOptions**](SendEmailOptions.md) |  | 
 
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::BulkSendEmailOptions.new(inbox_ids: null,
+                                 send_email_options: null)
+```
+
 

data/docs/CommonActionsControllerApi.md

@@ -0,0 +1,167 @@
+# MailSlurpClient::CommonActionsControllerApi
+
+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
+[**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
+
+
+
+## create_new_email_address
+
+> Inbox create_new_email_address
+
+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_address
+  p result
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling CommonActionsControllerApi->create_new_email_address: #{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)
+
+Delete all emails in an inbox
+
+Deletes all emails
+
+### 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
+inbox_id = 'inbox_id_example' # String | inboxId
+
+begin
+  #Delete all emails in an inbox
+  api_instance.empty_inbox(inbox_id)
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling CommonActionsControllerApi->empty_inbox: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **inbox_id** | [**String**](.md)| inboxId | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## send_email_simple
+
+> send_email_simple(send_email_options)
+
+Send an email from a random email address
+
+To specify an email address first create an inbox and use that with the other send email methods
+
+### 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
+send_email_options = MailSlurpClient::SendEmailOptions.new # SendEmailOptions | sendEmailOptions
+
+begin
+  #Send an email from a random email address
+  api_instance.send_email_simple(send_email_options)
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling CommonActionsControllerApi->send_email_simple: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **send_email_options** | [**SendEmailOptions**](SendEmailOptions.md)| sendEmailOptions | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+

data/docs/ContactControllerApi.md

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