clicksend_client 1.0.2

data/docs/SmsMessage.md

@@ -0,0 +1,16 @@
+# ClickSendClient::SmsMessage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**from** | **String** | Your sender id - more info: http://help.clicksend.com/SMS/what-is-a-sender-id-or-sender-number. | [optional] 
+**body** | **String** | Your message. | 
+**to** | **String** | Recipient phone number in E.164 format. | 
+**source** | **String** | Your method of sending e.g. 'wordpress', 'php', 'c#'. | [optional] [default to 'sdk']
+**schedule** | **Integer** | Leave blank for immediate delivery. Your schedule time in unix format http://help.clicksend.com/what-is-a-unix-timestamp | [optional] [default to 0]
+**custom_string** | **String** | Your reference. Will be passed back with all replies and delivery reports. | [optional] 
+**list_id** | **Integer** | Your list ID if sending to a whole list. Can be used instead of 'to'. | [optional] 
+**country** | **String** | Recipient country. | [optional] 
+**from_email** | **String** | An email address where the reply should be emailed to. If omitted, the reply will be emailed back to the user who sent the outgoing SMS. | [optional] 
+
+

data/docs/SmsMessageCollection.md

@@ -0,0 +1,8 @@
+# ClickSendClient::SmsMessageCollection
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**messages** | [**Array<SmsMessage>**](SmsMessage.md) | Array of SmsMessage items | 
+
+

data/docs/SmsTemplate.md

@@ -0,0 +1,9 @@
+# ClickSendClient::SmsTemplate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**template_name** | **String** | Name of template | 
+**body** | **String** | Body of template | 
+
+

data/docs/StatisticsApi.md

@@ -0,0 +1,104 @@
+# ClickSendClient::StatisticsApi
+
+All URIs are relative to *https://rest.clicksend.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**statistics_sms_get**](StatisticsApi.md#statistics_sms_get) | **GET** /statistics/sms | Get sms statistics
+[**statistics_voice_get**](StatisticsApi.md#statistics_voice_get) | **GET** /statistics/voice | Get voice statistics
+
+
+# **statistics_sms_get**
+> String statistics_sms_get
+
+Get sms statistics
+
+Get sms statistics
+
+### 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::StatisticsApi.new
+
+begin
+  #Get sms statistics
+  result = api_instance.statistics_sms_get
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling StatisticsApi->statistics_sms_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
+
+
+
+# **statistics_voice_get**
+> String statistics_voice_get
+
+Get voice statistics
+
+Get voice statistics
+
+### 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::StatisticsApi.new
+
+begin
+  #Get voice statistics
+  result = api_instance.statistics_voice_get
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling StatisticsApi->statistics_voice_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
+
+
+

data/docs/StrippedString.md

@@ -0,0 +1,8 @@
+# ClickSendClient::StrippedString
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**strip_string** | **String** | String to be. | 
+
+

data/docs/Subaccount.md

@@ -0,0 +1,18 @@
+# ClickSendClient::Subaccount
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**api_username** | **String** | Your new api username. | 
+**password** | **String** | Your new password | 
+**email** | **String** | Your new email. | 
+**phone_number** | **String** | Your phone number in E.164 format. | 
+**first_name** | **String** | Your firstname | 
+**last_name** | **String** | Your lastname | 
+**access_users** | **Integer** | Your access users flag value, must be 1 or 0. | [optional] [default to 1]
+**access_billing** | **Integer** | Your access billing flag value, must be 1 or 0. | [optional] [default to 1]
+**access_reporting** | **Integer** | Your access reporting flag value, must be 1 or 0. | [optional] [default to 1]
+**access_contacts** | **Integer** | Your access contacts flag value, must be 1 or 0. | [optional] [default to 0]
+**access_settings** | **Integer** | Your access settings flag value, must be 1 or 0. | [optional] [default to 1]
+
+

data/docs/SubaccountApi.md

@@ -0,0 +1,338 @@
+# ClickSendClient::SubaccountApi
+
+All URIs are relative to *https://rest.clicksend.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**subaccounts_by_subaccount_id_delete**](SubaccountApi.md#subaccounts_by_subaccount_id_delete) | **DELETE** /subaccounts/{subaccount_id} | Delete a subaccount
+[**subaccounts_by_subaccount_id_get**](SubaccountApi.md#subaccounts_by_subaccount_id_get) | **GET** /subaccounts/{subaccount_id} | Get specific subaccount
+[**subaccounts_by_subaccount_id_put**](SubaccountApi.md#subaccounts_by_subaccount_id_put) | **PUT** /subaccounts/{subaccount_id} | Update subaccount
+[**subaccounts_get**](SubaccountApi.md#subaccounts_get) | **GET** /subaccounts | Get all subaccounts
+[**subaccounts_post**](SubaccountApi.md#subaccounts_post) | **POST** /subaccounts | Create new subaccount
+[**subaccounts_regen_api_key_by_subaccount_id_put**](SubaccountApi.md#subaccounts_regen_api_key_by_subaccount_id_put) | **PUT** /subaccounts/{subaccount_id}/regen-api-key | Regenerate an API Key
+
+
+# **subaccounts_by_subaccount_id_delete**
+> String subaccounts_by_subaccount_id_delete(subaccount_id)
+
+Delete a subaccount
+
+Delete a subaccount
+
+### 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::SubaccountApi.new
+
+subaccount_id = 56 # Integer | ID of subaccount to delete
+
+
+begin
+  #Delete a subaccount
+  result = api_instance.subaccounts_by_subaccount_id_delete(subaccount_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling SubaccountApi->subaccounts_by_subaccount_id_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **subaccount_id** | **Integer**| ID of subaccount to delete | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **subaccounts_by_subaccount_id_get**
+> String subaccounts_by_subaccount_id_get(subaccount_id)
+
+Get specific subaccount
+
+Get specific subaccount
+
+### 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::SubaccountApi.new
+
+subaccount_id = 56 # Integer | ID of subaccount to get
+
+
+begin
+  #Get specific subaccount
+  result = api_instance.subaccounts_by_subaccount_id_get(subaccount_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling SubaccountApi->subaccounts_by_subaccount_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **subaccount_id** | **Integer**| ID of subaccount to get | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **subaccounts_by_subaccount_id_put**
+> String subaccounts_by_subaccount_id_put(subaccount_id, subaccount)
+
+Update subaccount
+
+Update subaccount
+
+### 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::SubaccountApi.new
+
+subaccount_id = 56 # Integer | ID of subaccount to update
+
+subaccount = ClickSendClient::Subaccount.new # Subaccount | Subaccount model
+
+
+begin
+  #Update subaccount
+  result = api_instance.subaccounts_by_subaccount_id_put(subaccount_id, subaccount)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling SubaccountApi->subaccounts_by_subaccount_id_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **subaccount_id** | **Integer**| ID of subaccount to update | 
+ **subaccount** | [**Subaccount**](Subaccount.md)| Subaccount model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **subaccounts_get**
+> String subaccounts_get(opts)
+
+Get all subaccounts
+
+Get all subaccounts
+
+### 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::SubaccountApi.new
+
+opts = { 
+  page: 1, # Integer | Page number
+  limit: 10 # Integer | Number of records per page
+}
+
+begin
+  #Get all subaccounts
+  result = api_instance.subaccounts_get(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling SubaccountApi->subaccounts_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
+
+
+
+# **subaccounts_post**
+> String subaccounts_post(subaccount)
+
+Create new subaccount
+
+Create new subaccount
+
+### 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::SubaccountApi.new
+
+subaccount = ClickSendClient::Subaccount.new # Subaccount | Subaccount model
+
+
+begin
+  #Create new subaccount
+  result = api_instance.subaccounts_post(subaccount)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling SubaccountApi->subaccounts_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **subaccount** | [**Subaccount**](Subaccount.md)| Subaccount model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **subaccounts_regen_api_key_by_subaccount_id_put**
+> String subaccounts_regen_api_key_by_subaccount_id_put(subaccount_id)
+
+Regenerate an API Key
+
+Regenerate an API Key
+
+### 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::SubaccountApi.new
+
+subaccount_id = 56 # Integer | ID of subaccount to regenerate API key for
+
+
+begin
+  #Regenerate an API Key
+  result = api_instance.subaccounts_regen_api_key_by_subaccount_id_put(subaccount_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling SubaccountApi->subaccounts_regen_api_key_by_subaccount_id_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **subaccount_id** | **Integer**| ID of subaccount to regenerate API key for | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+