mailslurp_client 7.0.8 → 8.0.2

data/docs/AttachmentControllerApi.md

@@ -1,126 +0,0 @@
-# MailSlurpClient::AttachmentControllerApi
-
-All URIs are relative to *https://api.mailslurp.com*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**upload_attachment**](AttachmentControllerApi.md#upload_attachment) | **POST** /attachments | Upload an attachment for sending
-[**upload_multipart_form**](AttachmentControllerApi.md#upload_multipart_form) | **POST** /attachments/multipart | Upload an attachment for sending using Multipart Form
-
-
-
-## upload_attachment
-
-> Array<String> upload_attachment(upload_options)
-
-Upload an attachment for sending
-
-When sending emails with attachments first upload each attachment with this endpoint. Record the returned attachment IDs. Then use these attachment IDs in the SendEmailOptions when sending an email. This means that attachments can easily be reused.
-
-### 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::AttachmentControllerApi.new
-upload_options = MailSlurpClient::UploadAttachmentOptions.new # UploadAttachmentOptions | uploadOptions
-
-begin
-  #Upload an attachment for sending
-  result = api_instance.upload_attachment(upload_options)
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling AttachmentControllerApi->upload_attachment: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **upload_options** | [**UploadAttachmentOptions**](UploadAttachmentOptions.md)| uploadOptions | 
-
-### Return type
-
-**Array<String>**
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## upload_multipart_form
-
-> Array<String> upload_multipart_form(file, opts)
-
-Upload an attachment for sending using Multipart Form
-
-When sending emails with attachments first upload each attachment with this endpoint. Record the returned attachment IDs. Then use these attachment IDs in the SendEmailOptions when sending an email. This means that attachments can easily be reused.
-
-### 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::AttachmentControllerApi.new
-file = File.new('/path/to/file') # File | file
-opts = {
-  content_type: 'content_type_example', # String | contentType
-  filename: 'filename_example', # String | filename
-  x_filename: 'x_filename_example' # String | x-filename
-}
-
-begin
-  #Upload an attachment for sending using Multipart Form
-  result = api_instance.upload_multipart_form(file, opts)
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling AttachmentControllerApi->upload_multipart_form: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **file** | **File**| file | 
- **content_type** | **String**| contentType | [optional] 
- **filename** | **String**| filename | [optional] 
- **x_filename** | **String**| x-filename | [optional] 
-
-### Return type
-
-**Array<String>**
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
-- **Content-Type**: multipart/form-data
-- **Accept**: application/json
-

data/docs/AttachmentMetaData.md

@@ -1,23 +0,0 @@
-# MailSlurpClient::AttachmentMetaData
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**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
-
-```ruby
-require 'MailSlurpClient'
-
-instance = MailSlurpClient::AttachmentMetaData.new(content_length: null,
-                                 content_type: null,
-                                 id: null,
-                                 name: null)
-```
-
-

data/docs/BasicAuthOptions.md

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

data/docs/BulkActionsControllerApi.md

@@ -1,165 +0,0 @@
-# MailSlurpClient::BulkActionsControllerApi
-
-All URIs are relative to *https://api.mailslurp.com*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**bulk_create_inboxes**](BulkActionsControllerApi.md#bulk_create_inboxes) | **POST** /bulk/inboxes | Bulk create Inboxes (email addresses)
-[**bulk_delete_inboxes**](BulkActionsControllerApi.md#bulk_delete_inboxes) | **DELETE** /bulk/inboxes | Bulk Delete Inboxes
-[**bulk_send_emails**](BulkActionsControllerApi.md#bulk_send_emails) | **POST** /bulk/send | Bulk Send Emails
-
-
-
-## bulk_create_inboxes
-
-> Array<Inbox> bulk_create_inboxes(count)
-
-Bulk create Inboxes (email addresses)
-
-### 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::BulkActionsControllerApi.new
-count = 56 # Integer | Number of inboxes to be created in bulk
-
-begin
-  #Bulk create Inboxes (email addresses)
-  result = api_instance.bulk_create_inboxes(count)
-  p result
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling BulkActionsControllerApi->bulk_create_inboxes: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **count** | **Integer**| Number of inboxes to be created in bulk | 
-
-### Return type
-
-[**Array<Inbox>**](Inbox.md)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## bulk_delete_inboxes
-
-> bulk_delete_inboxes(ids)
-
-Bulk Delete Inboxes
-
-### 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::BulkActionsControllerApi.new
-ids = ['ids_example'] # Array<String> | ids
-
-begin
-  #Bulk Delete Inboxes
-  api_instance.bulk_delete_inboxes(ids)
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling BulkActionsControllerApi->bulk_delete_inboxes: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **ids** | [**Array&lt;String&gt;**](String.md)| ids | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: Not defined
-
-
-## bulk_send_emails
-
-> bulk_send_emails(bulk_send_email_options)
-
-Bulk Send 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::BulkActionsControllerApi.new
-bulk_send_email_options = MailSlurpClient::BulkSendEmailOptions.new # BulkSendEmailOptions | bulkSendEmailOptions
-
-begin
-  #Bulk Send Emails
-  api_instance.bulk_send_emails(bulk_send_email_options)
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling BulkActionsControllerApi->bulk_send_emails: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **bulk_send_email_options** | [**BulkSendEmailOptions**](BulkSendEmailOptions.md)| bulkSendEmailOptions | 
-
-### 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/BulkSendEmailOptions.md

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

data/docs/CommonActionsControllerApi.md

@@ -1,218 +0,0 @@
-# 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** /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
-
-
-
-## 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
-
-
-## 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)
-
-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(email_options)
-
-Send an email
-
-If no senderId or inboxId provided a random email address will be used to send from.
-
-### 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
-email_options = MailSlurpClient::SimpleSendEmailOptions.new # SimpleSendEmailOptions | emailOptions
-
-begin
-  #Send an email
-  api_instance.send_email_simple(email_options)
-rescue MailSlurpClient::ApiError => e
-  puts "Exception when calling CommonActionsControllerApi->send_email_simple: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **email_options** | [**SimpleSendEmailOptions**](SimpleSendEmailOptions.md)| emailOptions | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[API_KEY](../README.md#API_KEY)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: Not defined
-