mimepost 1.0.0

data/docs/Email.md

@@ -0,0 +1,17 @@
+# Mimepost::Email
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**html** | **String** |  | 
+**subject** | **String** |  | 
+**from_email** | **String** |  | 
+**from_name** | **String** |  | [optional] 
+**global_merge_vars** | [**Array<EmailGlobalMergeVars>**](EmailGlobalMergeVars.md) |  | [optional] 
+**to** | [**Array<EmailTo>**](EmailTo.md) |  | 
+**cc** | **Array<String>** |  | [optional] 
+**bcc** | **Array<String>** |  | [optional] 
+**attachments** | [**Array<EmailAttachments>**](EmailAttachments.md) |  | [optional] 
+**vars** | **Hash<String, String>** |  | [optional] 
+
+

data/docs/EmailAttachments.md

@@ -0,0 +1,10 @@
+# Mimepost::EmailAttachments
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**type** | **String** |  | [optional] 
+**content** | **String** |  | [optional] 
+
+

data/docs/EmailGlobalMergeVars.md

@@ -0,0 +1,9 @@
+# Mimepost::EmailGlobalMergeVars
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**value** | **String** |  | [optional] 
+
+

data/docs/EmailMergeVars.md

@@ -0,0 +1,9 @@
+# Mimepost::EmailMergeVars
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**value** | **String** |  | [optional] 
+
+

data/docs/EmailTo.md

@@ -0,0 +1,9 @@
+# Mimepost::EmailTo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** |  | [optional] 
+**merge_vars** | [**Array<EmailMergeVars>**](EmailMergeVars.md) |  | [optional] 
+
+

data/docs/EmailsApi.md

@@ -0,0 +1,63 @@
+# Mimepost::EmailsApi
+
+All URIs are relative to *https://api.mimepost.com/v1/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**send_email**](EmailsApi.md#send_email) | **POST** /emails/ | Send email
+
+
+# **send_email**
+> ApiResponse send_email(body)
+
+Send email
+
+
+
+### Example
+```ruby
+# load the gem
+require 'mimepost'
+# setup authorization
+Mimepost.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['X-Auth-Token'] = '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-Auth-Token'] = 'Bearer'
+end
+
+api_instance = Mimepost::EmailsApi.new
+
+body = Mimepost::Email.new # Email | Single Email object 
+
+
+begin
+  #Send email
+  result = api_instance.send_email(body)
+  p result
+rescue Mimepost::ApiError => e
+  puts "Exception when calling EmailsApi->send_email: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**Email**](Email.md)| Single Email object  | 
+
+### Return type
+
+[**ApiResponse**](ApiResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/StatsApi.md

@@ -0,0 +1,130 @@
+# Mimepost::StatsApi
+
+All URIs are relative to *https://api.mimepost.com/v1/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**emaillogs_get**](StatsApi.md#emaillogs_get) | **GET** /emaillogs/ | Get the logs of a particular date
+[**stats_get**](StatsApi.md#stats_get) | **GET** /stats/ | Get the summary of stats for a range of dates
+
+
+# **emaillogs_get**
+> ApiResponseEmaillogs emaillogs_get(start_date, end_date, opts)
+
+Get the logs of a particular date
+
+### Example
+```ruby
+# load the gem
+require 'mimepost'
+# setup authorization
+Mimepost.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['X-Auth-Token'] = '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-Auth-Token'] = 'Bearer'
+end
+
+api_instance = Mimepost::StatsApi.new
+
+start_date = 'start_date_example' # String | Start Date in yyyymmdd format example 20190801
+
+end_date = 'end_date_example' # String | End Date in yyyymmdd format example 20190803
+
+opts = { 
+  status: 'status_example', # String | 
+  to: 'to_example', # String | 
+  page: 56, # Integer | 
+  limit: 56 # Integer | 
+}
+
+begin
+  #Get the logs of a particular date
+  result = api_instance.emaillogs_get(start_date, end_date, opts)
+  p result
+rescue Mimepost::ApiError => e
+  puts "Exception when calling StatsApi->emaillogs_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **start_date** | **String**| Start Date in yyyymmdd format example 20190801 | 
+ **end_date** | **String**| End Date in yyyymmdd format example 20190803 | 
+ **status** | **String**|  | [optional] 
+ **to** | **String**|  | [optional] 
+ **page** | **Integer**|  | [optional] 
+ **limit** | **Integer**|  | [optional] 
+
+### Return type
+
+[**ApiResponseEmaillogs**](ApiResponseEmaillogs.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **stats_get**
+> ApiResponseStats stats_get(start_date, end_date)
+
+Get the summary of stats for a range of dates
+
+### Example
+```ruby
+# load the gem
+require 'mimepost'
+# setup authorization
+Mimepost.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['X-Auth-Token'] = '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-Auth-Token'] = 'Bearer'
+end
+
+api_instance = Mimepost::StatsApi.new
+
+start_date = 'start_date_example' # String | Start Date in yyyymmdd format example 20190801
+
+end_date = 'end_date_example' # String | End Date in yyyymmdd format example 20190803
+
+
+begin
+  #Get the summary of stats for a range of dates
+  result = api_instance.stats_get(start_date, end_date)
+  p result
+rescue Mimepost::ApiError => e
+  puts "Exception when calling StatsApi->stats_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **start_date** | **String**| Start Date in yyyymmdd format example 20190801 | 
+ **end_date** | **String**| End Date in yyyymmdd format example 20190803 | 
+
+### Return type
+
+[**ApiResponseStats**](ApiResponseStats.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Webhook.md

@@ -0,0 +1,11 @@
+# Mimepost::Webhook
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**desc** | **String** |  | 
+**url** | **String** |  | 
+**events** | **Array<String>** |  | [optional] 
+**active** | **Integer** |  | [optional] 
+
+

data/docs/Webhook1.md

@@ -0,0 +1,11 @@
+# Mimepost::Webhook1
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**desc** | **String** |  | 
+**url** | **String** |  | 
+**events** | **Array<String>** |  | [optional] 
+**active** | **Integer** |  | [optional] 
+
+

data/docs/WebhooksApi.md

@@ -0,0 +1,272 @@
+# Mimepost::WebhooksApi
+
+All URIs are relative to *https://api.mimepost.com/v1/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**webhooks_get**](WebhooksApi.md#webhooks_get) | **GET** /webhooks/ | Get the list of all the webhooks
+[**webhooks_id_delete**](WebhooksApi.md#webhooks_id_delete) | **DELETE** /webhooks/{id} | Remove a single webhook
+[**webhooks_id_get**](WebhooksApi.md#webhooks_id_get) | **GET** /webhooks/{id} | Get the details of a single webhook
+[**webhooks_id_put**](WebhooksApi.md#webhooks_id_put) | **PUT** /webhooks/{id} | Update the details of a single webhook
+[**webhooks_post**](WebhooksApi.md#webhooks_post) | **POST** /webhooks/ | Add single webhook
+
+
+# **webhooks_get**
+> ApiResponseAllWebhooks webhooks_get
+
+Get the list of all the webhooks
+
+### Example
+```ruby
+# load the gem
+require 'mimepost'
+# setup authorization
+Mimepost.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['X-Auth-Token'] = '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-Auth-Token'] = 'Bearer'
+end
+
+api_instance = Mimepost::WebhooksApi.new
+
+begin
+  #Get the list of all the webhooks
+  result = api_instance.webhooks_get
+  p result
+rescue Mimepost::ApiError => e
+  puts "Exception when calling WebhooksApi->webhooks_get: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ApiResponseAllWebhooks**](ApiResponseAllWebhooks.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **webhooks_id_delete**
+> ApiResponse webhooks_id_delete(id)
+
+Remove a single webhook
+
+### Example
+```ruby
+# load the gem
+require 'mimepost'
+# setup authorization
+Mimepost.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['X-Auth-Token'] = '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-Auth-Token'] = 'Bearer'
+end
+
+api_instance = Mimepost::WebhooksApi.new
+
+id = 56 # Integer | 
+
+
+begin
+  #Remove a single webhook
+  result = api_instance.webhooks_id_delete(id)
+  p result
+rescue Mimepost::ApiError => e
+  puts "Exception when calling WebhooksApi->webhooks_id_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  | 
+
+### Return type
+
+[**ApiResponse**](ApiResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **webhooks_id_get**
+> ApiResponseSingleWebhooks webhooks_id_get(id)
+
+Get the details of a single webhook
+
+### Example
+```ruby
+# load the gem
+require 'mimepost'
+# setup authorization
+Mimepost.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['X-Auth-Token'] = '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-Auth-Token'] = 'Bearer'
+end
+
+api_instance = Mimepost::WebhooksApi.new
+
+id = 56 # Integer | 
+
+
+begin
+  #Get the details of a single webhook
+  result = api_instance.webhooks_id_get(id)
+  p result
+rescue Mimepost::ApiError => e
+  puts "Exception when calling WebhooksApi->webhooks_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  | 
+
+### Return type
+
+[**ApiResponseSingleWebhooks**](ApiResponseSingleWebhooks.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **webhooks_id_put**
+> ApiResponseSingleWebhooks webhooks_id_put(id, opts)
+
+Update the details of a single webhook
+
+### Example
+```ruby
+# load the gem
+require 'mimepost'
+# setup authorization
+Mimepost.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['X-Auth-Token'] = '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-Auth-Token'] = 'Bearer'
+end
+
+api_instance = Mimepost::WebhooksApi.new
+
+id = 56 # Integer | 
+
+opts = { 
+  webhook: Mimepost::Webhook1.new # Webhook1 | 
+}
+
+begin
+  #Update the details of a single webhook
+  result = api_instance.webhooks_id_put(id, opts)
+  p result
+rescue Mimepost::ApiError => e
+  puts "Exception when calling WebhooksApi->webhooks_id_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  | 
+ **webhook** | [**Webhook1**](Webhook1.md)|  | [optional] 
+
+### Return type
+
+[**ApiResponseSingleWebhooks**](ApiResponseSingleWebhooks.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **webhooks_post**
+> ApiResponseWebhooks webhooks_post(opts)
+
+Add single webhook
+
+### Example
+```ruby
+# load the gem
+require 'mimepost'
+# setup authorization
+Mimepost.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['X-Auth-Token'] = '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-Auth-Token'] = 'Bearer'
+end
+
+api_instance = Mimepost::WebhooksApi.new
+
+opts = { 
+  webhook: Mimepost::Webhook.new # Webhook | 
+}
+
+begin
+  #Add single webhook
+  result = api_instance.webhooks_post(opts)
+  p result
+rescue Mimepost::ApiError => e
+  puts "Exception when calling WebhooksApi->webhooks_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **webhook** | [**Webhook**](Webhook.md)|  | [optional] 
+
+### Return type
+
+[**ApiResponseWebhooks**](ApiResponseWebhooks.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+