clicksend_client 1.0.2

data/docs/EmailRecipient.md

@@ -0,0 +1,9 @@
+# ClickSendClient::EmailRecipient
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Email of the recipient. | 
+**name** | **String** | Name of the recipient. | [optional] 
+
+

data/docs/EmailSMSAddress.md

@@ -0,0 +1,10 @@
+# ClickSendClient::EmailSMSAddress
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email_address** | **String** | Your email address | 
+**from** | **String** | Your sender id | 
+**subaccount_id** | **String** | Your subaccount id | [optional] 
+
+

data/docs/EmailTemplateNew.md

@@ -0,0 +1,9 @@
+# ClickSendClient::EmailTemplateNew
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**template_name** | **String** | The intended name for the new template. | 
+**template_id_master** | **Float** | The ID of the master template you want to base on. | 
+
+

data/docs/EmailTemplateUpdate.md

@@ -0,0 +1,9 @@
+# ClickSendClient::EmailTemplateUpdate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**template_name** | **String** | The intended name for the template. | [optional] 
+**body** | **String** | Your template body. | 
+
+

data/docs/EmailToSmsApi.md

@@ -0,0 +1,395 @@
+# ClickSendClient::EmailToSmsApi
+
+All URIs are relative to *https://rest.clicksend.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**sms_email_sms_get**](EmailToSmsApi.md#sms_email_sms_get) | **GET** /sms/email-sms | Get list of email to sms allowed addresses
+[**sms_email_sms_post**](EmailToSmsApi.md#sms_email_sms_post) | **POST** /sms/email-sms | Create email to sms allowed address
+[**sms_email_sms_stripped_string_delete**](EmailToSmsApi.md#sms_email_sms_stripped_string_delete) | **DELETE** /sms/email-sms-stripped-strings/{rule_id} | Delete email to sms stripped string rule
+[**sms_email_sms_stripped_string_get**](EmailToSmsApi.md#sms_email_sms_stripped_string_get) | **GET** /sms/email-sms-stripped-strings/{rule_id} | Get email to sms stripped string rule
+[**sms_email_sms_stripped_string_post**](EmailToSmsApi.md#sms_email_sms_stripped_string_post) | **POST** /sms/email-sms-stripped-strings | Create email to sms stripped string rule
+[**sms_email_sms_stripped_string_put**](EmailToSmsApi.md#sms_email_sms_stripped_string_put) | **PUT** /sms/email-sms-stripped-strings/{rule_id} | Update email to sms stripped string rule
+[**sms_email_sms_stripped_strings_get**](EmailToSmsApi.md#sms_email_sms_stripped_strings_get) | **GET** /sms/email-sms-stripped-strings | Get list of email to sms stripped string rules
+
+
+# **sms_email_sms_get**
+> String sms_email_sms_get(opts)
+
+Get list of email to sms allowed addresses
+
+Get list of email to sms allowed addresses
+
+### 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::EmailToSmsApi.new
+
+opts = { 
+  page: 1, # Integer | Page number
+  limit: 10 # Integer | Number of records per page
+}
+
+begin
+  #Get list of email to sms allowed addresses
+  result = api_instance.sms_email_sms_get(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling EmailToSmsApi->sms_email_sms_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
+
+
+
+# **sms_email_sms_post**
+> String sms_email_sms_post(email_sms_address)
+
+Create email to sms allowed address
+
+Create email to sms allowed address
+
+### 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::EmailToSmsApi.new
+
+email_sms_address = ClickSendClient::EmailSMSAddress.new # EmailSMSAddress | EmailSMSAddress model
+
+
+begin
+  #Create email to sms allowed address
+  result = api_instance.sms_email_sms_post(email_sms_address)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling EmailToSmsApi->sms_email_sms_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email_sms_address** | [**EmailSMSAddress**](EmailSMSAddress.md)| EmailSMSAddress model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **sms_email_sms_stripped_string_delete**
+> String sms_email_sms_stripped_string_delete(rule_id)
+
+Delete email to sms stripped string rule
+
+Delete email to sms stripped string rule
+
+### 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::EmailToSmsApi.new
+
+rule_id = 56 # Integer | Your rule id
+
+
+begin
+  #Delete email to sms stripped string rule
+  result = api_instance.sms_email_sms_stripped_string_delete(rule_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling EmailToSmsApi->sms_email_sms_stripped_string_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rule_id** | **Integer**| Your rule id | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **sms_email_sms_stripped_string_get**
+> String sms_email_sms_stripped_string_get(rule_id)
+
+Get email to sms stripped string rule
+
+Get email to sms stripped string rule
+
+### 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::EmailToSmsApi.new
+
+rule_id = 56 # Integer | Your rule id
+
+
+begin
+  #Get email to sms stripped string rule
+  result = api_instance.sms_email_sms_stripped_string_get(rule_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling EmailToSmsApi->sms_email_sms_stripped_string_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rule_id** | **Integer**| Your rule id | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **sms_email_sms_stripped_string_post**
+> String sms_email_sms_stripped_string_post(stripped_string)
+
+Create email to sms stripped string rule
+
+Create email to sms stripped string rules
+
+### 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::EmailToSmsApi.new
+
+stripped_string = ClickSendClient::StrippedString.new # StrippedString | StrippedString model
+
+
+begin
+  #Create email to sms stripped string rule
+  result = api_instance.sms_email_sms_stripped_string_post(stripped_string)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling EmailToSmsApi->sms_email_sms_stripped_string_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **stripped_string** | [**StrippedString**](StrippedString.md)| StrippedString model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **sms_email_sms_stripped_string_put**
+> String sms_email_sms_stripped_string_put(stripped_string, rule_id)
+
+Update email to sms stripped string rule
+
+Update email to sms stripped string rule
+
+### 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::EmailToSmsApi.new
+
+stripped_string = ClickSendClient::StrippedString.new # StrippedString | StrippedString model
+
+rule_id = 56 # Integer | Your rule id
+
+
+begin
+  #Update email to sms stripped string rule
+  result = api_instance.sms_email_sms_stripped_string_put(stripped_string, rule_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling EmailToSmsApi->sms_email_sms_stripped_string_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **stripped_string** | [**StrippedString**](StrippedString.md)| StrippedString model | 
+ **rule_id** | **Integer**| Your rule id | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **sms_email_sms_stripped_strings_get**
+> String sms_email_sms_stripped_strings_get(opts)
+
+Get list of email to sms stripped string rules
+
+Get list of email to sms stripped string rules
+
+### 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::EmailToSmsApi.new
+
+opts = { 
+  page: 1, # Integer | Page number
+  limit: 10 # Integer | Number of records per page
+}
+
+begin
+  #Get list of email to sms stripped string rules
+  result = api_instance.sms_email_sms_stripped_strings_get(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling EmailToSmsApi->sms_email_sms_stripped_strings_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/FAXApi.md

@@ -0,0 +1,401 @@
+# ClickSendClient::FAXApi
+
+All URIs are relative to *https://rest.clicksend.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**fax_history_get**](FAXApi.md#fax_history_get) | **GET** /fax/history | Get a list of Fax History.
+[**fax_price_post**](FAXApi.md#fax_price_post) | **POST** /fax/price | Calculate Total Price for Fax Messages sent
+[**fax_receipts_by_message_id_get**](FAXApi.md#fax_receipts_by_message_id_get) | **GET** /fax/receipts/{message_id} | Get a single fax receipt based on message id.
+[**fax_receipts_get**](FAXApi.md#fax_receipts_get) | **GET** /fax/receipts | Get all delivery receipts
+[**fax_receipts_post**](FAXApi.md#fax_receipts_post) | **POST** /fax/receipts | Add a delivery receipt
+[**fax_receipts_read_put**](FAXApi.md#fax_receipts_read_put) | **PUT** /fax/receipts-read | Mark delivery receipts as read
+[**fax_send_post**](FAXApi.md#fax_send_post) | **POST** /fax/send | Send a fax using supplied supported file-types.
+
+
+# **fax_history_get**
+> String fax_history_get(opts)
+
+Get a list of Fax History.
+
+Get a list of Fax 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::FAXApi.new
+
+opts = { 
+  date_from: 56, # Integer | Customize result by setting from date (timestsamp) Example: 1457572619.
+  date_to: 56, # Integer | Customize result by setting to date (timestamp) Example: 1457573000.
+  q: 'q_example', # String | Custom query Example: status:Sent,status_code:201.
+  order: 'order_example', # String | Order result by Example: date_added:desc,list_id:desc.
+  page: 1, # Integer | Page number
+  limit: 10 # Integer | Number of records per page
+}
+
+begin
+  #Get a list of Fax History.
+  result = api_instance.fax_history_get(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling FAXApi->fax_history_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **date_from** | **Integer**| Customize result by setting from date (timestsamp) Example: 1457572619. | [optional] 
+ **date_to** | **Integer**| Customize result by setting to date (timestamp) Example: 1457573000. | [optional] 
+ **q** | **String**| Custom query Example: status:Sent,status_code:201. | [optional] 
+ **order** | **String**| Order result by Example: date_added:desc,list_id:desc. | [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
+
+
+
+# **fax_price_post**
+> String fax_price_post(fax_message)
+
+Calculate Total Price for Fax Messages sent
+
+Calculate Total Price for Fax Messages sent
+
+### 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::FAXApi.new
+
+fax_message = ClickSendClient::FaxMessageCollection.new # FaxMessageCollection | FaxMessageCollection model
+
+
+begin
+  #Calculate Total Price for Fax Messages sent
+  result = api_instance.fax_price_post(fax_message)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling FAXApi->fax_price_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **fax_message** | [**FaxMessageCollection**](FaxMessageCollection.md)| FaxMessageCollection model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **fax_receipts_by_message_id_get**
+> String fax_receipts_by_message_id_get(message_id)
+
+Get a single fax receipt based on message id.
+
+Get a single fax receipt based on message id.
+
+### 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::FAXApi.new
+
+message_id = 'message_id_example' # String | ID of the message receipt to retrieve
+
+
+begin
+  #Get a single fax receipt based on message id.
+  result = api_instance.fax_receipts_by_message_id_get(message_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling FAXApi->fax_receipts_by_message_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **message_id** | **String**| ID of the message receipt to retrieve | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **fax_receipts_get**
+> String fax_receipts_get(opts)
+
+Get all delivery receipts
+
+Get all delivery receipts
+
+### 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::FAXApi.new
+
+opts = { 
+  page: 1, # Integer | Page number
+  limit: 10 # Integer | Number of records per page
+}
+
+begin
+  #Get all delivery receipts
+  result = api_instance.fax_receipts_get(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling FAXApi->fax_receipts_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
+
+
+
+# **fax_receipts_post**
+> String fax_receipts_post(url)
+
+Add a delivery receipt
+
+Add a delivery receipt
+
+### 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::FAXApi.new
+
+url = ClickSendClient::Url.new # Url | Url model
+
+
+begin
+  #Add a delivery receipt
+  result = api_instance.fax_receipts_post(url)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling FAXApi->fax_receipts_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **url** | [**Url**](Url.md)| Url model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **fax_receipts_read_put**
+> String fax_receipts_read_put(opts)
+
+Mark delivery receipts as read
+
+Mark delivery receipts as read
+
+### 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::FAXApi.new
+
+opts = { 
+  date_before: ClickSendClient::DateBefore.new # DateBefore | DateBefore model
+}
+
+begin
+  #Mark delivery receipts as read
+  result = api_instance.fax_receipts_read_put(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling FAXApi->fax_receipts_read_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **date_before** | [**DateBefore**](DateBefore.md)| DateBefore model | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **fax_send_post**
+> String fax_send_post(fax_message)
+
+Send a fax using supplied supported file-types.
+
+Send a fax using supplied supported file-types.
+
+### 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::FAXApi.new
+
+fax_message = ClickSendClient::FaxMessageCollection.new # FaxMessageCollection | FaxMessageCollection model
+
+
+begin
+  #Send a fax using supplied supported file-types.
+  result = api_instance.fax_send_post(fax_message)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling FAXApi->fax_send_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **fax_message** | [**FaxMessageCollection**](FaxMessageCollection.md)| FaxMessageCollection model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+