clicksend_client 1.0.2

data/docs/TimezonesApi.md

@@ -0,0 +1,65 @@
+# ClickSendClient::TimezonesApi
+
+All URIs are relative to *https://rest.clicksend.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**timezones_get**](TimezonesApi.md#timezones_get) | **GET** /timezones | Get supported list of timezones.
+
+
+# **timezones_get**
+> String timezones_get(opts)
+
+Get supported list of timezones.
+
+Get supported list of timezones.
+
+### Example
+```ruby
+# load the gem
+require 'clicksend_client'
+# setup authorization
+ClickSendClient.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = ClickSendClient::TimezonesApi.new
+
+opts = { 
+  page: 1, # Integer | Page number
+  limit: 10 # Integer | Number of records per page
+}
+
+begin
+  #Get supported list of timezones.
+  result = api_instance.timezones_get(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling TimezonesApi->timezones_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**| Page number | [optional] [default to 1]
+ **limit** | **Integer**| Number of records per page | [optional] [default to 10]
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/TransactionalEmailApi.md

@@ -0,0 +1,237 @@
+# ClickSendClient::TransactionalEmailApi
+
+All URIs are relative to *https://rest.clicksend.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**email_history_export_get**](TransactionalEmailApi.md#email_history_export_get) | **GET** /email/history/export | Export all Transactional Email history
+[**email_history_get**](TransactionalEmailApi.md#email_history_get) | **GET** /email/history | Get all transactional email history
+[**email_price_post**](TransactionalEmailApi.md#email_price_post) | **POST** /email/price | Get transactional email price
+[**email_send_post**](TransactionalEmailApi.md#email_send_post) | **POST** /email/send | Send transactional email
+
+
+# **email_history_export_get**
+> String email_history_export_get(filename, opts)
+
+Export all Transactional Email history
+
+Export all Transactional Email history
+
+### Example
+```ruby
+# load the gem
+require 'clicksend_client'
+# setup authorization
+ClickSendClient.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = ClickSendClient::TransactionalEmailApi.new
+
+filename = 'filename_example' # String | Filename to download history as
+
+opts = { 
+  date_from: 56, # Integer | Start date
+  date_to: 56 # Integer | End date
+}
+
+begin
+  #Export all Transactional Email history
+  result = api_instance.email_history_export_get(filename, opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling TransactionalEmailApi->email_history_export_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **filename** | **String**| Filename to download history as | 
+ **date_from** | **Integer**| Start date | [optional] 
+ **date_to** | **Integer**| End date | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **email_history_get**
+> String email_history_get(opts)
+
+Get all transactional email history
+
+Get all transactional email history
+
+### Example
+```ruby
+# load the gem
+require 'clicksend_client'
+# setup authorization
+ClickSendClient.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = ClickSendClient::TransactionalEmailApi.new
+
+opts = { 
+  date_from: 56, # Integer | Start date
+  date_to: 56, # Integer | End date
+  page: 1, # Integer | Page number
+  limit: 10 # Integer | Number of records per page
+}
+
+begin
+  #Get all transactional email history
+  result = api_instance.email_history_get(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling TransactionalEmailApi->email_history_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **date_from** | **Integer**| Start date | [optional] 
+ **date_to** | **Integer**| End date | [optional] 
+ **page** | **Integer**| Page number | [optional] [default to 1]
+ **limit** | **Integer**| Number of records per page | [optional] [default to 10]
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **email_price_post**
+> String email_price_post(email)
+
+Get transactional email price
+
+Get transactional email price
+
+### Example
+```ruby
+# load the gem
+require 'clicksend_client'
+# setup authorization
+ClickSendClient.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = ClickSendClient::TransactionalEmailApi.new
+
+email = ClickSendClient::Email.new # Email | Email model
+
+
+begin
+  #Get transactional email price
+  result = api_instance.email_price_post(email)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling TransactionalEmailApi->email_price_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email** | [**Email**](Email.md)| Email model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **email_send_post**
+> String email_send_post(email)
+
+Send transactional email
+
+Send transactional email
+
+### Example
+```ruby
+# load the gem
+require 'clicksend_client'
+# setup authorization
+ClickSendClient.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = ClickSendClient::TransactionalEmailApi.new
+
+email = ClickSendClient::Email.new # Email | Email model
+
+
+begin
+  #Send transactional email
+  result = api_instance.email_send_post(email)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling TransactionalEmailApi->email_send_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email** | [**Email**](Email.md)| Email model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/TransferCreditApi.md

@@ -0,0 +1,62 @@
+# ClickSendClient::TransferCreditApi
+
+All URIs are relative to *https://rest.clicksend.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**reseller_transfer_credit_put**](TransferCreditApi.md#reseller_transfer_credit_put) | **PUT** /reseller/transfer-credit | Transfer Credit
+
+
+# **reseller_transfer_credit_put**
+> String reseller_transfer_credit_put(reseller_account_transfer_credit)
+
+Transfer Credit
+
+Transfer Credit
+
+### Example
+```ruby
+# load the gem
+require 'clicksend_client'
+# setup authorization
+ClickSendClient.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = ClickSendClient::TransferCreditApi.new
+
+reseller_account_transfer_credit = ClickSendClient::ResellerAccountTransferCredit.new # ResellerAccountTransferCredit | ResellerAccountTransferCredit model
+
+
+begin
+  #Transfer Credit
+  result = api_instance.reseller_transfer_credit_put(reseller_account_transfer_credit)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling TransferCreditApi->reseller_transfer_credit_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **reseller_account_transfer_credit** | [**ResellerAccountTransferCredit**](ResellerAccountTransferCredit.md)| ResellerAccountTransferCredit model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/UploadApi.md

@@ -0,0 +1,65 @@
+# ClickSendClient::UploadApi
+
+All URIs are relative to *https://rest.clicksend.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**uploads_post**](UploadApi.md#uploads_post) | **POST** /uploads | Upload File
+
+
+# **uploads_post**
+> String uploads_post(upload_file, convert)
+
+Upload File
+
+Upload File
+
+### Example
+```ruby
+# load the gem
+require 'clicksend_client'
+# setup authorization
+ClickSendClient.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = ClickSendClient::UploadApi.new
+
+upload_file = ClickSendClient::UploadFile.new # UploadFile | Your file to be uploaded
+
+convert = 'convert_example' # String | 
+
+
+begin
+  #Upload File
+  result = api_instance.uploads_post(upload_file, convert)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling UploadApi->uploads_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **upload_file** | [**UploadFile**](UploadFile.md)| Your file to be uploaded | 
+ **convert** | **String**|  | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/UploadFile.md

@@ -0,0 +1,8 @@
+# ClickSendClient::UploadFile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | **String** | Your base64 encoded file string. | 
+
+

data/docs/Url.md

@@ -0,0 +1,8 @@
+# ClickSendClient::Url
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | Your url. | 
+
+