clicksend_client 1.0.2

data/docs/MmsMessage.md

@@ -0,0 +1,17 @@
+# ClickSendClient::MmsMessage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**to** | **String** | Recipient phone number in E.164 format | 
+**body** | **String** | Your message | 
+**subject** | **String** | Subject line (max 20 characters) | 
+**from** | **String** | Your sender ID | [optional] 
+**country** | **String** | Recipient country | [optional] 
+**source** | **String** | Your method of sending | [optional] [default to 'sdk']
+**list_id** | **Integer** | Your list ID if sending to a whole list (can be used instead of 'to') | [optional] 
+**schedule** | **Integer** | Schedule time in unix format (leave blank for immediate delivery) | [optional] [default to 0]
+**custom_string** | **String** | Custom string for your reference | [optional] 
+**from_email** | **String** | Email to send replies to | [optional] 
+
+

data/docs/MmsMessageCollection.md

@@ -0,0 +1,9 @@
+# ClickSendClient::MmsMessageCollection
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**media_file** | **String** | Media file you want to send | 
+**messages** | [**Array<MmsMessage>**](MmsMessage.md) | Array of MmsMessage models | 
+
+

data/docs/NumberApi.md

@@ -0,0 +1,183 @@
+# ClickSendClient::NumberApi
+
+All URIs are relative to *https://rest.clicksend.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**numbers_buy_by_dedicated_number_post**](NumberApi.md#numbers_buy_by_dedicated_number_post) | **POST** /numbers/buy/{dedicated_number} | Buy dedicated number
+[**numbers_get**](NumberApi.md#numbers_get) | **GET** /numbers | Get all availible dedicated numbers
+[**numbers_search_by_country_get**](NumberApi.md#numbers_search_by_country_get) | **GET** /numbers/search/{country} | Get all dedicated numbers by country
+
+
+# **numbers_buy_by_dedicated_number_post**
+> String numbers_buy_by_dedicated_number_post(dedicated_number)
+
+Buy dedicated number
+
+Buy dedicated number
+
+### 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::NumberApi.new
+
+dedicated_number = 'dedicated_number_example' # String | Phone number to purchase
+
+
+begin
+  #Buy dedicated number
+  result = api_instance.numbers_buy_by_dedicated_number_post(dedicated_number)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling NumberApi->numbers_buy_by_dedicated_number_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **dedicated_number** | **String**| Phone number to purchase | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **numbers_get**
+> String numbers_get(opts)
+
+Get all availible dedicated numbers
+
+Get all availible dedicated numbers
+
+### 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::NumberApi.new
+
+opts = { 
+  page: 1, # Integer | Page number
+  limit: 10 # Integer | Number of records per page
+}
+
+begin
+  #Get all availible dedicated numbers
+  result = api_instance.numbers_get(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling NumberApi->numbers_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
+
+
+
+# **numbers_search_by_country_get**
+> String numbers_search_by_country_get(country, opts)
+
+Get all dedicated numbers by country
+
+Get all dedicated numbers by country
+
+### 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::NumberApi.new
+
+country = 'country_example' # String | Country code to search
+
+opts = { 
+  search: 'search_example', # String | Your search pattern or query.
+  search_type: 56, # Integer | Your strategy for searching, 0 = starts with, 1 = anywhere, 2 = ends with.
+  page: 1, # Integer | Page number
+  limit: 10 # Integer | Number of records per page
+}
+
+begin
+  #Get all dedicated numbers by country
+  result = api_instance.numbers_search_by_country_get(country, opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling NumberApi->numbers_search_by_country_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **country** | **String**| Country code to search | 
+ **search** | **String**| Your search pattern or query. | [optional] 
+ **search_type** | **Integer**| Your strategy for searching, 0 = starts with, 1 = anywhere, 2 = ends with. | [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/PostLetter.md

@@ -0,0 +1,14 @@
+# ClickSendClient::PostLetter
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**file_url** | **String** | URL of file to send | 
+**priority_post** | **Integer** | Whether letter is priority | [optional] [default to 0]
+**recipients** | [**Array<PostRecipient>**](PostRecipient.md) | Array of PostRecipient models | 
+**template_used** | **Integer** | Whether using our template | [optional] [default to 0]
+**duplex** | **Integer** | Whether letter is duplex | [optional] [default to 0]
+**colour** | **Integer** | Whether letter is in colour | [optional] [default to 0]
+**source** | **String** | Source being sent from | [optional] [default to 'sdk']
+
+

data/docs/PostLetterApi.md

@@ -0,0 +1,227 @@
+# ClickSendClient::PostLetterApi
+
+All URIs are relative to *https://rest.clicksend.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**post_letters_export_get**](PostLetterApi.md#post_letters_export_get) | **GET** /post/letters/history/export | export post letter history
+[**post_letters_history_get**](PostLetterApi.md#post_letters_history_get) | **GET** /post/letters/history | Get all post letter history
+[**post_letters_price_post**](PostLetterApi.md#post_letters_price_post) | **POST** /post/letters/price | Calculate post letter price
+[**post_letters_send_post**](PostLetterApi.md#post_letters_send_post) | **POST** /post/letters/send | Send post letter
+
+
+# **post_letters_export_get**
+> String post_letters_export_get(filename)
+
+export post letter history
+
+export post letter 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::PostLetterApi.new
+
+filename = 'filename_example' # String | Filename to export to
+
+
+begin
+  #export post letter history
+  result = api_instance.post_letters_export_get(filename)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling PostLetterApi->post_letters_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
+
+
+
+# **post_letters_history_get**
+> String post_letters_history_get(opts)
+
+Get all post letter history
+
+Get all post letter 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::PostLetterApi.new
+
+opts = { 
+  page: 1, # Integer | Page number
+  limit: 10 # Integer | Number of records per page
+}
+
+begin
+  #Get all post letter history
+  result = api_instance.post_letters_history_get(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling PostLetterApi->post_letters_history_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
+
+
+
+# **post_letters_price_post**
+> String post_letters_price_post(post_letter)
+
+Calculate post letter price
+
+Calculate post letter 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::PostLetterApi.new
+
+post_letter = ClickSendClient::PostLetter.new # PostLetter | PostLetter model
+
+
+begin
+  #Calculate post letter price
+  result = api_instance.post_letters_price_post(post_letter)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling PostLetterApi->post_letters_price_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **post_letter** | [**PostLetter**](PostLetter.md)| PostLetter model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **post_letters_send_post**
+> String post_letters_send_post(post_letter)
+
+Send post letter
+
+Send post letter
+
+### 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::PostLetterApi.new
+
+post_letter = ClickSendClient::PostLetter.new # PostLetter | PostLetter model
+
+
+begin
+  #Send post letter
+  result = api_instance.post_letters_send_post(post_letter)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling PostLetterApi->post_letters_send_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **post_letter** | [**PostLetter**](PostLetter.md)| PostLetter model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+