clicksend_client 1.0.2

data/docs/SMSDeliveryReceiptRulesApi.md

@@ -0,0 +1,286 @@
+# ClickSendClient::SMSDeliveryReceiptRulesApi
+
+All URIs are relative to *https://rest.clicksend.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**sms_delivery_receipt_automation_delete**](SMSDeliveryReceiptRulesApi.md#sms_delivery_receipt_automation_delete) | **DELETE** /automations/sms/receipts/{receipt_rule_id} | Delete sms delivery receipt automation
+[**sms_delivery_receipt_automation_get**](SMSDeliveryReceiptRulesApi.md#sms_delivery_receipt_automation_get) | **GET** /automations/sms/receipts/{receipt_rule_id} | Get specific sms delivery receipt automation
+[**sms_delivery_receipt_automation_post**](SMSDeliveryReceiptRulesApi.md#sms_delivery_receipt_automation_post) | **POST** /automations/sms/receipts | Create sms delivery receipt automations
+[**sms_delivery_receipt_automation_put**](SMSDeliveryReceiptRulesApi.md#sms_delivery_receipt_automation_put) | **PUT** /automations/sms/receipts/{receipt_rule_id} | Update sms delivery receipt automation
+[**sms_delivery_receipt_automations_get**](SMSDeliveryReceiptRulesApi.md#sms_delivery_receipt_automations_get) | **GET** /automations/sms/receipts | Get all sms delivery receipt automations
+
+
+# **sms_delivery_receipt_automation_delete**
+> String sms_delivery_receipt_automation_delete(receipt_rule_id)
+
+Delete sms delivery receipt automation
+
+Delete sms delivery receipt 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::SMSDeliveryReceiptRulesApi.new
+
+receipt_rule_id = 56 # Integer | Receipt rule id
+
+
+begin
+  #Delete sms delivery receipt automation
+  result = api_instance.sms_delivery_receipt_automation_delete(receipt_rule_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling SMSDeliveryReceiptRulesApi->sms_delivery_receipt_automation_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **receipt_rule_id** | **Integer**| Receipt rule id | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **sms_delivery_receipt_automation_get**
+> String sms_delivery_receipt_automation_get(receipt_rule_id)
+
+Get specific sms delivery receipt automation
+
+Get specific sms delivery receipt 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::SMSDeliveryReceiptRulesApi.new
+
+receipt_rule_id = 56 # Integer | Receipt rule id
+
+
+begin
+  #Get specific sms delivery receipt automation
+  result = api_instance.sms_delivery_receipt_automation_get(receipt_rule_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling SMSDeliveryReceiptRulesApi->sms_delivery_receipt_automation_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **receipt_rule_id** | **Integer**| Receipt rule id | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **sms_delivery_receipt_automation_post**
+> String sms_delivery_receipt_automation_post(delivery_receipt_rule)
+
+Create sms delivery receipt automations
+
+Create sms delivery receipt 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::SMSDeliveryReceiptRulesApi.new
+
+delivery_receipt_rule = ClickSendClient::DeliveryReceiptRule.new # DeliveryReceiptRule | sms delivery receipt rule model
+
+
+begin
+  #Create sms delivery receipt automations
+  result = api_instance.sms_delivery_receipt_automation_post(delivery_receipt_rule)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling SMSDeliveryReceiptRulesApi->sms_delivery_receipt_automation_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **delivery_receipt_rule** | [**DeliveryReceiptRule**](DeliveryReceiptRule.md)| sms delivery receipt rule model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **sms_delivery_receipt_automation_put**
+> String sms_delivery_receipt_automation_put(receipt_rule_id, delivery_receipt_rule)
+
+Update sms delivery receipt automation
+
+Update sms delivery receipt 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::SMSDeliveryReceiptRulesApi.new
+
+receipt_rule_id = 56 # Integer | Receipt rule id
+
+delivery_receipt_rule = ClickSendClient::DeliveryReceiptRule.new # DeliveryReceiptRule | Delivery receipt rule model
+
+
+begin
+  #Update sms delivery receipt automation
+  result = api_instance.sms_delivery_receipt_automation_put(receipt_rule_id, delivery_receipt_rule)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling SMSDeliveryReceiptRulesApi->sms_delivery_receipt_automation_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **receipt_rule_id** | **Integer**| Receipt rule id | 
+ **delivery_receipt_rule** | [**DeliveryReceiptRule**](DeliveryReceiptRule.md)| Delivery receipt rule model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **sms_delivery_receipt_automations_get**
+> String sms_delivery_receipt_automations_get(opts)
+
+Get all sms delivery receipt automations
+
+Get all sms delivery receipt 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::SMSDeliveryReceiptRulesApi.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 sms delivery receipt automations
+  result = api_instance.sms_delivery_receipt_automations_get(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling SMSDeliveryReceiptRulesApi->sms_delivery_receipt_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/SearchApi.md

@@ -0,0 +1,68 @@
+# ClickSendClient::SearchApi
+
+All URIs are relative to *https://rest.clicksend.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**search_contacts_lists_get**](SearchApi.md#search_contacts_lists_get) | **GET** /search/contacts-lists | Get list of searched contact list
+
+
+# **search_contacts_lists_get**
+> String search_contacts_lists_get(q, opts)
+
+Get list of searched contact list
+
+Get list of searched contact list
+
+### 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::SearchApi.new
+
+q = 'q_example' # String | Your keyword or query.
+
+opts = { 
+  page: 1, # Integer | Page number
+  limit: 10 # Integer | Number of records per page
+}
+
+begin
+  #Get list of searched contact list
+  result = api_instance.search_contacts_lists_get(q, opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling SearchApi->search_contacts_lists_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **q** | **String**| Your keyword or query. | 
+ **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/SmsCampaign.md

@@ -0,0 +1,12 @@
+# ClickSendClient::SmsCampaign
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**list_id** | **Integer** | Your list id. | 
+**name** | **String** | Your campaign name. | 
+**body** | **String** | Your campaign message. | 
+**from** | **String** | Your sender id - more info: http://help.clicksend.com/SMS/what-is-a-sender-id-or-sender-number. | [optional] 
+**schedule** | **Integer** | Your schedule timestamp. | [optional] [default to 0]
+
+

data/docs/SmsCampaignApi.md

@@ -0,0 +1,338 @@
+# ClickSendClient::SmsCampaignApi
+
+All URIs are relative to *https://rest.clicksend.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**sms_campaign_by_sms_campaign_id_get**](SmsCampaignApi.md#sms_campaign_by_sms_campaign_id_get) | **GET** /sms-campaigns/{sms_campaign_id} | Get specific sms campaign
+[**sms_campaigns_by_sms_campaign_id_put**](SmsCampaignApi.md#sms_campaigns_by_sms_campaign_id_put) | **PUT** /sms-campaigns/{sms_campaign_id} | Update sms campaign
+[**sms_campaigns_cancel_by_sms_campaign_id_put**](SmsCampaignApi.md#sms_campaigns_cancel_by_sms_campaign_id_put) | **PUT** /sms-campaigns/{sms_campaign_id}/cancel | Cancel sms campaign
+[**sms_campaigns_get**](SmsCampaignApi.md#sms_campaigns_get) | **GET** /sms-campaigns | Get list of sms campaigns
+[**sms_campaigns_price_post**](SmsCampaignApi.md#sms_campaigns_price_post) | **POST** /sms-campaigns/price | Calculate price for sms campaign
+[**sms_campaigns_send_post**](SmsCampaignApi.md#sms_campaigns_send_post) | **POST** /sms-campaigns/send | Create sms campaign
+
+
+# **sms_campaign_by_sms_campaign_id_get**
+> String sms_campaign_by_sms_campaign_id_get(sms_campaign_id)
+
+Get specific sms campaign
+
+Get specific sms campaign
+
+### 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::SmsCampaignApi.new
+
+sms_campaign_id = 56 # Integer | ID of SMS campaign to retrieve
+
+
+begin
+  #Get specific sms campaign
+  result = api_instance.sms_campaign_by_sms_campaign_id_get(sms_campaign_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling SmsCampaignApi->sms_campaign_by_sms_campaign_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sms_campaign_id** | **Integer**| ID of SMS campaign to retrieve | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **sms_campaigns_by_sms_campaign_id_put**
+> String sms_campaigns_by_sms_campaign_id_put(sms_campaign_id, campaign)
+
+Update sms campaign
+
+Update sms campaign
+
+### 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::SmsCampaignApi.new
+
+sms_campaign_id = 56 # Integer | ID of SMS campaign to update
+
+campaign = ClickSendClient::SmsCampaign.new # SmsCampaign | SmsCampaign model
+
+
+begin
+  #Update sms campaign
+  result = api_instance.sms_campaigns_by_sms_campaign_id_put(sms_campaign_id, campaign)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling SmsCampaignApi->sms_campaigns_by_sms_campaign_id_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sms_campaign_id** | **Integer**| ID of SMS campaign to update | 
+ **campaign** | [**SmsCampaign**](SmsCampaign.md)| SmsCampaign model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **sms_campaigns_cancel_by_sms_campaign_id_put**
+> String sms_campaigns_cancel_by_sms_campaign_id_put(sms_campaign_id)
+
+Cancel sms campaign
+
+Cancel sms campaign
+
+### 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::SmsCampaignApi.new
+
+sms_campaign_id = 56 # Integer | ID of SMS Campaign to cancel
+
+
+begin
+  #Cancel sms campaign
+  result = api_instance.sms_campaigns_cancel_by_sms_campaign_id_put(sms_campaign_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling SmsCampaignApi->sms_campaigns_cancel_by_sms_campaign_id_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sms_campaign_id** | **Integer**| ID of SMS Campaign to cancel | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **sms_campaigns_get**
+> String sms_campaigns_get(opts)
+
+Get list of sms campaigns
+
+Get list of sms campaigns
+
+### 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::SmsCampaignApi.new
+
+opts = { 
+  page: 1, # Integer | Page number
+  limit: 10 # Integer | Number of records per page
+}
+
+begin
+  #Get list of sms campaigns
+  result = api_instance.sms_campaigns_get(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling SmsCampaignApi->sms_campaigns_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_campaigns_price_post**
+> String sms_campaigns_price_post(campaign)
+
+Calculate price for sms campaign
+
+Calculate price for sms campaign
+
+### 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::SmsCampaignApi.new
+
+campaign = ClickSendClient::SmsCampaign.new # SmsCampaign | SmsCampaign model
+
+
+begin
+  #Calculate price for sms campaign
+  result = api_instance.sms_campaigns_price_post(campaign)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling SmsCampaignApi->sms_campaigns_price_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **campaign** | [**SmsCampaign**](SmsCampaign.md)| SmsCampaign model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **sms_campaigns_send_post**
+> String sms_campaigns_send_post(campaign)
+
+Create sms campaign
+
+Create sms campaign
+
+### 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::SmsCampaignApi.new
+
+campaign = ClickSendClient::SmsCampaign.new # SmsCampaign | SmsCampaign model
+
+
+begin
+  #Create sms campaign
+  result = api_instance.sms_campaigns_send_post(campaign)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling SmsCampaignApi->sms_campaigns_send_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **campaign** | [**SmsCampaign**](SmsCampaign.md)| SmsCampaign model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+