clicksend_client 1.0.2

data/docs/InboundFaxRule.md

@@ -0,0 +1,12 @@
+# ClickSendClient::InboundFaxRule
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dedicated_number** | **String** | Dedicated Number. Can be '*' to apply to all numbers. | 
+**rule_name** | **String** | Rule Name. | 
+**action** | **String** | Action to be taken (AUTO_REPLY, EMAIL_USER, EMAIL_FIXED, URL, SMS, POLL, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT, CREATE_CONTACT_PLUS_EMAIL, CREATE_CONTACT_PLUS_NAME_EMAIL CREATE_CONTACT_PLUS_NAME, SMPP, NONE). | 
+**action_address** | **String** | Action address. | 
+**enabled** | **Float** | Enabled: Disabled=0 or Enabled=1. | 
+
+

data/docs/InboundSMSRule.md

@@ -0,0 +1,14 @@
+# ClickSendClient::InboundSMSRule
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dedicated_number** | **String** | Dedicated Number. Can be '*' to apply to all numbers. | 
+**rule_name** | **String** | Rule Name. | 
+**message_search_type** | **Float** | Message Search Type: 0=Any message, 1=starts with, 2=contains, 3=does not contain. | 
+**message_search_term** | **String** | Message search term. | 
+**action** | **String** | Action to be taken (AUTO_REPLY, EMAIL_USER, EMAIL_FIXED, URL, SMS, POLL, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT, CREATE_CONTACT_PLUS_EMAIL, CREATE_CONTACT_PLUS_NAME_EMAIL CREATE_CONTACT_PLUS_NAME, SMPP, NONE). | 
+**action_address** | **String** | Action address. | 
+**enabled** | **Float** | Enabled: Disabled=0 or Enabled=1. | 
+
+

data/docs/InboundSMSRulesApi.md

@@ -0,0 +1,286 @@
+# ClickSendClient::InboundSMSRulesApi
+
+All URIs are relative to *https://rest.clicksend.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**sms_inbound_automation_delete**](InboundSMSRulesApi.md#sms_inbound_automation_delete) | **DELETE** /automations/sms/inbound/{inbound_rule_id} | Delete inbound sms automation
+[**sms_inbound_automation_get**](InboundSMSRulesApi.md#sms_inbound_automation_get) | **GET** /automations/sms/inbound/{inbound_rule_id} | Get specific inbound sms automation
+[**sms_inbound_automation_post**](InboundSMSRulesApi.md#sms_inbound_automation_post) | **POST** /automations/sms/inbound | Create new inbound sms automation
+[**sms_inbound_automation_put**](InboundSMSRulesApi.md#sms_inbound_automation_put) | **PUT** /automations/sms/inbound/{inbound_rule_id} | Update inbound sms automation
+[**sms_inbound_automations_get**](InboundSMSRulesApi.md#sms_inbound_automations_get) | **GET** /automations/sms/inbound | Get all inbound sms automations
+
+
+# **sms_inbound_automation_delete**
+> String sms_inbound_automation_delete(inbound_rule_id)
+
+Delete inbound sms automation
+
+Delete inbound sms automation
+
+### 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::InboundSMSRulesApi.new
+
+inbound_rule_id = 56 # Integer | Inbound rule id
+
+
+begin
+  #Delete inbound sms automation
+  result = api_instance.sms_inbound_automation_delete(inbound_rule_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling InboundSMSRulesApi->sms_inbound_automation_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **inbound_rule_id** | **Integer**| Inbound rule id | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **sms_inbound_automation_get**
+> String sms_inbound_automation_get(inbound_rule_id)
+
+Get specific inbound sms automation
+
+Get specific inbound sms automation
+
+### 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::InboundSMSRulesApi.new
+
+inbound_rule_id = 56 # Integer | Inbound rule id
+
+
+begin
+  #Get specific inbound sms automation
+  result = api_instance.sms_inbound_automation_get(inbound_rule_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling InboundSMSRulesApi->sms_inbound_automation_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **inbound_rule_id** | **Integer**| Inbound rule id | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **sms_inbound_automation_post**
+> String sms_inbound_automation_post(inbound_sms_rule)
+
+Create new inbound sms automation
+
+Create new inbound sms automation
+
+### 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::InboundSMSRulesApi.new
+
+inbound_sms_rule = ClickSendClient::InboundSMSRule.new # InboundSMSRule | Inbound sms rule model
+
+
+begin
+  #Create new inbound sms automation
+  result = api_instance.sms_inbound_automation_post(inbound_sms_rule)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling InboundSMSRulesApi->sms_inbound_automation_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **inbound_sms_rule** | [**InboundSMSRule**](InboundSMSRule.md)| Inbound sms rule model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **sms_inbound_automation_put**
+> String sms_inbound_automation_put(inbound_rule_id, inbound_sms_rule)
+
+Update inbound sms automation
+
+Update inbound sms automation
+
+### 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::InboundSMSRulesApi.new
+
+inbound_rule_id = 56 # Integer | Inbound rule id
+
+inbound_sms_rule = ClickSendClient::InboundSMSRule.new # InboundSMSRule | Inbound sms rule model
+
+
+begin
+  #Update inbound sms automation
+  result = api_instance.sms_inbound_automation_put(inbound_rule_id, inbound_sms_rule)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling InboundSMSRulesApi->sms_inbound_automation_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **inbound_rule_id** | **Integer**| Inbound rule id | 
+ **inbound_sms_rule** | [**InboundSMSRule**](InboundSMSRule.md)| Inbound sms rule model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **sms_inbound_automations_get**
+> String sms_inbound_automations_get(opts)
+
+Get all inbound sms automations
+
+Get all inbound sms automations
+
+### 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::InboundSMSRulesApi.new
+
+opts = { 
+  q: 'q_example', # String | Your keyword or query.
+  page: 1, # Integer | Page number
+  limit: 10 # Integer | Number of records per page
+}
+
+begin
+  #Get all inbound sms automations
+  result = api_instance.sms_inbound_automations_get(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling InboundSMSRulesApi->sms_inbound_automations_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **q** | **String**| Your keyword or query. | [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
+
+
+

data/docs/MMSApi.md

@@ -0,0 +1,228 @@
+# ClickSendClient::MMSApi
+
+All URIs are relative to *https://rest.clicksend.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**mms_price_post**](MMSApi.md#mms_price_post) | **POST** /mms/price | Get Price for MMS sent
+[**mms_receipts_get**](MMSApi.md#mms_receipts_get) | **GET** /mms/receipts | Get all delivery receipts
+[**mms_receipts_read_put**](MMSApi.md#mms_receipts_read_put) | **PUT** /mms/receipts-read | Mark delivery receipts as read
+[**mms_send_post**](MMSApi.md#mms_send_post) | **POST** /mms/send | Send MMS
+
+
+# **mms_price_post**
+> String mms_price_post(mms_messages)
+
+Get Price for MMS sent
+
+Get Price for MMS 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::MMSApi.new
+
+mms_messages = ClickSendClient::MmsMessageCollection.new # MmsMessageCollection | MmsMessageCollection model
+
+
+begin
+  #Get Price for MMS sent
+  result = api_instance.mms_price_post(mms_messages)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling MMSApi->mms_price_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **mms_messages** | [**MmsMessageCollection**](MmsMessageCollection.md)| MmsMessageCollection model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **mms_receipts_get**
+> String mms_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::MMSApi.new
+
+opts = { 
+  page: 1, # Integer | Page number
+  limit: 10 # Integer | Number of records per page
+}
+
+begin
+  #Get all delivery receipts
+  result = api_instance.mms_receipts_get(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling MMSApi->mms_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
+
+
+
+# **mms_receipts_read_put**
+> String mms_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::MMSApi.new
+
+opts = { 
+  date_before: ClickSendClient::DateBefore.new # DateBefore | DateBefore model
+}
+
+begin
+  #Mark delivery receipts as read
+  result = api_instance.mms_receipts_read_put(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling MMSApi->mms_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
+
+
+
+# **mms_send_post**
+> String mms_send_post(mms_messages)
+
+Send MMS
+
+Send MMS
+
+### 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::MMSApi.new
+
+mms_messages = ClickSendClient::MmsMessageCollection.new # MmsMessageCollection | MmsMessageCollection model
+
+
+begin
+  #Send MMS
+  result = api_instance.mms_send_post(mms_messages)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling MMSApi->mms_send_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **mms_messages** | [**MmsMessageCollection**](MmsMessageCollection.md)| MmsMessageCollection model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+