clicksend_client 1.0.2

data/docs/MasterEmailTemplatesApi.md

@@ -0,0 +1,290 @@
+# ClickSendClient::MasterEmailTemplatesApi
+
+All URIs are relative to *https://rest.clicksend.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**master_email_template_categories_get**](MasterEmailTemplatesApi.md#master_email_template_categories_get) | **GET** /email/master-templates-categories | Get all master email template categories
+[**master_email_template_category_get**](MasterEmailTemplatesApi.md#master_email_template_category_get) | **GET** /email/master-templates-categories/{category_id} | Get specific master email template category
+[**master_email_template_get**](MasterEmailTemplatesApi.md#master_email_template_get) | **GET** /email/master-templates/{template_id} | Get specific master email template
+[**master_email_templates_get**](MasterEmailTemplatesApi.md#master_email_templates_get) | **GET** /email/master-templates | Get all master email templates
+[**master_email_templates_in_category_get**](MasterEmailTemplatesApi.md#master_email_templates_in_category_get) | **GET** /email/master-templates-categories/{category_id}/master-templates | Get all master email templates in a category
+
+
+# **master_email_template_categories_get**
+> String master_email_template_categories_get(opts)
+
+Get all master email template categories
+
+Get all master email template categories
+
+### 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::MasterEmailTemplatesApi.new
+
+opts = { 
+  page: 1, # Integer | Page number
+  limit: 10 # Integer | Number of records per page
+}
+
+begin
+  #Get all master email template categories
+  result = api_instance.master_email_template_categories_get(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling MasterEmailTemplatesApi->master_email_template_categories_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
+
+
+
+# **master_email_template_category_get**
+> String master_email_template_category_get(category_id)
+
+Get specific master email template category
+
+Get specific master email template category
+
+### 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::MasterEmailTemplatesApi.new
+
+category_id = 56 # Integer | Email category id
+
+
+begin
+  #Get specific master email template category
+  result = api_instance.master_email_template_category_get(category_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling MasterEmailTemplatesApi->master_email_template_category_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **category_id** | **Integer**| Email category id | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **master_email_template_get**
+> String master_email_template_get(template_id)
+
+Get specific master email template
+
+Get specific master 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::MasterEmailTemplatesApi.new
+
+template_id = 56 # Integer | Email template id
+
+
+begin
+  #Get specific master email template
+  result = api_instance.master_email_template_get(template_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling MasterEmailTemplatesApi->master_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
+
+
+
+# **master_email_templates_get**
+> String master_email_templates_get(opts)
+
+Get all master email templates
+
+Get all master 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::MasterEmailTemplatesApi.new
+
+opts = { 
+  page: 1, # Integer | Page number
+  limit: 10 # Integer | Number of records per page
+}
+
+begin
+  #Get all master email templates
+  result = api_instance.master_email_templates_get(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling MasterEmailTemplatesApi->master_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
+
+
+
+# **master_email_templates_in_category_get**
+> String master_email_templates_in_category_get(category_id, opts)
+
+Get all master email templates in a category
+
+Get all master email templates in a category
+
+### 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::MasterEmailTemplatesApi.new
+
+category_id = 56 # Integer | Email category id
+
+opts = { 
+  page: 1, # Integer | Page number
+  limit: 10 # Integer | Number of records per page
+}
+
+begin
+  #Get all master email templates in a category
+  result = api_instance.master_email_templates_in_category_get(category_id, opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling MasterEmailTemplatesApi->master_email_templates_in_category_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **category_id** | **Integer**| Email category id | 
+ **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/MmsCampaign.md

@@ -0,0 +1,14 @@
+# ClickSendClient::MmsCampaign
+
+## 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]
+**subject** | **String** | Subject of MMS campaign. | 
+**media_file** | **String** | URL pointing to media file. | 
+
+

data/docs/MmsCampaignApi.md

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