clicksend_client 1.0.2

data/docs/UserEmailTemplatesApi.md

@@ -0,0 +1,284 @@
+# ClickSendClient::UserEmailTemplatesApi
+
+All URIs are relative to *https://rest.clicksend.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**email_template_delete**](UserEmailTemplatesApi.md#email_template_delete) | **DELETE** /email/templates/{template_id} | Delete user email template
+[**email_template_get**](UserEmailTemplatesApi.md#email_template_get) | **GET** /email/templates/{template_id} | Get specific user email template
+[**email_template_post**](UserEmailTemplatesApi.md#email_template_post) | **POST** /email/templates | Create email template
+[**email_template_put**](UserEmailTemplatesApi.md#email_template_put) | **PUT** /email/templates/{template_id} | Update email template
+[**email_templates_get**](UserEmailTemplatesApi.md#email_templates_get) | **GET** /email/templates | Get all user email templates
+
+
+# **email_template_delete**
+> String email_template_delete(template_id)
+
+Delete user email template
+
+Delete user email template
+
+### 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::UserEmailTemplatesApi.new
+
+template_id = 56 # Integer | Email template id
+
+
+begin
+  #Delete user email template
+  result = api_instance.email_template_delete(template_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling UserEmailTemplatesApi->email_template_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **template_id** | **Integer**| Email template id | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **email_template_get**
+> String email_template_get(template_id)
+
+Get specific user email template
+
+Get specific user email templates
+
+### 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::UserEmailTemplatesApi.new
+
+template_id = 56 # Integer | Email template id
+
+
+begin
+  #Get specific user email template
+  result = api_instance.email_template_get(template_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling UserEmailTemplatesApi->email_template_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **template_id** | **Integer**| Email template id | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **email_template_post**
+> String email_template_post(email_template)
+
+Create email template
+
+Create email template
+
+### 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::UserEmailTemplatesApi.new
+
+email_template = ClickSendClient::EmailTemplateNew.new # EmailTemplateNew | Email template model
+
+
+begin
+  #Create email template
+  result = api_instance.email_template_post(email_template)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling UserEmailTemplatesApi->email_template_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email_template** | [**EmailTemplateNew**](EmailTemplateNew.md)| Email template model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **email_template_put**
+> String email_template_put(template_id, email_template)
+
+Update email template
+
+Update email template
+
+### 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::UserEmailTemplatesApi.new
+
+template_id = 56 # Integer | Email template id
+
+email_template = ClickSendClient::EmailTemplateUpdate.new # EmailTemplateUpdate | Email template model
+
+
+begin
+  #Update email template
+  result = api_instance.email_template_put(template_id, email_template)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling UserEmailTemplatesApi->email_template_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **template_id** | **Integer**| Email template id | 
+ **email_template** | [**EmailTemplateUpdate**](EmailTemplateUpdate.md)| Email template model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **email_templates_get**
+> String email_templates_get(opts)
+
+Get all user email templates
+
+Get all user email templates
+
+### 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::UserEmailTemplatesApi.new
+
+opts = { 
+  page: 1, # Integer | Page number
+  limit: 10 # Integer | Number of records per page
+}
+
+begin
+  #Get all user email templates
+  result = api_instance.email_templates_get(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling UserEmailTemplatesApi->email_templates_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/VoiceApi.md

@@ -0,0 +1,547 @@
+# ClickSendClient::VoiceApi
+
+All URIs are relative to *https://rest.clicksend.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**voice_cancel_all_put**](VoiceApi.md#voice_cancel_all_put) | **PUT** /voice/cancel-all | Update all voice messages as cancelled
+[**voice_cancel_by_message_id_put**](VoiceApi.md#voice_cancel_by_message_id_put) | **PUT** /voice/{message_id}/cancel | Update voice message status as cancelled
+[**voice_history_export_get**](VoiceApi.md#voice_history_export_get) | **GET** /voice/history/export | Export voice history
+[**voice_history_get**](VoiceApi.md#voice_history_get) | **GET** /voice/history | Get all voice history
+[**voice_lang_get**](VoiceApi.md#voice_lang_get) | **GET** /voice/lang | Get all voice languages
+[**voice_price_post**](VoiceApi.md#voice_price_post) | **POST** /voice/price | Calculate voice price
+[**voice_receipts_get**](VoiceApi.md#voice_receipts_get) | **GET** /voice/receipts | Get all delivery receipts
+[**voice_receipts_post**](VoiceApi.md#voice_receipts_post) | **POST** /voice/receipts | Add a delivery receipt
+[**voice_receipts_read_put**](VoiceApi.md#voice_receipts_read_put) | **PUT** /voice/receipts-read | Mark delivery receipts as read
+[**voice_send_post**](VoiceApi.md#voice_send_post) | **POST** /voice/send | Send voice message(s)
+
+
+# **voice_cancel_all_put**
+> String voice_cancel_all_put
+
+Update all voice messages as cancelled
+
+Update all voice messages as cancelled
+
+### 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::VoiceApi.new
+
+begin
+  #Update all voice messages as cancelled
+  result = api_instance.voice_cancel_all_put
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling VoiceApi->voice_cancel_all_put: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **voice_cancel_by_message_id_put**
+> String voice_cancel_by_message_id_put(message_id)
+
+Update voice message status as cancelled
+
+Update voice message status as cancelled
+
+### 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::VoiceApi.new
+
+message_id = 'message_id_example' # String | Your voice message id
+
+
+begin
+  #Update voice message status as cancelled
+  result = api_instance.voice_cancel_by_message_id_put(message_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling VoiceApi->voice_cancel_by_message_id_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **message_id** | **String**| Your voice message id | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **voice_history_export_get**
+> String voice_history_export_get(filename)
+
+Export voice history
+
+Export voice 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::VoiceApi.new
+
+filename = 'filename_example' # String | Filename to export to
+
+
+begin
+  #Export voice history
+  result = api_instance.voice_history_export_get(filename)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling VoiceApi->voice_history_export_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **filename** | **String**| Filename to export to | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **voice_history_get**
+> String voice_history_get(opts)
+
+Get all voice history
+
+Get all voice 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::VoiceApi.new
+
+opts = { 
+  date_from: 56, # Integer | Timestamp (from) used to show records by date.
+  date_to: 56, # Integer | Timestamp (to) used to show records by date
+  page: 1, # Integer | Page number
+  limit: 10 # Integer | Number of records per page
+}
+
+begin
+  #Get all voice history
+  result = api_instance.voice_history_get(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling VoiceApi->voice_history_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **date_from** | **Integer**| Timestamp (from) used to show records by date. | [optional] 
+ **date_to** | **Integer**| Timestamp (to) used to show records by 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
+
+
+
+# **voice_lang_get**
+> String voice_lang_get
+
+Get all voice languages
+
+Get all voice languages
+
+### 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::VoiceApi.new
+
+begin
+  #Get all voice languages
+  result = api_instance.voice_lang_get
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling VoiceApi->voice_lang_get: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **voice_price_post**
+> String voice_price_post(voice_messages)
+
+Calculate voice price
+
+Calculate voice 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::VoiceApi.new
+
+voice_messages = ClickSendClient::VoiceMessageCollection.new # VoiceMessageCollection | VoiceMessageCollection model
+
+
+begin
+  #Calculate voice price
+  result = api_instance.voice_price_post(voice_messages)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling VoiceApi->voice_price_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **voice_messages** | [**VoiceMessageCollection**](VoiceMessageCollection.md)| VoiceMessageCollection model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **voice_receipts_get**
+> String voice_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::VoiceApi.new
+
+opts = { 
+  page: 1, # Integer | Page number
+  limit: 10 # Integer | Number of records per page
+}
+
+begin
+  #Get all delivery receipts
+  result = api_instance.voice_receipts_get(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling VoiceApi->voice_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
+
+
+
+# **voice_receipts_post**
+> String voice_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::VoiceApi.new
+
+url = ClickSendClient::Url.new # Url | Url model
+
+
+begin
+  #Add a delivery receipt
+  result = api_instance.voice_receipts_post(url)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling VoiceApi->voice_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
+
+
+
+# **voice_receipts_read_put**
+> String voice_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::VoiceApi.new
+
+opts = { 
+  date_before: ClickSendClient::DateBefore.new # DateBefore | DateBefore model
+}
+
+begin
+  #Mark delivery receipts as read
+  result = api_instance.voice_receipts_read_put(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling VoiceApi->voice_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
+
+
+
+# **voice_send_post**
+> String voice_send_post(voice_messages)
+
+Send voice message(s)
+
+Send a voice call
+
+### 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::VoiceApi.new
+
+voice_messages = ClickSendClient::VoiceMessageCollection.new # VoiceMessageCollection | VoiceMessageCollection model
+
+
+begin
+  #Send voice message(s)
+  result = api_instance.voice_send_post(voice_messages)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling VoiceApi->voice_send_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **voice_messages** | [**VoiceMessageCollection**](VoiceMessageCollection.md)| VoiceMessageCollection model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+